| blob | 82d82bc7240aad51ab9226d3251bec62b63106b9 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2011 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
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 You probably should not use this function in Lisp programs;
882 it is usually a mistake for a Lisp function to use any subroutine
883 that uses or sets the mark."
888 \f
890 ;; Counting lines, one way or another.
893 "Goto LINE, counting from line 1 at beginning of buffer.
894 Normally, move point in the current buffer, and leave mark at the
896 move point in the most recently selected other buffer, and switch to it.
898 If there's a number in the buffer at point, it is the default for LINE.
900 This function is usually the wrong thing to use in a Lisp program.
901 What you probably want instead is something like:
902 (goto-char (point-min)) (forward-line (1- N))
903 If at all possible, an even better solution is to use char counts
904 rather than line counts."
908 ;; Look for a default, a number in the buffer at point.
918 ;; Decide if we're switching buffers.
926 ;; Read the argument, offering that number (if any) as default.
929 buffer-prompt
930 default)
931 default)
932 buffer))))
933 ;; Switch to the desired buffer, one way or another.
938 ;; Leave mark at previous position
940 ;; Move to the specified line number in that buffer.
949 "Return the number of words between START and END.
950 If called interactively, print a message reporting the number of
951 lines, words, and characters in the region."
963 words
965 words))
968 "Display the number of lines, words, and characters in the buffer.
969 In Transient Mark mode when the mark is active, display the
970 number of lines, words, and characters in the region."
983 str
991 "Print the current buffer line number and narrowed line number of point."
1004 "Return number of lines between START and END.
1005 This is usually the number of newlines between them,
1006 but can be one more if START is not equal to END
1007 and the greater of them is not at the start of a line."
1023 done)))
1027 "Return (narrowed) buffer line number at position POS.
1028 If POS is nil, use current buffer location.
1029 Counting starts at (point-min), so the value refers
1030 to the contents of the accessible portion of the buffer."
1040 "Print info on cursor position (on screen and within buffer).
1041 Also describe the character after point, and give its character code
1042 in octal, decimal and hex.
1044 For a non-ASCII multibyte character, also give its encoding in the
1045 buffer's selected coding system if the coding system encodes the
1046 character safely. If the character is encoded into one byte, that
1047 code is shown in hex. If the character is encoded into more than one
1050 In addition, with prefix argument, show details about that character
1051 in *Help* buffer. See also the command `describe-char'."
1054 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1055 ;; start a directional embedding, which could completely
1056 ;; disrupt the rest of the line (e.g., RLO will display the
1057 ;; rest of the line right-to-left). So we put an invisible
1058 ;; PDF character after these characters, to end the
1059 ;; embedding, which eliminates any effects on the rest of the
1060 ;; line.
1069 ;; Avoid overflow from multiplying by 100!
1073 ""
1079 pos total percent beg end col hscroll)
1081 pos total col hscroll))
1083 encoded encoding-msg display-prop under-display)
1090 ;; Check if the character is displayed with some `display'
1091 ;; text property. In that case, set under-display to the
1092 ;; buffer substring covered by that property.
1103 under-display)))
1109 char char char under-display)
1111 char char char under-display display-prop))
1114 char char char
1116 "..."
1120 ;; We show the detailed information about CHAR.
1127 pdf encoding-msg pos total percent beg end col hscroll)
1134 pdf encoding-msg pos total percent col hscroll))))))
1135 \f
1136 ;; Initialize read-expression-map. It is defined at C level.
1139 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1140 ;; too rarely useful.
1150 "The current default value or list of default values in the minibuffer.
1151 The functions `read-from-minibuffer' and `completing-read' bind
1155 "Value for `print-level' while printing value in `eval-expression'.
1156 A value of nil means no limit."
1162 "Value for `print-length' while printing value in `eval-expression'.
1163 A value of nil means no limit."
1169 "If non-nil set `debug-on-error' to t in `eval-expression'.
1170 If nil, don't change the value of `debug-on-error'."
1176 "Format VALUE as a result of evaluated expression.
1177 Return a formatted string which is displayed in the echo area
1178 in addition to the value printed by prin1 in functions which
1179 display the result of expression evaluation."
1192 ;; We define this, rather than making `eval' interactive,
1193 ;; for the sake of completion of names like eval-region, eval-buffer.
1196 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1197 When called interactively, read an Emacs Lisp expression and
1198 evaluate it.
1199 Value is also consed on to front of the variable `values'.
1200 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1201 with prefix argument) means insert the result into the current buffer
1202 instead of printing it in the echo area. Truncates long output
1203 according to the value of the variables `eval-expression-print-length'
1204 and `eval-expression-print-level'.
1206 If `eval-expression-debug-on-error' is non-nil, which is the default,
1207 this command arranges for all errors to enter the debugger."
1211 nil read-expression-map t
1213 current-prefix-arg))
1218 ;; Bind debug-on-error to something unique so that we can
1219 ;; detect when evaled code changes it.
1223 ;; If evaled code has changed the value of debug-on-error,
1224 ;; propagate that change to the global binding.
1240 "Prompting with PROMPT, let user edit COMMAND and eval result.
1241 COMMAND is a Lisp expression. Let user edit that expression in
1242 the minibuffer, then read and evaluate the result."
1249 read-expression-map t
1251 ;; If command was added to command-history as a string,
1252 ;; get rid of that. We want only evaluable expressions there.
1256 ;; If command to be redone does not match front of history,
1257 ;; add it to the history.
1263 "Edit and re-evaluate last complex command, or ARGth from last.
1264 A complex command is one which used the minibuffer.
1265 The command is placed in the minibuffer as a Lisp form for editing.
1266 The result is executed, repeating the command as changed.
1267 If the command has been changed or is not the most recent previous
1268 command it is added to the front of the command history.
1269 You can use the minibuffer history commands \
1271 to get different commands to edit and resubmit."
1274 newcmd)
1286 ;; If command was added to command-history as a
1287 ;; string, get rid of that. We want only
1288 ;; evaluable expressions there.
1292 ;; If command to be redone does not match front of history,
1293 ;; add it to the history.
1302 "Read command name to invoke in `execute-extended-command'."
1307 ;; Get a command name at point in the original buffer
1308 ;; to propose it after M-n.
1312 ;; Read a string, completing from and restricting to the set of
1313 ;; all defined commands. Don't provide any initial input.
1314 ;; Save the command read on the extended-command history list.
1325 ;; This isn't strictly correct if `execute-extended-command'
1326 ;; is bound to anything else (e.g. [menu]).
1327 ;; It could use (key-description (this-single-command-keys)),
1328 ;; but actually a prompt other than "M-x" would be confusing,
1329 ;; because "M-x" is a well-known prompt to read a command
1330 ;; and it serves as a shorthand for "Extended command: ".
1334 \f
1336 "Default minibuffer history list.
1337 This is used for all minibuffer input
1338 except when an alternate history list is specified.
1340 Maximum length of the history list is determined by the value
1343 "Control whether history list elements are expressions or strings.
1344 If the value of this variable equals current minibuffer depth,
1345 they are expressions; otherwise they are strings.
1346 \(That convention is designed to do the right thing for
1353 "Text that was in this minibuffer before any history commands.
1354 This is nil if there have not yet been any history commands
1363 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1367 "Minibuffer history variables for which matching should ignore case.
1368 If a history variable is a member of this list, then the
1370 commands ignore case when searching it, regardless of `case-fold-search'."
1375 "Find the previous history element that matches REGEXP.
1376 \(Previous history elements refer to earlier actions.)
1377 With prefix argument N, search for Nth previous match.
1378 If N is negative, find the next or Nth next match.
1379 Normally, history elements are matched case-insensitively if
1380 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1381 makes the search case-sensitive.
1382 See also `minibuffer-history-case-insensitive-variables'."
1386 nil
1387 minibuffer-local-map
1388 nil
1389 'minibuffer-history-search-history
1391 ;; Use the last regexp specified, by default, if input is empty.
1396 regexp)
1406 ;; On some systems, ignore case for file names.
1408 minibuffer-history-case-insensitive-variables)
1409 t
1410 ;; Respect the user's setting for case-fold-search:
1411 case-fold-search)
1412 nil))
1413 prevpos
1414 match-string
1415 match-offset
1422 "No later matching history item"
1443 next-matching-history-element))
1447 "Find the next history element that matches REGEXP.
1448 \(The next history element refers to a more recent action.)
1449 With prefix argument N, search for Nth next match.
1450 If N is negative, find the previous or Nth previous match.
1451 Normally, history elements are matched case-insensitively if
1452 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1453 makes the search case-sensitive."
1457 nil
1458 minibuffer-local-map
1459 nil
1460 'minibuffer-history-search-history
1462 ;; Use the last regexp specified, by default, if input is empty.
1467 regexp)
1474 "Function run by `goto-history-element' before consuming default values.
1475 This is useful to dynamically add more elements to the list of default values
1476 when `goto-history-element' reaches the end of this list.
1477 Before calling this function `goto-history-element' sets the variable
1478 `minibuffer-default-add-done' to t, so it will call this function only
1479 once. In special cases, when this function needs to be called more
1480 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1484 "When nil, add more elements to the end of the list of default values.
1485 The value nil causes `goto-history-element' to add more elements to
1486 the list of defaults when it reaches the end of this list. It does
1492 "Return a list of all completions without the default value.
1493 This function is used to add all elements of the completion table to
1494 the end of the list of defaults just after the default value."
1497 minibuffer-completion-table
1498 minibuffer-completion-predicate)))
1504 "Puts element of the minibuffer history in the minibuffer.
1505 The argument NABS specifies the absolute history position."
1519 elt minibuffer-returned-to-present)
1531 previous-history-element))
1543 minibuffer-default)))
1555 elt))
1559 "Puts next element of the minibuffer history in the minibuffer.
1560 With argument N, it uses the Nth following element."
1566 "Puts previous element of the minibuffer history in the minibuffer.
1567 With argument N, it uses the Nth previous element."
1573 "Get next history element which completes the minibuffer before the point.
1574 The contents of the minibuffer after the point are deleted, and replaced
1575 by the new completion."
1581 n)
1582 ;; next-matching-history-element always puts us at (point-min).
1583 ;; Move to the position we were at before changing the buffer contents.
1584 ;; This is still sensical, because the text before point has not changed.
1588 "\
1589 Get previous history element which completes the minibuffer before the point.
1590 The contents of the minibuffer after the point are deleted, and replaced
1591 by the new completion."
1595 ;; For compatibility with the old subr of the same name.
1597 "Return the display width of the minibuffer prompt.
1598 Return 0 if current buffer is not a minibuffer."
1599 ;; Return the width of everything before the field at the end of
1600 ;; the buffer; this should be 0 for normal buffers.
1602 \f
1603 ;; isearch minibuffer history
1610 "Set up a minibuffer for using isearch to search the minibuffer history.
1611 Intended to be added to `minibuffer-setup-hook'."
1623 "Clean up the minibuffer after terminating isearch in the minibuffer."
1628 "Return the proper search function, for isearch in minibuffer history."
1635 ;; Use standard functions to search within minibuffer text
1641 found)
1642 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1643 ;; searching forward. Lazy-highlight calls this lambda with the
1644 ;; bound arg, so skip the minibuffer prompt.
1648 ;; 1. First try searching in the initial minibuffer text
1651 noerror)
1652 ;; 2. If the above search fails, start putting next/prev history
1653 ;; elements in the minibuffer successively, and search the string
1654 ;; in them. Do this only when bound is nil (i.e. not while
1655 ;; lazy-highlighting search strings in the current minibuffer text).
1667 ;; After putting the next/prev history element, search
1668 ;; the string in them again, until next-history-element
1669 ;; or previous-history-element raises an error at the
1670 ;; beginning/end of history.
1673 ;; For backward search, don't search
1674 ;; in the minibuffer prompt
1676 noerror)))
1677 ;; Return point of the new search result
1679 ;; Return nil when next(prev)-history-element fails
1683 "Display the minibuffer history search prompt.
1684 If there are no search errors, this function displays an overlay with
1685 the isearch prompt which replaces the original minibuffer prompt.
1686 Otherwise, it displays the standard isearch message returned from
1687 `isearch-message'."
1689 ;; Use standard function `isearch-message' when not in the minibuffer,
1690 ;; or search fails, or has an error (like incomplete regexp).
1691 ;; This function overwrites minibuffer text with isearch message,
1692 ;; so it's possible to see what is wrong in the search string.
1694 ;; Otherwise, put the overlay with the standard isearch prompt over
1695 ;; the initial minibuffer prompt.
1704 ;; And clear any previous isearch message.
1708 "Wrap the minibuffer history search when search fails.
1709 Move point to the first history element for a forward search,
1710 or to the last history element for a backward search."
1712 ;; When `minibuffer-history-isearch-search' fails on reaching the
1713 ;; beginning/end of the history, wrap the search to the first/last
1714 ;; minibuffer history element.
1722 "Save a function restoring the state of minibuffer history search.
1723 Save `minibuffer-history-position' to the additional state parameter
1724 in the search status stack."
1729 "Restore the minibuffer history search state.
1730 Go to the history element by the absolute history position HIST-POS."
1733 \f
1734 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1738 "Table mapping redo records to the corresponding undo one.
1739 A redo record for undo-in-region maps to t.
1749 "Within a run of consecutive undo commands, list remaining to be undone.
1753 "Undo some previous changes.
1754 Repeat this command to undo more changes.
1755 A numeric ARG serves as a repeat count.
1757 In Transient Mark mode when the mark is active, only undo changes within
1759 as an argument limits undo to changes within the current region."
1761 ;; Make last-command indicate for the next command that this was an undo.
1762 ;; That way, another undo will undo more.
1763 ;; If we get to the end of the undo history and get an error,
1764 ;; another undo command will find the undo history empty
1765 ;; and will get another error. To begin undoing the undos,
1766 ;; you must type some other command.
1769 message)
1770 ;; If we get an error in undo-start,
1771 ;; the next command should not be a "consecutive undo".
1772 ;; So set `this-command' to something other than `undo'.
1777 ;; If something (a timer or filter?) changed the buffer
1778 ;; since the previous command, don't continue the undo seq.
1782 ;; If the last undo record made was made by undo
1783 ;; it shows nothing else happened in between.
1790 ;; get rid of initial undo boundary
1792 ;; If we got this far, the next command should be a consecutive undo.
1794 ;; Check to see whether we're hitting a redo record, and if
1795 ;; so, ask the user whether she wants to skip the redo/undo pair.
1802 ;; The equiv entry might point to another redo record if we have done
1803 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1811 ;; Record the fact that the just-generated undo records come from an
1812 ;; undo operation--that is, they are redo records.
1813 ;; In the ordinary case (not within a region), map the redo
1814 ;; record to the following undos.
1815 ;; I don't know how to do that in the undo-in-region case.
1817 ;; Strip any leading undo boundaries there might be, like we do
1818 ;; above when checking.
1822 undo-equiv-table))
1823 ;; Don't specify a position in the undo record for the undo command.
1824 ;; Instead, undoing this should move point to where the change is.
1843 ;; Record what the current undo list says,
1844 ;; so the next command can tell if the buffer was modified in between.
1847 ;; Display a message announcing success.
1852 "Make BUFFER stop keeping undo information.
1853 No argument or nil as argument means do this for the current buffer."
1859 "Undo some previous changes.
1860 Repeat this command to undo more changes.
1861 A numeric ARG serves as a repeat count.
1862 Contrary to `undo', this will not redo a previous undo."
1867 "Non-nil while performing an undo.
1871 "Undo back N undo-boundaries beyond what was already undone recently.
1872 Call `undo-start' to get ready to undo recent changes,
1873 then call `undo-more' one or more times to undo them."
1878 ;; Note: The following, while pulling elements off
1879 ;; `pending-undo-list' will call primitive change functions which
1880 ;; will push more elements onto `buffer-undo-list'.
1885 ;; Deep copy of a list
1887 "Make a copy of undo list LIST."
1893 elt))
1896 "Set `pending-undo-list' to the front of the undo list.
1897 The next call to `undo-more' will undo the most recently made change.
1898 If BEG and END are specified, then only undo elements
1899 that apply to text between BEG and END are used; other undo elements
1900 are ignored. If BEG and END are nil, all undo elements are used."
1906 buffer-undo-list)))
1911 "Return a list of undo elements for the region START to END.
1912 The elements come from `buffer-undo-list', but we keep only
1913 the elements inside this region, and discard those outside this region.
1914 If we find an element that crosses an edge of this region,
1915 we stop and ignore all further elements."
1918 undo-adjusted-markers
1919 some-rejected
1920 undo-elt temp-undo-list delta)
1925 ;; This is a "was unmodified" element.
1926 ;; Keep it if we have kept everything thus far.
1933 ;; Don't put two nils together in the list
1947 ;; Loop down the earlier events adjusting their buffer
1948 ;; positions to reflect the fact that a change to the buffer
1949 ;; isn't being undone. We only need to process those element
1950 ;; types which undo-elt-in-region will return as being in
1951 ;; the region since only those types can ever get into the
1952 ;; output
1961 ;; (TEXT . POSITION)
1968 ;; (BEGIN . END)
1973 ;; (nil PROPERTY VALUE BEG . END)
1983 "Determine whether UNDO-ELT falls inside the region START ... END.
1984 If it crosses the edge, we return nil."
1989 t)
1991 nil)
1993 ;; (TEXT . POSITION)
1997 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1998 ;; See if MARKER is inside the region.
2009 ;; (nil PROPERTY VALUE BEG . END)
2014 ;; (BEGIN . END)
2019 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2020 This assumes we have already decided that UNDO-ELT
2021 is not *inside* the region START...END."
2024 ;; (nil PROPERTY VALUE BEG . END)
2029 ;; (BEGIN . END)
2033 ;; Return the first affected buffer position and the delta for an undo element
2034 ;; delta is defined as the change in subsequent buffer positions if we *did*
2035 ;; the undo.
2039 ;; (TEXT . POSITION)
2042 ;; (BEGIN . END)
2049 "If non-nil ask about discarding undo info for the current command.
2050 Normally, Emacs discards the undo info for the current command if
2051 it exceeds `undo-outer-limit'. But if you set this option
2052 non-nil, it asks in the echo area whether to discard the info.
2053 If you answer no, there is a slight risk that Emacs might crash, so
2054 only do it if you really want to undo the command.
2056 This option is mainly intended for debugging. You have to be
2057 careful if you use it for other purposes. Garbage collection is
2058 inhibited while the question is asked, meaning that Emacs might
2059 leak memory. So you should make sure that you do not wait
2060 excessively long before answering the question."
2066 "If non-nil, an extra level of size that's ok in an undo item.
2067 We don't ask the user about truncating the undo list until the
2068 current item gets bigger than this amount.
2073 ;; When the first undo batch in an undo list is longer than
2074 ;; undo-outer-limit, this function gets called to warn the user that
2075 ;; the undo info for the current command was discarded. Garbage
2076 ;; collection is inhibited around the call, so it had better not do a
2077 ;; lot of consing.
2083 ;; Don't ask the question again unless it gets even bigger.
2084 ;; This applies, in particular, if the user quits from the question.
2085 ;; Such a quit quits out of GC, but something else will call GC
2086 ;; again momentarily. It will call this function again,
2087 ;; but we don't want to ask the question again.
2094 t)
2095 nil))
2100 "The undo info was discarded because it exceeded \
2101 `undo-outer-limit'.
2103 This is normal if you executed a command that made a huge change
2104 to the buffer. In that case, to prevent similar problems in the
2105 future, set `undo-outer-limit' to a value that is large enough to
2106 cover the maximum size of normal changes you expect a single
2107 command to make, but not so large that it might exceed the
2108 maximum memory allotted to Emacs.
2110 If you did not execute any such command, the situation is
2111 probably due to a bug and you should report it.
2113 You can disable the popping up of this buffer by adding the entry
2114 \(undo discard-info) to the user option `warning-suppress-types',
2118 t))
2119 \f
2121 "History list for some commands that read shell commands.
2123 Maximum length of the history list is determined by the value
2130 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2131 This buffer is used when `shell-command' or `shell-command-on-region'
2132 is run interactively. A value of nil means that output to stderr and
2139 "Return a list of all commands associated with the current file.
2140 This function is used to add all related commands retrieved by `mailcap'
2141 to the end of the list of defaults just after the default value."
2145 minibuffer-default))
2150 commands))
2161 map)
2165 "Read a shell command from the minibuffer.
2166 The arguments are the same as the ones of `read-from-minibuffer',
2167 except READ and KEYMAP are missing and HIST defaults
2168 to `shell-command-history'."
2176 minibuffer-local-shell-command-map
2177 nil
2179 args)))
2182 "Execute string COMMAND asynchronously in background.
2184 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2185 surrounded by whitespace and executes the command asynchronously.
2186 The output appears in the buffer `*Async Shell Command*'.
2188 In Elisp, you will often be better served by calling `start-process'
2189 directly, since it offers more control and does not impose the use of a
2190 shell (with its need to quote arguments)."
2196 current-prefix-arg
2197 shell-command-default-error-buffer))
2203 "Execute string COMMAND in inferior shell; display output, if any.
2204 With prefix argument, insert the COMMAND's output at point.
2206 If COMMAND ends in ampersand, execute it asynchronously.
2207 The output appears in the buffer `*Async Shell Command*'.
2208 That buffer is in shell mode.
2210 Otherwise, COMMAND is executed synchronously. The output appears in
2211 the buffer `*Shell Command Output*'. If the output is short enough to
2212 display in the echo area (which is determined by the variables
2213 `resize-mini-windows' and `max-mini-window-height'), it is shown
2214 there, but it is nonetheless available in buffer `*Shell Command
2215 Output*' even though that buffer is not automatically displayed.
2217 To specify a coding system for converting non-ASCII characters
2219 before this command.
2221 Noninteractive callers can specify coding systems by binding
2222 `coding-system-for-read' and `coding-system-for-write'.
2224 The optional second argument OUTPUT-BUFFER, if non-nil,
2225 says to put the output in some other buffer.
2226 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2227 If OUTPUT-BUFFER is not a buffer and not nil,
2228 insert output in current buffer. (This cannot be done asynchronously.)
2229 In either case, the buffer is first erased, and the output is
2230 inserted after point (leaving mark after it).
2232 If the command terminates without error, but generates output,
2234 the output can be displayed in the echo area or in its buffer.
2235 If the output is short enough to display in the echo area
2236 \(determined by the variable `max-mini-window-height' if
2237 `resize-mini-windows' is non-nil), it is shown there.
2238 Otherwise,the buffer containing the output is displayed.
2242 of the output.
2244 If there is no output, or if output is inserted in the current buffer,
2245 then `*Shell Command Output*' is deleted.
2247 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2248 or buffer name to which to direct the command's standard error output.
2249 If it is nil, error output is mingled with regular output.
2250 In an interactive call, the variable `shell-command-default-error-buffer'
2251 specifies the value of ERROR-BUFFER.
2253 In Elisp, you will often be better served by calling `call-process' or
2254 `start-process' directly, since it offers more control and does not impose
2255 the use of a shell (with its need to quote arguments)."
2266 current-prefix-arg
2267 shell-command-default-error-buffer))
2268 ;; Look for a handler in case default-directory is a remote file name.
2276 ;; Output goes in current buffer.
2282 temporary-file-directory)))
2283 nil)))
2286 ;; We do not use -f for csh; we will not support broken use of
2287 ;; .cshrcs. Even the BSD csh manual says to use
2288 ;; "if ($?prompt) exit" before things which are not useful
2289 ;; non-interactively. Besides, if someone wants their other
2290 ;; aliases for shell commands then they can still have them.
2294 t)
2295 nil shell-command-switch command)
2302 ;; Do no formatting while reading error file,
2303 ;; because that can run a shell command, and we
2304 ;; don't want that to cause an infinite recursion.
2306 ;; Put point after the inserted errors.
2310 ;; This is like exchange-point-and-mark, but doesn't
2311 ;; activate the mark. It is cleaner to avoid activation,
2312 ;; even though the command loop would deactivate the mark
2313 ;; because we inserted text.
2317 ;; Output goes in a separate buffer.
2318 ;; Preserve the match data in case called from a program.
2321 ;; Command ending with ampersand means asynchronous.
2325 proc)
2326 ;; Remove the ampersand.
2328 ;; If will kill a process, query first.
2336 ;; Setting buffer-read-only to nil doesn't suffice
2337 ;; if some text has a non-nil read-only property,
2338 ;; which comint sometimes adds for prompts.
2344 shell-command-switch command))
2348 ;; Use the comint filter for proper handling of carriage motion
2349 ;; (see `comint-inhibit-carriage-motion'),.
2351 ))
2352 ;; Otherwise, command is executed synchronously.
2354 output-buffer nil error-buffer)))))))
2358 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2359 MESSAGE may be either a string or a buffer.
2361 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2362 the maximum height of the echo area, as defined by `max-mini-window-height'
2363 if `resize-mini-windows' is non-nil.
2365 Returns either the string shown in the echo area, or when a pop-up
2366 buffer is used, the window used to display it.
2368 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2369 name of the buffer used to display it in the case where a pop-up buffer
2370 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2371 string and it is displayed in the echo area, it is not specified whether
2372 the contents are inserted into the buffer anyway.
2374 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2375 and only used if a buffer is displayed."
2377 ;; Trivial case where we can use the echo area
2381 ;; Trivial case where we can just remove single trailing newline
2384 ;; General case
2387 message
2396 0
2400 (<= lines
2404 max-mini-window-height))
2406 max-mini-window-height)
2410 ;; Don't use the echo area if the output buffer is
2411 ;; already dispayed in the selected frame.
2413 ;; Echo area
2419 ;; Buffer
2422 not-this-window frame))))))))
2425 ;; We have a sentinel to prevent insertion of a termination message
2426 ;; in the buffer itself.
2434 &optional output-buffer replace
2435 error-buffer display-error-buffer)
2436 "Execute string COMMAND in inferior shell with region as input.
2437 Normally display output (if any) in temp buffer `*Shell Command Output*';
2438 Prefix arg means replace the region with it. Return the exit code of
2439 COMMAND.
2441 To specify a coding system for converting non-ASCII characters
2443 before this command. By default, the input (from the current buffer)
2444 is encoded in the same coding system that will be used to save the file,
2445 `buffer-file-coding-system'. If the output is going to replace the region,
2446 then it is decoded from that same coding system.
2448 The noninteractive arguments are START, END, COMMAND,
2449 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2450 Noninteractive callers can specify coding systems by binding
2451 `coding-system-for-read' and `coding-system-for-write'.
2453 If the command generates output, the output may be displayed
2454 in the echo area or in a buffer.
2455 If the output is short enough to display in the echo area
2456 \(determined by the variable `max-mini-window-height' if
2457 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2458 it is displayed in the buffer `*Shell Command Output*'. The output
2459 is available in that buffer in both cases.
2461 If there is output and an error, a message about the error
2462 appears at the end of the output.
2464 If there is no output, or if output is inserted in the current buffer,
2465 then `*Shell Command Output*' is deleted.
2467 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2468 that says to put the output in some other buffer.
2469 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2470 If OUTPUT-BUFFER is not a buffer and not nil,
2471 insert output in the current buffer.
2472 In either case, the output is inserted after point (leaving mark after it).
2474 If REPLACE, the optional fifth argument, is non-nil, that means insert
2475 the output in place of text from START to END, putting point and mark
2476 around it.
2478 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2479 or buffer name to which to direct the command's standard error output.
2480 If it is nil, error output is mingled with regular output.
2481 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2482 were any errors. (This is always t, interactively.)
2483 In an interactive call, the variable `shell-command-default-error-buffer'
2484 specifies the value of ERROR-BUFFER."
2488 ;; Do this before calling region-beginning
2489 ;; and region-end, in case subprocess output
2490 ;; relocates them while we are in the minibuffer.
2492 ;; call-interactively recognizes region-beginning and
2493 ;; region-end specially, leaving them in the history.
2495 string
2496 current-prefix-arg
2497 current-prefix-arg
2498 shell-command-default-error-buffer
2499 t)))
2505 temporary-file-directory)))
2506 nil))
2507 exit-status)
2511 ;; Replace specified region with output from command.
2513 ;; Don't muck with mark unless REPLACE says we should.
2520 t)
2521 nil shell-command-switch command))
2522 ;; It is rude to delete a buffer which the command is not using.
2523 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2524 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2525 ;; (kill-buffer shell-buffer)))
2526 ;; Don't muck with mark unless REPLACE says we should.
2528 ;; No prefix argument: put the output in a temp buffer,
2529 ;; replacing its entire contents.
2534 ;; If the input is the same buffer as the output,
2535 ;; delete everything but the specified region,
2536 ;; then replace that region with the output.
2542 shell-file-name t
2545 t)
2546 nil shell-command-switch
2547 command)))
2548 ;; Clear the output buffer, then run the command with
2549 ;; output there.
2560 buffer)
2561 nil shell-command-switch command)))
2562 ;; Report the output.
2572 ;; There's some output, display it
2574 ;; No output; error?
2581 shell-command-default-error-buffer)
2588 output))
2591 exit-status))
2594 exit-status output))))
2595 ;; Don't kill: there might be useful info in the undo-log.
2596 ;; (kill-buffer buffer)
2597 ))))
2605 ;; Do no formatting while reading error file,
2606 ;; because that can run a shell command, and we
2607 ;; don't want that to cause an infinite recursion.
2609 ;; Put point after the inserted errors.
2614 exit-status))
2617 "Execute shell command COMMAND and return its output as a string."
2620 standard-output
2624 "Process files synchronously in a separate process.
2625 Similar to `call-process', but may invoke a file handler based on
2626 `default-directory'. The current working directory of the
2627 subprocess is `default-directory'.
2629 File names in INFILE and BUFFER are handled normally, but file
2630 names in ARGS should be relative to `default-directory', as they
2631 are passed to the process verbatim. \(This is a difference to
2632 `call-process' which does not support file handlers for INFILE
2633 and BUFFER.\)
2635 Some file handlers might not support all variants, for example
2636 they might behave as if DISPLAY was nil, regardless of the actual
2637 value passed."
2639 lc stderr-file)
2649 display args)
2655 "Whether a call of `process-file' changes remote files.
2657 Per default, this variable is always set to `t', meaning that a
2658 call of `process-file' could potentially change any file on a
2659 remote host. When set to `nil', a file handler could optimize
2660 its behavior with respect to remote file attributes caching.
2662 This variable should never be changed by `setq'. Instead of, it
2666 "Start a program in a subprocess. Return the process object for it.
2668 Similar to `start-process', but may invoke a file handler based on
2669 `default-directory'. See Info node `(elisp)Magic File Names'.
2671 This handler ought to run PROGRAM, perhaps on the local host,
2672 perhaps on a remote host that corresponds to `default-directory'.
2673 In the latter case, the local part of `default-directory' becomes
2674 the working directory of the process.
2676 PROGRAM and PROGRAM-ARGS might be file names. They are not
2677 objects of file handler invocation. File handlers might not
2678 support pty association, if PROGRAM is nil."
2682 \f
2683 ;;;; Process menu
2695 "Major mode for listing the processes called by Emacs."
2707 "Recompute the list of processes for the Process List buffer."
2718 face link
2721 follow-link t
2722 process-buffer ,buf
2723 action process-menu-visit-buffer)
2732 "datagram"
2747 tabulated-list-entries)))))
2753 "Display a list of all processes.
2754 If optional argument QUERY-ONLY is non-nil, only processes with
2755 the query-on-exit flag set are listed.
2756 Any process listed as exited or signaled is actually eliminated
2757 after the listing is made.
2758 Optional argument BUFFER specifies a buffer to use, instead of
2760 The return value is always nil."
2772 nil)
2773 \f
2777 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2778 (define-key map [switch-frame] nil)
2779 (define-key map [?\C-u] 'universal-argument-more)
2780 (define-key map [?-] 'universal-argument-minus)
2781 (define-key map [?0] 'digit-argument)
2782 (define-key map [?1] 'digit-argument)
2783 (define-key map [?2] 'digit-argument)
2784 (define-key map [?3] 'digit-argument)
2785 (define-key map [?4] 'digit-argument)
2786 (define-key map [?5] 'digit-argument)
2787 (define-key map [?6] 'digit-argument)
2788 (define-key map [?7] 'digit-argument)
2789 (define-key map [?8] 'digit-argument)
2790 (define-key map [?9] 'digit-argument)
2791 (define-key map [kp-0] 'digit-argument)
2792 (define-key map [kp-1] 'digit-argument)
2793 (define-key map [kp-2] 'digit-argument)
2794 (define-key map [kp-3] 'digit-argument)
2795 (define-key map [kp-4] 'digit-argument)
2796 (define-key map [kp-5] 'digit-argument)
2797 (define-key map [kp-6] 'digit-argument)
2798 (define-key map [kp-7] 'digit-argument)
2799 (define-key map [kp-8] 'digit-argument)
2800 (define-key map [kp-9] 'digit-argument)
2801 (define-key map [kp-subtract] 'universal-argument-minus)
2802 map)
2805 (defvar universal-argument-num-events nil
2806 "Number of argument-specifying events read by `universal-argument'.
2807 `universal-argument-other-key' uses this to discard those events
2808 from (this-command-keys), and reread only the final command.")
2810 (defvar saved-overriding-map t
2811 "The saved value of `overriding-terminal-local-map'.
2815 (defun save&set-overriding-map (map)
2816 "Set `overriding-terminal-local-map' to MAP."
2817 (when (eq saved-overriding-map t)
2818 (setq saved-overriding-map overriding-terminal-local-map)
2819 (setq overriding-terminal-local-map map)))
2821 (defun restore-overriding-map ()
2822 "Restore `overriding-terminal-local-map' to its saved value."
2823 (setq overriding-terminal-local-map saved-overriding-map)
2824 (setq saved-overriding-map t))
2826 (defun universal-argument ()
2827 "Begin a numeric argument for the following command.
2832 multiplies the argument by 4 each time.
2834 which is different in effect from any particular numeric argument.
2836 (interactive)
2837 (setq prefix-arg (list 4))
2838 (setq universal-argument-num-events (length (this-command-keys)))
2839 (save&set-overriding-map universal-argument-map))
2841 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2842 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2843 (defun universal-argument-more (arg)
2844 (interactive "P")
2845 (if (consp arg)
2846 (setq prefix-arg (list (* 4 (car arg))))
2847 (if (eq arg '-)
2848 (setq prefix-arg (list -4))
2849 (setq prefix-arg arg)
2850 (restore-overriding-map)))
2851 (setq universal-argument-num-events (length (this-command-keys))))
2853 (defun negative-argument (arg)
2854 "Begin a negative numeric argument for the next command.
2856 (interactive "P")
2857 (cond ((integerp arg)
2858 (setq prefix-arg (- arg)))
2859 ((eq arg '-)
2860 (setq prefix-arg nil))
2861 (t
2862 (setq prefix-arg '-)))
2863 (setq universal-argument-num-events (length (this-command-keys)))
2864 (save&set-overriding-map universal-argument-map))
2866 (defun digit-argument (arg)
2867 "Part of the numeric argument for the next command.
2869 (interactive "P")
2870 (let* ((char (if (integerp last-command-event)
2871 last-command-event
2872 (get last-command-event 'ascii-character)))
2874 (cond ((integerp arg)
2875 (setq prefix-arg (+ (* arg 10)
2876 (if (< arg 0) (- digit) digit))))
2877 ((eq arg '-)
2878 ;; Treat -0 as just -, so that -01 will work.
2879 (setq prefix-arg (if (zerop digit) '- (- digit))))
2880 (t
2881 (setq prefix-arg digit))))
2882 (setq universal-argument-num-events (length (this-command-keys)))
2883 (save&set-overriding-map universal-argument-map))
2885 ;; For backward compatibility, minus with no modifiers is an ordinary
2886 ;; command if digits have already been entered.
2887 (defun universal-argument-minus (arg)
2888 (interactive "P")
2889 (if (integerp arg)
2890 (universal-argument-other-key arg)
2891 (negative-argument arg)))
2893 ;; Anything else terminates the argument and is left in the queue to be
2894 ;; executed as a command.
2895 (defun universal-argument-other-key (arg)
2896 (interactive "P")
2897 (setq prefix-arg arg)
2898 (let* ((key (this-command-keys))
2899 (keylist (listify-key-sequence key)))
2900 (setq unread-command-events
2901 (append (nthcdr universal-argument-num-events keylist)
2902 unread-command-events)))
2903 (reset-this-command-lengths)
2904 (restore-overriding-map))
2905 \f
2907 (defvar filter-buffer-substring-functions nil
2908 "Wrapper hook around `filter-buffer-substring'.
2909 The functions on this special hook are called with 4 arguments:
2910 NEXT-FUN BEG END DELETE
2911 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2912 that performs the default operation. The other 3 arguments are like
2913 the ones passed to `filter-buffer-substring'.")
2915 (defvar buffer-substring-filters nil
2916 "List of filter functions for `filter-buffer-substring'.
2917 Each function must accept a single argument, a string, and return
2918 a string. The buffer substring is passed to the first function
2919 in the list, and the return value of each function is passed to
2920 the next. The return value of the last function is used as the
2921 return value of `filter-buffer-substring'.
2923 If this variable is nil, no filtering is performed.")
2924 (make-obsolete-variable 'buffer-substring-filters
2925 'filter-buffer-substring-functions "24.1")
2927 (defun filter-buffer-substring (beg end &optional delete)
2928 "Return the buffer substring between BEG and END, after filtering.
2929 The filtering is performed by `filter-buffer-substring-functions'.
2931 If DELETE is non-nil, the text between BEG and END is deleted
2932 from the buffer.
2934 This function should be used instead of `buffer-substring',
2935 `buffer-substring-no-properties', or `delete-and-extract-region'
2936 when you want to allow filtering to take place. For example,
2937 major or minor modes can use `filter-buffer-substring-functions' to
2938 extract characters that are special to a buffer, and should not
2939 be copied into other buffers."
2940 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2941 (cond
2942 ((or delete buffer-substring-filters)
2943 (save-excursion
2944 (goto-char beg)
2945 (let ((string (if delete (delete-and-extract-region beg end)
2946 (buffer-substring beg end))))
2947 (dolist (filter buffer-substring-filters)
2948 (setq string (funcall filter string)))
2949 string)))
2950 (t
2951 (buffer-substring beg end)))))
2954 ;;;; Window system cut and paste hooks.
2956 (defvar interprogram-cut-function nil
2957 "Function to call to make a killed region available to other programs.
2959 Most window systems provide some sort of facility for cutting and
2960 pasting text between the windows of different programs.
2961 This variable holds a function that Emacs calls whenever text
2962 is put in the kill ring, to make the new kill available to other
2963 programs.
2965 The function takes one argument, TEXT, which is a string containing
2966 the text which should be made available.")
2968 (defvar interprogram-paste-function nil
2969 "Function to call to get text cut from other programs.
2971 Most window systems provide some sort of facility for cutting and
2972 pasting text between the windows of different programs.
2973 This variable holds a function that Emacs calls to obtain
2974 text that other programs have provided for pasting.
2976 The function should be called with no arguments. If the function
2977 returns nil, then no other program has provided such text, and the top
2978 of the Emacs kill ring should be used. If the function returns a
2979 string, then the caller of the function \(usually `current-kill')
2980 should put this string in the kill ring as the latest kill.
2982 This function may also return a list of strings if the window
2983 system supports multiple selections. The first string will be
2984 used as the pasted text, but the other will be placed in the
2985 kill ring for easy access via `yank-pop'.
2987 Note that the function should return a string only if a program other
2988 than Emacs has provided a string for pasting; if Emacs provided the
2989 most recent string, the function should return nil. If it is
2990 difficult to tell whether Emacs or some other program provided the
2991 current string, it is probably good enough to return nil if the string
2992 is equal (according to `string=') to the last text Emacs provided.")
2993 \f
2996 ;;;; The kill ring data structure.
2998 (defvar kill-ring nil
2999 "List of killed text sequences.
3000 Since the kill ring is supposed to interact nicely with cut-and-paste
3001 facilities offered by window systems, use of this variable should
3002 interact nicely with `interprogram-cut-function' and
3003 `interprogram-paste-function'. The functions `kill-new',
3004 `kill-append', and `current-kill' are supposed to implement this
3005 interaction; you may want to use them instead of manipulating the kill
3006 ring directly.")
3008 (defcustom kill-ring-max 60
3009 "Maximum length of kill ring before oldest elements are thrown away."
3010 :type 'integer
3011 :group 'killing)
3013 (defvar kill-ring-yank-pointer nil
3014 "The tail of the kill ring whose car is the last thing yanked.")
3016 (defcustom save-interprogram-paste-before-kill nil
3017 "Save clipboard strings into kill ring before replacing them.
3018 When one selects something in another program to paste it into Emacs,
3019 but kills something in Emacs before actually pasting it,
3020 this selection is gone unless this variable is non-nil,
3021 in which case the other program's selection is saved in the `kill-ring'
3023 :type 'boolean
3024 :group 'killing
3025 :version "23.2")
3027 (defcustom kill-do-not-save-duplicates nil
3028 "Do not add a new string to `kill-ring' when it is the same as the last one."
3029 :type 'boolean
3030 :group 'killing
3031 :version "23.2")
3033 (defun kill-new (string &optional replace yank-handler)
3034 "Make STRING the latest kill in the kill ring.
3035 Set `kill-ring-yank-pointer' to point to it.
3036 If `interprogram-cut-function' is non-nil, apply it to STRING.
3037 Optional second argument REPLACE non-nil means that STRING will replace
3038 the front of the kill ring, rather than being added to the list.
3040 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3041 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3042 STRING.
3044 When the yank handler has a non-nil PARAM element, the original STRING
3045 argument is not used by `insert-for-yank'. However, since Lisp code
3046 may access and use elements from the kill ring directly, the STRING
3048 (if (> (length string) 0)
3049 (if yank-handler
3050 (put-text-property 0 (length string)
3051 'yank-handler yank-handler string))
3052 (if yank-handler
3053 (signal 'args-out-of-range
3054 (list string "yank-handler specified for empty string"))))
3055 (unless (and kill-do-not-save-duplicates
3056 (equal string (car kill-ring)))
3057 (if (fboundp 'menu-bar-update-yank-menu)
3058 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3059 (when save-interprogram-paste-before-kill
3060 (let ((interprogram-paste (and interprogram-paste-function
3061 (funcall interprogram-paste-function))))
3062 (when interprogram-paste
3063 (dolist (s (if (listp interprogram-paste)
3064 (nreverse interprogram-paste)
3065 (list interprogram-paste)))
3066 (unless (and kill-do-not-save-duplicates
3067 (equal s (car kill-ring)))
3068 (push s kill-ring))))))
3069 (unless (and kill-do-not-save-duplicates
3070 (equal string (car kill-ring)))
3071 (if (and replace kill-ring)
3072 (setcar kill-ring string)
3073 (push string kill-ring)
3074 (if (> (length kill-ring) kill-ring-max)
3075 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3076 (setq kill-ring-yank-pointer kill-ring)
3077 (if interprogram-cut-function
3078 (funcall interprogram-cut-function string)))
3079 (set-advertised-calling-convention
3080 'kill-new '(string &optional replace) "23.3")
3082 (defun kill-append (string before-p &optional yank-handler)
3083 "Append STRING to the end of the latest kill in the kill ring.
3084 If BEFORE-P is non-nil, prepend STRING to the kill.
3085 If `interprogram-cut-function' is set, pass the resulting kill to it."
3086 (let* ((cur (car kill-ring)))
3087 (kill-new (if before-p (concat string cur) (concat cur string))
3088 (or (= (length cur) 0)
3089 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3090 yank-handler)))
3091 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3093 (defcustom yank-pop-change-selection nil
3094 "If non-nil, rotating the kill ring changes the window system selection."
3095 :type 'boolean
3096 :group 'killing
3097 :version "23.1")
3099 (defun current-kill (n &optional do-not-move)
3100 "Rotate the yanking point by N places, and then return that kill.
3101 If N is zero and `interprogram-paste-function' is set to a
3102 function that returns a string or a list of strings, and if that
3103 function doesn't return nil, then that string (or list) is added
3104 to the front of the kill ring and the string (or first string in
3105 the list) is returned as the latest kill.
3107 If N is not zero, and if `yank-pop-change-selection' is
3108 non-nil, use `interprogram-cut-function' to transfer the
3109 kill at the new yank point into the window system selection.
3111 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3112 move the yanking point; just return the Nth kill forward."
3114 (let ((interprogram-paste (and (= n 0)
3115 interprogram-paste-function
3116 (funcall interprogram-paste-function))))
3117 (if interprogram-paste
3118 (progn
3119 ;; Disable the interprogram cut function when we add the new
3120 ;; text to the kill ring, so Emacs doesn't try to own the
3121 ;; selection, with identical text.
3122 (let ((interprogram-cut-function nil))
3123 (if (listp interprogram-paste)
3124 (mapc 'kill-new (nreverse interprogram-paste))
3125 (kill-new interprogram-paste)))
3126 (car kill-ring))
3127 (or kill-ring (error "Kill ring is empty"))
3128 (let ((ARGth-kill-element
3129 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3130 (length kill-ring))
3131 kill-ring)))
3132 (unless do-not-move
3133 (setq kill-ring-yank-pointer ARGth-kill-element)
3134 (when (and yank-pop-change-selection
3135 (> n 0)
3136 interprogram-cut-function)
3137 (funcall interprogram-cut-function (car ARGth-kill-element))))
3138 (car ARGth-kill-element)))))
3142 ;;;; Commands for manipulating the kill ring.
3144 (defcustom kill-read-only-ok nil
3145 "Non-nil means don't signal an error for killing read-only text."
3146 :type 'boolean
3147 :group 'killing)
3149 (put 'text-read-only 'error-conditions
3150 '(text-read-only buffer-read-only error))
3151 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3153 (defun kill-region (beg end &optional yank-handler)
3155 This deletes the text from the buffer and saves it in the kill ring.
3159 If you want to append the killed region to the last killed text,
3162 If the buffer is read-only, Emacs will beep and refrain from deleting
3163 the text, but put the text in the kill ring anyway. This means that
3164 you can use the killing commands to copy text from a read-only buffer.
3166 Lisp programs should use this function for killing text.
3167 (To delete text, use `delete-region'.)
3168 Supply two arguments, character positions indicating the stretch of text
3169 to be killed.
3171 If the previous command was also a kill command,
3172 the text killed this time appends to the text killed last time
3173 to make one entry in the kill ring."
3174 ;; Pass point first, then mark, because the order matters
3175 ;; when calling kill-append.
3176 (interactive (list (point) (mark)))
3177 (unless (and beg end)
3178 (error "The mark is not set now, so there is no region"))
3179 (condition-case nil
3180 (let ((string (filter-buffer-substring beg end t)))
3181 (when string ;STRING is nil if BEG = END
3182 ;; Add that string to the kill ring, one way or another.
3183 (if (eq last-command 'kill-region)
3184 (kill-append string (< end beg) yank-handler)
3185 (kill-new string nil yank-handler)))
3186 (when (or string (eq last-command 'kill-region))
3187 (setq this-command 'kill-region))
3188 nil)
3189 ((buffer-read-only text-read-only)
3190 ;; The code above failed because the buffer, or some of the characters
3191 ;; in the region, are read-only.
3192 ;; We should beep, in case the user just isn't aware of this.
3193 ;; However, there's no harm in putting
3194 ;; the region's text in the kill ring, anyway.
3195 (copy-region-as-kill beg end)
3196 ;; Set this-command now, so it will be set even if we get an error.
3197 (setq this-command 'kill-region)
3198 ;; This should barf, if appropriate, and give us the correct error.
3199 (if kill-read-only-ok
3200 (progn (message "Read only text copied to kill ring") nil)
3201 ;; Signal an error if the buffer is read-only.
3202 (barf-if-buffer-read-only)
3203 ;; If the buffer isn't read-only, the text is.
3204 (signal 'text-read-only (list (current-buffer)))))))
3205 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3207 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3208 ;; to get two copies of the text when the user accidentally types M-w and
3209 ;; then corrects it with the intended C-w.
3210 (defun copy-region-as-kill (beg end)
3211 "Save the region as if killed, but don't kill it.
3212 In Transient Mark mode, deactivate the mark.
3213 If `interprogram-cut-function' is non-nil, also save the text for a window
3214 system cut and paste.
3216 This command's old key binding has been given to `kill-ring-save'."
3217 (interactive "r")
3218 (if (eq last-command 'kill-region)
3219 (kill-append (filter-buffer-substring beg end) (< end beg))
3220 (kill-new (filter-buffer-substring beg end)))
3221 (setq deactivate-mark t)
3222 nil)
3224 (defun kill-ring-save (beg end)
3225 "Save the region as if killed, but don't kill it.
3226 In Transient Mark mode, deactivate the mark.
3227 If `interprogram-cut-function' is non-nil, also save the text for a window
3228 system cut and paste.
3230 If you want to append the killed line to the last killed text,
3233 This command is similar to `copy-region-as-kill', except that it gives
3234 visual feedback indicating the extent of the region being copied."
3235 (interactive "r")
3236 (copy-region-as-kill beg end)
3237 ;; This use of called-interactively-p is correct
3238 ;; because the code it controls just gives the user visual feedback.
3239 (if (called-interactively-p 'interactive)
3240 (let ((other-end (if (= (point) beg) end beg))
3241 (opoint (point))
3242 ;; Inhibit quitting so we can make a quit here
3243 ;; look like a C-g typed as a command.
3244 (inhibit-quit t))
3245 (if (pos-visible-in-window-p other-end (selected-window))
3246 ;; Swap point-and-mark quickly so as to show the region that
3247 ;; was selected. Don't do it if the region is highlighted.
3248 (unless (and (region-active-p)
3249 (face-background 'region))
3250 ;; Swap point and mark.
3251 (set-marker (mark-marker) (point) (current-buffer))
3252 (goto-char other-end)
3253 (sit-for blink-matching-delay)
3254 ;; Swap back.
3255 (set-marker (mark-marker) other-end (current-buffer))
3256 (goto-char opoint)
3257 ;; If user quit, deactivate the mark
3258 ;; as C-g would as a command.
3259 (and quit-flag mark-active
3260 (deactivate-mark)))
3261 (let* ((killed-text (current-kill 0))
3262 (message-len (min (length killed-text) 40)))
3263 (if (= (point) beg)
3264 ;; Don't say "killed"; that is misleading.
3266 (substring killed-text (- message-len)))
3268 (substring killed-text 0 message-len))))))))
3270 (defun append-next-kill (&optional interactive)
3271 "Cause following command, if it kills, to append to previous kill.
3272 The argument is used for internal purposes; do not supply one."
3273 (interactive "p")
3274 ;; We don't use (interactive-p), since that breaks kbd macros.
3275 (if interactive
3276 (progn
3277 (setq this-command 'kill-region)
3278 (message "If the next command is a kill, it will append"))
3279 (setq last-command 'kill-region)))
3280 \f
3281 ;; Yanking.
3283 ;; This is actually used in subr.el but defcustom does not work there.
3284 (defcustom yank-excluded-properties
3285 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3286 yank-handler follow-link fontified)
3287 "Text properties to discard when yanking.
3288 The value should be a list of text properties to discard or t,
3289 which means to discard all text properties."
3290 :type '(choice (const :tag "All" t) (repeat symbol))
3291 :group 'killing
3292 :version "22.1")
3294 (defvar yank-window-start nil)
3295 (defvar yank-undo-function nil
3296 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3297 Function is called with two parameters, START and END corresponding to
3298 the value of the mark and point; it is guaranteed that START <= END.
3299 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3301 (defun yank-pop (&optional arg)
3302 "Replace just-yanked stretch of killed text with a different stretch.
3303 This command is allowed only immediately after a `yank' or a `yank-pop'.
3304 At such a time, the region contains a stretch of reinserted
3305 previously-killed text. `yank-pop' deletes that text and inserts in its
3306 place a different stretch of killed text.
3308 With no argument, the previous kill is inserted.
3309 With argument N, insert the Nth previous kill.
3310 If N is negative, this is a more recent kill.
3312 The sequence of kills wraps around, so that after the oldest one
3313 comes the newest one.
3315 When this command inserts killed text into the buffer, it honors
3316 `yank-excluded-properties' and `yank-handler' as described in the
3317 doc string for `insert-for-yank-1', which see."
3318 (interactive "*p")
3319 (if (not (eq last-command 'yank))
3320 (error "Previous command was not a yank"))
3321 (setq this-command 'yank)
3322 (unless arg (setq arg 1))
3323 (let ((inhibit-read-only t)
3324 (before (< (point) (mark t))))
3325 (if before
3326 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3327 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3328 (setq yank-undo-function nil)
3329 (set-marker (mark-marker) (point) (current-buffer))
3330 (insert-for-yank (current-kill arg))
3331 ;; Set the window start back where it was in the yank command,
3332 ;; if possible.
3333 (set-window-start (selected-window) yank-window-start t)
3334 (if before
3335 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3336 ;; It is cleaner to avoid activation, even though the command
3337 ;; loop would deactivate the mark because we inserted text.
3338 (goto-char (prog1 (mark t)
3339 (set-marker (mark-marker) (point) (current-buffer))))))
3340 nil)
3342 (defun yank (&optional arg)
3344 More precisely, reinsert the stretch of killed text most recently
3345 killed OR yanked. Put point at end, and set mark at beginning.
3346 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3347 With argument N, reinsert the Nth most recently killed stretch of killed
3348 text.
3350 When this command inserts killed text into the buffer, it honors
3351 `yank-excluded-properties' and `yank-handler' as described in the
3352 doc string for `insert-for-yank-1', which see.
3355 (interactive "*P")
3356 (setq yank-window-start (window-start))
3357 ;; If we don't get all the way thru, make last-command indicate that
3358 ;; for the following command.
3359 (setq this-command t)
3360 (push-mark (point))
3361 (insert-for-yank (current-kill (cond
3362 ((listp arg) 0)
3363 ((eq arg '-) -2)
3364 (t (1- arg)))))
3365 (if (consp arg)
3366 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3367 ;; It is cleaner to avoid activation, even though the command
3368 ;; loop would deactivate the mark because we inserted text.
3369 (goto-char (prog1 (mark t)
3370 (set-marker (mark-marker) (point) (current-buffer)))))
3371 ;; If we do get all the way thru, make this-command indicate that.
3372 (if (eq this-command t)
3373 (setq this-command 'yank))
3374 nil)
3376 (defun rotate-yank-pointer (arg)
3377 "Rotate the yanking point in the kill ring.
3378 With ARG, rotate that many kills forward (or backward, if negative)."
3379 (interactive "p")
3380 (current-kill arg))
3381 \f
3382 ;; Some kill commands.
3384 ;; Internal subroutine of delete-char
3385 (defun kill-forward-chars (arg)
3386 (if (listp arg) (setq arg (car arg)))
3387 (if (eq arg '-) (setq arg -1))
3388 (kill-region (point) (+ (point) arg)))
3390 ;; Internal subroutine of backward-delete-char
3391 (defun kill-backward-chars (arg)
3392 (if (listp arg) (setq arg (car arg)))
3393 (if (eq arg '-) (setq arg -1))
3394 (kill-region (point) (- (point) arg)))
3396 (defcustom backward-delete-char-untabify-method 'untabify
3397 "The method for untabifying when deleting backward.
3398 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3399 `hungry' -- delete all whitespace, both tabs and spaces;
3400 `all' -- delete all whitespace, including tabs, spaces and newlines;
3401 nil -- just delete one character."
3402 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3403 :version "20.3"
3404 :group 'killing)
3406 (defun backward-delete-char-untabify (arg &optional killp)
3407 "Delete characters backward, changing tabs into spaces.
3408 The exact behavior depends on `backward-delete-char-untabify-method'.
3409 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3410 Interactively, ARG is the prefix arg (default 1)
3411 and KILLP is t if a prefix arg was specified."
3413 (when (eq backward-delete-char-untabify-method 'untabify)
3414 (let ((count arg))
3415 (save-excursion
3416 (while (and (> count 0) (not (bobp)))
3418 (let ((col (current-column)))
3419 (forward-char -1)
3420 (setq col (- col (current-column)))
3421 (insert-char ?\s col)
3422 (delete-char 1)))
3423 (forward-char -1)
3424 (setq count (1- count))))))
3426 ((eq backward-delete-char-untabify-method 'all)
3428 (n (if skip
3429 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3430 (point)))))
3431 (+ arg (if (zerop wh) 0 (1- wh))))
3432 arg)))
3433 ;; Avoid warning about delete-backward-char
3434 (with-no-warnings (delete-backward-char n killp))))
3436 (defun zap-to-char (arg char)
3437 "Kill up to and including ARGth occurrence of CHAR.
3438 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3439 Goes backward if ARG is negative; error if CHAR not found."
3441 ;; Avoid "obsolete" warnings for translation-table-for-input.
3442 (with-no-warnings
3443 (if (char-table-p translation-table-for-input)
3444 (setq char (or (aref translation-table-for-input char) char))))
3445 (kill-region (point) (progn
3446 (search-forward (char-to-string char) nil nil arg)
3447 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3448 (point))))
3450 ;; kill-line and its subroutines.
3452 (defcustom kill-whole-line nil
3453 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3454 :type 'boolean
3455 :group 'killing)
3457 (defun kill-line (&optional arg)
3458 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3459 With prefix argument ARG, kill that many lines from point.
3460 Negative arguments kill lines backward.
3461 With zero argument, kills the text before point on the current line.
3464 a number counts as a prefix arg.
3466 To kill a whole line, when point is not at the beginning, type \
3469 If `show-trailing-whitespace' is non-nil, this command will just
3470 kill the rest of the current line, even if there are only
3471 nonblanks there.
3473 If `kill-whole-line' is non-nil, then this command kills the whole line
3474 including its terminating newline, when used at the beginning of a line
3475 with no argument. As a consequence, you can always kill a whole line
3478 If you want to append the killed line to the last killed text,
3481 If the buffer is read-only, Emacs will beep and refrain from deleting
3482 the line, but put the line in the kill ring anyway. This means that
3483 you can use this command to copy text from a read-only buffer.
3484 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3485 even beep.)"
3486 (interactive "P")
3487 (kill-region (point)
3488 ;; It is better to move point to the other end of the kill
3489 ;; before killing. That way, in a read-only buffer, point
3490 ;; moves across the text that is copied to the kill ring.
3491 ;; The choice has no effect on undo now that undo records
3492 ;; the value of point from before the command was run.
3493 (progn
3494 (if arg
3495 (forward-visible-line (prefix-numeric-value arg))
3496 (if (eobp)
3497 (signal 'end-of-buffer nil))
3498 (let ((end
3499 (save-excursion
3500 (end-of-visible-line) (point))))
3501 (if (or (save-excursion
3502 ;; If trailing whitespace is visible,
3503 ;; don't treat it as nothing.
3504 (unless show-trailing-whitespace
3506 (= (point) end))
3507 (and kill-whole-line (bolp)))
3508 (forward-visible-line 1)
3509 (goto-char end))))
3510 (point))))
3512 (defun kill-whole-line (&optional arg)
3513 "Kill current line.
3514 With prefix ARG, kill that many lines starting from the current line.
3515 If ARG is negative, kill backward. Also kill the preceding newline.
3517 If ARG is zero, kill current line but exclude the trailing newline."
3518 (interactive "p")
3519 (or arg (setq arg 1))
3520 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3521 (signal 'end-of-buffer nil))
3522 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3523 (signal 'beginning-of-buffer nil))
3524 (unless (eq last-command 'kill-region)
3525 (kill-new "")
3526 (setq last-command 'kill-region))
3527 (cond ((zerop arg)
3528 ;; We need to kill in two steps, because the previous command
3529 ;; could have been a kill command, in which case the text
3530 ;; before point needs to be prepended to the current kill
3531 ;; ring entry and the text after point appended. Also, we
3532 ;; need to use save-excursion to avoid copying the same text
3533 ;; twice to the kill ring in read-only buffers.
3534 (save-excursion
3535 (kill-region (point) (progn (forward-visible-line 0) (point))))
3536 (kill-region (point) (progn (end-of-visible-line) (point))))
3537 ((< arg 0)
3538 (save-excursion
3539 (kill-region (point) (progn (end-of-visible-line) (point))))
3540 (kill-region (point)
3541 (progn (forward-visible-line (1+ arg))
3542 (unless (bobp) (backward-char))
3543 (point))))
3544 (t
3545 (save-excursion
3546 (kill-region (point) (progn (forward-visible-line 0) (point))))
3547 (kill-region (point)
3548 (progn (forward-visible-line arg) (point))))))
3550 (defun forward-visible-line (arg)
3551 "Move forward by ARG lines, ignoring currently invisible newlines only.
3552 If ARG is negative, move backward -ARG lines.
3553 If ARG is zero, move to the beginning of the current line."
3554 (condition-case nil
3555 (if (> arg 0)
3556 (progn
3557 (while (> arg 0)
3558 (or (zerop (forward-line 1))
3559 (signal 'end-of-buffer nil))
3560 ;; If the newline we just skipped is invisible,
3561 ;; don't count it.
3562 (let ((prop
3563 (get-char-property (1- (point)) 'invisible)))
3564 (if (if (eq buffer-invisibility-spec t)
3565 prop
3566 (or (memq prop buffer-invisibility-spec)
3567 (assq prop buffer-invisibility-spec)))
3568 (setq arg (1+ arg))))
3569 (setq arg (1- arg)))
3570 ;; If invisible text follows, and it is a number of complete lines,
3571 ;; skip it.
3572 (let ((opoint (point)))
3573 (while (and (not (eobp))
3574 (let ((prop
3575 (get-char-property (point) 'invisible)))
3576 (if (eq buffer-invisibility-spec t)
3577 prop
3578 (or (memq prop buffer-invisibility-spec)
3579 (assq prop buffer-invisibility-spec)))))
3580 (goto-char
3581 (if (get-text-property (point) 'invisible)
3582 (or (next-single-property-change (point) 'invisible)
3583 (point-max))
3584 (next-overlay-change (point)))))
3585 (unless (bolp)
3586 (goto-char opoint))))
3587 (let ((first t))
3588 (while (or first (<= arg 0))
3589 (if first
3590 (beginning-of-line)
3591 (or (zerop (forward-line -1))
3592 (signal 'beginning-of-buffer nil)))
3593 ;; If the newline we just moved to is invisible,
3594 ;; don't count it.
3595 (unless (bobp)
3596 (let ((prop
3597 (get-char-property (1- (point)) 'invisible)))
3598 (unless (if (eq buffer-invisibility-spec t)
3599 prop
3600 (or (memq prop buffer-invisibility-spec)
3601 (assq prop buffer-invisibility-spec)))
3602 (setq arg (1+ arg)))))
3603 (setq first nil))
3604 ;; If invisible text follows, and it is a number of complete lines,
3605 ;; skip it.
3606 (let ((opoint (point)))
3607 (while (and (not (bobp))
3608 (let ((prop
3609 (get-char-property (1- (point)) 'invisible)))
3610 (if (eq buffer-invisibility-spec t)
3611 prop
3612 (or (memq prop buffer-invisibility-spec)
3613 (assq prop buffer-invisibility-spec)))))
3614 (goto-char
3615 (if (get-text-property (1- (point)) 'invisible)
3616 (or (previous-single-property-change (point) 'invisible)
3617 (point-min))
3618 (previous-overlay-change (point)))))
3619 (unless (bolp)
3620 (goto-char opoint)))))
3621 ((beginning-of-buffer end-of-buffer)
3622 nil)))
3624 (defun end-of-visible-line ()
3625 "Move to end of current visible line."
3626 (end-of-line)
3627 ;; If the following character is currently invisible,
3628 ;; skip all characters with that same `invisible' property value,
3629 ;; then find the next newline.
3630 (while (and (not (eobp))
3631 (save-excursion
3633 (let ((prop
3634 (get-char-property (point) 'invisible)))
3635 (if (eq buffer-invisibility-spec t)
3636 prop
3637 (or (memq prop buffer-invisibility-spec)
3638 (assq prop buffer-invisibility-spec))))))
3640 (if (get-text-property (point) 'invisible)
3641 (goto-char (next-single-property-change (point) 'invisible))
3642 (goto-char (next-overlay-change (point))))
3643 (end-of-line)))
3644 \f
3645 (defun insert-buffer (buffer)
3646 "Insert after point the contents of BUFFER.
3647 Puts mark after the inserted text.
3648 BUFFER may be a buffer or a buffer name.
3650 This function is meant for the user to run interactively.
3651 Don't call it from programs: use `insert-buffer-substring' instead!"
3652 (interactive
3653 (list
3654 (progn
3655 (barf-if-buffer-read-only)
3656 (read-buffer "Insert buffer: "
3657 (if (eq (selected-window) (next-window (selected-window)))
3658 (other-buffer (current-buffer))
3659 (window-buffer (next-window (selected-window))))
3660 t))))
3661 (push-mark
3662 (save-excursion
3663 (insert-buffer-substring (get-buffer buffer))
3664 (point)))
3665 nil)
3667 (defun append-to-buffer (buffer start end)
3668 "Append to specified buffer the text of the region.
3669 It is inserted into that buffer before its point.
3671 When calling from a program, give three arguments:
3672 BUFFER (or buffer name), START and END.
3673 START and END specify the portion of the current buffer to be copied."
3674 (interactive
3675 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3676 (region-beginning) (region-end)))
3677 (let* ((oldbuf (current-buffer))
3678 (append-to (get-buffer-create buffer))
3679 (windows (get-buffer-window-list append-to t t))
3680 point)
3681 (save-excursion
3682 (with-current-buffer append-to
3683 (setq point (point))
3684 (barf-if-buffer-read-only)
3685 (insert-buffer-substring oldbuf start end)
3686 (dolist (window windows)
3687 (when (= (window-point window) point)
3688 (set-window-point window (point))))))))
3690 (defun prepend-to-buffer (buffer start end)
3691 "Prepend to specified buffer the text of the region.
3692 It is inserted into that buffer after its point.
3694 When calling from a program, give three arguments:
3695 BUFFER (or buffer name), START and END.
3696 START and END specify the portion of the current buffer to be copied."
3698 (let ((oldbuf (current-buffer)))
3699 (with-current-buffer (get-buffer-create buffer)
3700 (barf-if-buffer-read-only)
3701 (save-excursion
3702 (insert-buffer-substring oldbuf start end)))))
3704 (defun copy-to-buffer (buffer start end)
3705 "Copy to specified buffer the text of the region.
3706 It is inserted into that buffer, replacing existing text there.
3708 When calling from a program, give three arguments:
3709 BUFFER (or buffer name), START and END.
3710 START and END specify the portion of the current buffer to be copied."
3712 (let ((oldbuf (current-buffer)))
3713 (with-current-buffer (get-buffer-create buffer)
3714 (barf-if-buffer-read-only)
3715 (erase-buffer)
3716 (save-excursion
3717 (insert-buffer-substring oldbuf start end)))))
3718 \f
3719 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3720 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3722 (defvar activate-mark-hook nil
3723 "Hook run when the mark becomes active.
3724 It is also run at the end of a command, if the mark is active and
3725 it is possible that the region may have changed.")
3727 (defvar deactivate-mark-hook nil
3728 "Hook run when the mark becomes inactive.")
3730 (defun mark (&optional force)
3731 "Return this buffer's mark value as integer, or nil if never set.
3733 In Transient Mark mode, this function signals an error if
3734 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3735 or the argument FORCE is non-nil, it disregards whether the mark
3736 is active, and returns an integer or nil in the usual way.
3738 If you are using this in an editing command, you are most likely making
3739 a mistake; see the documentation of `set-mark'."
3740 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3741 (marker-position (mark-marker))
3742 (signal 'mark-inactive nil)))
3744 (defsubst deactivate-mark (&optional force)
3745 "Deactivate the mark by setting `mark-active' to nil.
3746 Unless FORCE is non-nil, this function does nothing if Transient
3747 Mark mode is disabled.
3748 This function also runs `deactivate-mark-hook'."
3749 (when (or transient-mark-mode force)
3750 (when (and (if (eq select-active-regions 'only)
3751 (eq (car-safe transient-mark-mode) 'only)
3752 select-active-regions)
3753 (region-active-p)
3754 (display-selections-p))
3755 ;; The var `saved-region-selection', if non-nil, is the text in
3756 ;; the region prior to the last command modifying the buffer.
3757 ;; Set the selection to that, or to the current region.
3758 (cond (saved-region-selection
3759 (x-set-selection 'PRIMARY saved-region-selection)
3760 (setq saved-region-selection nil))
3761 ((/= (region-beginning) (region-end))
3762 (x-set-selection 'PRIMARY
3763 (buffer-substring-no-properties
3764 (region-beginning)
3765 (region-end))))))
3766 (if (and (null force)
3767 (or (eq transient-mark-mode 'lambda)
3768 (and (eq (car-safe transient-mark-mode) 'only)
3769 (null (cdr transient-mark-mode)))))
3770 ;; When deactivating a temporary region, don't change
3771 ;; `mark-active' or run `deactivate-mark-hook'.
3772 (setq transient-mark-mode nil)
3773 (if (eq (car-safe transient-mark-mode) 'only)
3774 (setq transient-mark-mode (cdr transient-mark-mode)))
3775 (setq mark-active nil)
3776 (run-hooks 'deactivate-mark-hook))))
3778 (defun activate-mark ()
3779 "Activate the mark."
3780 (when (mark t)
3781 (setq mark-active t)
3782 (unless transient-mark-mode
3783 (setq transient-mark-mode 'lambda))))
3785 (defun set-mark (pos)
3786 "Set this buffer's mark to POS. Don't use this function!
3787 That is to say, don't use this function unless you want
3788 the user to see that the mark has moved, and you want the previous
3789 mark position to be lost.
3791 Normally, when a new mark is set, the old one should go on the stack.
3792 This is why most applications should use `push-mark', not `set-mark'.
3794 Novice Emacs Lisp programmers often try to use the mark for the wrong
3795 purposes. The mark saves a location for the user's convenience.
3796 Most editing commands should not alter the mark.
3797 To remember a location for internal use in the Lisp program,
3798 store it in a Lisp variable. Example:
3800 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3802 (if pos
3803 (progn
3804 (setq mark-active t)
3805 (run-hooks 'activate-mark-hook)
3806 (set-marker (mark-marker) pos (current-buffer)))
3807 ;; Normally we never clear mark-active except in Transient Mark mode.
3808 ;; But when we actually clear out the mark value too, we must
3809 ;; clear mark-active in any mode.
3810 (deactivate-mark t)
3811 (set-marker (mark-marker) nil)))
3813 (defcustom use-empty-active-region nil
3815 If nil, region-aware commands treat empty regions as inactive.
3816 If non-nil, region-aware commands treat the region as active as
3817 long as the mark is active, even if the region is empty.
3819 Region-aware commands are those that act on the region if it is
3820 active and Transient Mark mode is enabled, and on the text near
3821 point otherwise."
3822 :type 'boolean
3823 :version "23.1"
3824 :group 'editing-basics)
3826 (defun use-region-p ()
3827 "Return t if the region is active and it is appropriate to act on it.
3828 This is used by commands that act specially on the region under
3829 Transient Mark mode.
3831 The return value is t if Transient Mark mode is enabled and the
3832 mark is active; furthermore, if `use-empty-active-region' is nil,
3833 the region must not be empty. Otherwise, the return value is nil.
3835 For some commands, it may be appropriate to ignore the value of
3836 `use-empty-active-region'; in that case, use `region-active-p'."
3837 (and (region-active-p)
3838 (or use-empty-active-region (> (region-end) (region-beginning)))))
3840 (defun region-active-p ()
3841 "Return t if Transient Mark mode is enabled and the mark is active.
3843 Some commands act specially on the region when Transient Mark
3844 mode is enabled. Usually, such commands should use
3845 `use-region-p' instead of this function, because `use-region-p'
3846 also checks the value of `use-empty-active-region'."
3847 (and transient-mark-mode mark-active))
3849 (defvar mark-ring nil
3850 "The list of former marks of the current buffer, most recent first.")
3851 (make-variable-buffer-local 'mark-ring)
3852 (put 'mark-ring 'permanent-local t)
3854 (defcustom mark-ring-max 16
3855 "Maximum size of mark ring. Start discarding off end if gets this big."
3856 :type 'integer
3857 :group 'editing-basics)
3859 (defvar global-mark-ring nil
3860 "The list of saved global marks, most recent first.")
3862 (defcustom global-mark-ring-max 16
3863 "Maximum size of global mark ring. \
3864 Start discarding off end if gets this big."
3865 :type 'integer
3866 :group 'editing-basics)
3868 (defun pop-to-mark-command ()
3869 "Jump to mark, and pop a new position for mark off the ring.
3870 \(Does not affect global mark ring\)."
3871 (interactive)
3872 (if (null (mark t))
3873 (error "No mark set in this buffer")
3874 (if (= (point) (mark t))
3875 (message "Mark popped"))
3876 (goto-char (mark t))
3877 (pop-mark)))
3879 (defun push-mark-command (arg &optional nomsg)
3880 "Set mark at where point is.
3881 If no prefix ARG and mark is already set there, just activate it.
3882 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3883 (interactive "P")
3884 (let ((mark (marker-position (mark-marker))))
3885 (if (or arg (null mark) (/= mark (point)))
3886 (push-mark nil nomsg t)
3887 (setq mark-active t)
3888 (run-hooks 'activate-mark-hook)
3889 (unless nomsg
3890 (message "Mark activated")))))
3892 (defcustom set-mark-command-repeat-pop nil
3895 will pop the mark twice, and
3897 will pop the mark three times.
3901 :type 'boolean
3902 :group 'editing-basics)
3904 (defcustom set-mark-default-inactive nil
3905 "If non-nil, setting the mark does not activate it.
3907 behave the same whether or not `transient-mark-mode' is enabled."
3908 :type 'boolean
3909 :group 'editing-basics
3910 :version "23.1")
3912 (defun set-mark-command (arg)
3913 "Set the mark where point is, or jump to the mark.
3914 Setting the mark also alters the region, which is the text
3915 between point and mark; this is the closest equivalent in
3918 With no prefix argument, set the mark at point, and push the
3919 old mark position on local mark ring. Also push the old mark on
3920 global mark ring, if the previous mark was set in another buffer.
3922 When Transient Mark Mode is off, immediately repeating this
3923 command activates `transient-mark-mode' temporarily.
3926 jump to the mark, and set the mark from
3927 position popped off the local mark ring \(this does not affect the global
3929 mark ring \(see `pop-global-mark'\).
3931 If `set-mark-command-repeat-pop' is non-nil, repeating
3933 off the local (or global) mark ring and jumps there.
3936 argument, unconditionally set mark where point is, even if
3937 `set-mark-command-repeat-pop' is non-nil.
3939 Novice Emacs Lisp programmers often try to use the mark for the wrong
3940 purposes. See the documentation of `set-mark' for more information."
3941 (interactive "P")
3942 (cond ((eq transient-mark-mode 'lambda)
3943 (setq transient-mark-mode nil))
3944 ((eq (car-safe transient-mark-mode) 'only)
3945 (deactivate-mark)))
3946 (cond
3947 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3948 (push-mark-command nil))
3949 ((not (eq this-command 'set-mark-command))
3950 (if arg
3951 (pop-to-mark-command)
3952 (push-mark-command t)))
3953 ((and set-mark-command-repeat-pop
3954 (eq last-command 'pop-to-mark-command))
3955 (setq this-command 'pop-to-mark-command)
3956 (pop-to-mark-command))
3957 ((and set-mark-command-repeat-pop
3958 (eq last-command 'pop-global-mark)
3959 (not arg))
3960 (setq this-command 'pop-global-mark)
3961 (pop-global-mark))
3962 (arg
3963 (setq this-command 'pop-to-mark-command)
3964 (pop-to-mark-command))
3965 ((eq last-command 'set-mark-command)
3966 (if (region-active-p)
3967 (progn
3968 (deactivate-mark)
3969 (message "Mark deactivated"))
3970 (activate-mark)
3971 (message "Mark activated")))
3972 (t
3973 (push-mark-command nil)
3974 (if set-mark-default-inactive (deactivate-mark)))))
3976 (defun push-mark (&optional location nomsg activate)
3977 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3978 If the last global mark pushed was not in the current buffer,
3979 also push LOCATION on the global mark ring.
3980 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3982 Novice Emacs Lisp programmers often try to use the mark for the wrong
3983 purposes. See the documentation of `set-mark' for more information.
3985 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3986 (unless (null (mark t))
3987 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3988 (when (> (length mark-ring) mark-ring-max)
3989 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3990 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3991 (set-marker (mark-marker) (or location (point)) (current-buffer))
3992 ;; Now push the mark on the global mark ring.
3993 (if (and global-mark-ring
3994 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3995 ;; The last global mark pushed was in this same buffer.
3996 ;; Don't push another one.
3997 nil
3998 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3999 (when (> (length global-mark-ring) global-mark-ring-max)
4000 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4001 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4002 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4003 (message "Mark set"))
4004 (if (or activate (not transient-mark-mode))
4005 (set-mark (mark t)))
4006 nil)
4008 (defun pop-mark ()
4009 "Pop off mark ring into the buffer's actual mark.
4010 Does not set point. Does nothing if mark ring is empty."
4011 (when mark-ring
4012 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4013 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4014 (move-marker (car mark-ring) nil)
4015 (if (null (mark t)) (ding))
4016 (setq mark-ring (cdr mark-ring)))
4017 (deactivate-mark))
4019 (define-obsolete-function-alias
4020 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4021 (defun exchange-point-and-mark (&optional arg)
4022 "Put the mark where point is now, and point where the mark is now.
4023 This command works even when the mark is not active,
4024 and it reactivates the mark.
4026 If Transient Mark mode is on, a prefix ARG deactivates the mark
4027 if it is active, and otherwise avoids reactivating it. If
4028 Transient Mark mode is off, a prefix ARG enables Transient Mark
4029 mode temporarily."
4030 (interactive "P")
4031 (let ((omark (mark t))
4032 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4033 (if (null omark)
4034 (error "No mark set in this buffer"))
4035 (deactivate-mark)
4036 (set-mark (point))
4037 (goto-char omark)
4038 (if set-mark-default-inactive (deactivate-mark))
4039 (cond (temp-highlight
4040 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4041 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4042 (not (or arg (region-active-p))))
4043 (deactivate-mark))
4044 (t (activate-mark)))
4045 nil))
4047 (defcustom shift-select-mode t
4048 "When non-nil, shifted motion keys activate the mark momentarily.
4050 While the mark is activated in this way, any shift-translated point
4051 motion key extends the region, and if Transient Mark mode was off, it
4052 is temporarily turned on. Furthermore, the mark will be deactivated
4053 by any subsequent point motion key that was not shift-translated, or
4054 by any action that normally deactivates the mark in Transient Mark mode.
4056 See `this-command-keys-shift-translated' for the meaning of
4057 shift-translation."
4058 :type 'boolean
4059 :group 'editing-basics)
4061 (defun handle-shift-selection ()
4062 "Activate/deactivate mark depending on invocation thru shift translation.
4063 This function is called by `call-interactively' when a command
4064 with a `^' character in its `interactive' spec is invoked, before
4065 running the command itself.
4067 If `shift-select-mode' is enabled and the command was invoked
4068 through shift translation, set the mark and activate the region
4069 temporarily, unless it was already set in this way. See
4070 `this-command-keys-shift-translated' for the meaning of shift
4071 translation.
4073 Otherwise, if the region has been activated temporarily,
4074 deactivate it, and restore the variable `transient-mark-mode' to
4075 its earlier value."
4076 (cond ((and shift-select-mode this-command-keys-shift-translated)
4077 (unless (and mark-active
4078 (eq (car-safe transient-mark-mode) 'only))
4079 (setq transient-mark-mode
4080 (cons 'only
4081 (unless (eq transient-mark-mode 'lambda)
4082 transient-mark-mode)))
4083 (push-mark nil nil t)))
4084 ((eq (car-safe transient-mark-mode) 'only)
4085 (setq transient-mark-mode (cdr transient-mark-mode))
4086 (deactivate-mark))))
4088 (define-minor-mode transient-mark-mode
4089 "Toggle Transient Mark mode.
4090 With a prefix argument ARG, enable Transient Mark mode if ARG is
4091 positive, and disable it otherwise. If called from Lisp, enable
4092 Transient Mark mode if ARG is omitted or nil.
4094 Transient Mark mode is a global minor mode. When enabled, the
4095 region is highlighted whenever the mark is active. The mark is
4097 operations that set the mark but whose main purpose is something
4103 Many commands change their behavior when Transient Mark mode is in effect
4104 and the mark is active, by acting on the region instead of their usual
4105 default part of the buffer's text. Examples of such commands include
4110 commands which are sensitive to the Transient Mark mode."
4111 :global t
4112 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4113 :variable transient-mark-mode)
4115 (defvar widen-automatically t
4116 "Non-nil means it is ok for commands to call `widen' when they want to.
4117 Some commands will do this in order to go to positions outside
4118 the current accessible part of the buffer.
4120 If `widen-automatically' is nil, these commands will do something else
4121 as a fallback, and won't change the buffer bounds.")
4123 (defvar non-essential nil
4124 "Whether the currently executing code is performing an essential task.
4125 This variable should be non-nil only when running code which should not
4126 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4127 user for a password when we are simply scanning a set of files in the
4128 background or displaying possible completions before the user even asked
4129 for it.")
4131 (defun pop-global-mark ()
4132 "Pop off global mark ring and jump to the top location."
4133 (interactive)
4134 ;; Pop entries which refer to non-existent buffers.
4135 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4136 (setq global-mark-ring (cdr global-mark-ring)))
4137 (or global-mark-ring
4138 (error "No global mark set"))
4139 (let* ((marker (car global-mark-ring))
4140 (buffer (marker-buffer marker))
4141 (position (marker-position marker)))
4142 (setq global-mark-ring (nconc (cdr global-mark-ring)
4143 (list (car global-mark-ring))))
4144 (set-buffer buffer)
4145 (or (and (>= position (point-min))
4146 (<= position (point-max)))
4147 (if widen-automatically
4148 (widen)
4149 (error "Global mark position is outside accessible part of buffer")))
4150 (goto-char position)
4151 (switch-to-buffer buffer)))
4152 \f
4153 (defcustom next-line-add-newlines nil
4154 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4155 :type 'boolean
4156 :version "21.1"
4157 :group 'editing-basics)
4159 (defun next-line (&optional arg try-vscroll)
4160 "Move cursor vertically down ARG lines.
4161 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4162 If there is no character in the target line exactly under the current column,
4163 the cursor is positioned after the character in that line which spans this
4164 column, or at the end of the line if it is not long enough.
4165 If there is no line in the buffer after this one, behavior depends on the
4166 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4167 to create a line, and moves the cursor to that line. Otherwise it moves the
4168 cursor to the end of the buffer.
4170 If the variable `line-move-visual' is non-nil, this command moves
4171 by display lines. Otherwise, it moves by buffer lines, without
4172 taking variable-width characters or continued lines into account.
4175 a semipermanent goal column for this command.
4176 Then instead of trying to move exactly vertically (or as close as possible),
4177 this command moves to the specified goal column (or as close as possible).
4178 The goal column is stored in the variable `goal-column', which is nil
4179 when there is no goal column. Note that setting `goal-column'
4180 overrides `line-move-visual' and causes this command to move by buffer
4181 lines rather than by display lines.
4183 If you are thinking of using this in a Lisp program, consider
4184 using `forward-line' instead. It is usually easier to use
4185 and more reliable (no dependence on goal column, etc.)."
4187 (or arg (setq arg 1))
4188 (if (and next-line-add-newlines (= arg 1))
4189 (if (save-excursion (end-of-line) (eobp))
4190 ;; When adding a newline, don't expand an abbrev.
4191 (let ((abbrev-mode nil))
4192 (end-of-line)
4194 (line-move arg nil nil try-vscroll))
4195 (if (called-interactively-p 'interactive)
4196 (condition-case err
4197 (line-move arg nil nil try-vscroll)
4198 ((beginning-of-buffer end-of-buffer)
4199 (signal (car err) (cdr err))))
4200 (line-move arg nil nil try-vscroll)))
4201 nil)
4203 (defun previous-line (&optional arg try-vscroll)
4204 "Move cursor vertically up ARG lines.
4205 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4206 If there is no character in the target line exactly over the current column,
4207 the cursor is positioned after the character in that line which spans this
4208 column, or at the end of the line if it is not long enough.
4210 If the variable `line-move-visual' is non-nil, this command moves
4211 by display lines. Otherwise, it moves by buffer lines, without
4212 taking variable-width characters or continued lines into account.
4215 a semipermanent goal column for this command.
4216 Then instead of trying to move exactly vertically (or as close as possible),
4217 this command moves to the specified goal column (or as close as possible).
4218 The goal column is stored in the variable `goal-column', which is nil
4219 when there is no goal column. Note that setting `goal-column'
4220 overrides `line-move-visual' and causes this command to move by buffer
4221 lines rather than by display lines.
4223 If you are thinking of using this in a Lisp program, consider using
4224 `forward-line' with a negative argument instead. It is usually easier
4225 to use and more reliable (no dependence on goal column, etc.)."
4227 (or arg (setq arg 1))
4228 (if (called-interactively-p 'interactive)
4229 (condition-case err
4230 (line-move (- arg) nil nil try-vscroll)
4231 ((beginning-of-buffer end-of-buffer)
4232 (signal (car err) (cdr err))))
4233 (line-move (- arg) nil nil try-vscroll))
4234 nil)
4236 (defcustom track-eol nil
4237 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4238 This means moving to the end of each line moved onto.
4239 The beginning of a blank line does not count as the end of a line.
4240 This has no effect when `line-move-visual' is non-nil."
4241 :type 'boolean
4242 :group 'editing-basics)
4244 (defcustom goal-column nil
4246 A non-nil setting overrides `line-move-visual', which see."
4247 :type '(choice integer
4248 (const :tag "None" nil))
4249 :group 'editing-basics)
4250 (make-variable-buffer-local 'goal-column)
4252 (defvar temporary-goal-column 0
4253 "Current goal column for vertical motion.
4254 It is the column where point was at the start of the current run
4255 of vertical motion commands.
4257 When moving by visual lines via `line-move-visual', it is a cons
4258 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4259 divided by the default column width, and HSCROLL is the number of
4260 columns by which window is scrolled from left margin.
4262 When the `track-eol' feature is doing its job, the value is
4263 `most-positive-fixnum'.")
4265 (defcustom line-move-ignore-invisible t
4267 Outline mode sets this."
4268 :type 'boolean
4269 :group 'editing-basics)
4271 (defcustom line-move-visual t
4272 "When non-nil, `line-move' moves point by visual lines.
4273 This movement is based on where the cursor is displayed on the
4274 screen, instead of relying on buffer contents alone. It takes
4275 into account variable-width characters and line continuation.
4276 If nil, `line-move' moves point by logical lines.
4277 A non-nil setting of `goal-column' overrides the value of this variable
4278 and forces movement by logical lines.
4279 Disabling `auto-hscroll-mode' also overrides forces movement by logical
4280 lines when the window is horizontally scrolled."
4281 :type 'boolean
4282 :group 'editing-basics
4283 :version "23.1")
4285 ;; Returns non-nil if partial move was done.
4286 (defun line-move-partial (arg noerror to-end)
4287 (if (< arg 0)
4288 ;; Move backward (up).
4289 ;; If already vscrolled, reduce vscroll
4290 (let ((vs (window-vscroll nil t)))
4291 (when (> vs (frame-char-height))
4292 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4294 ;; Move forward (down).
4295 (let* ((lh (window-line-height -1))
4296 (vpos (nth 1 lh))
4297 (ypos (nth 2 lh))
4298 (rbot (nth 3 lh))
4299 py vs)
4300 (when (or (null lh)
4301 (>= rbot (frame-char-height))
4302 (<= ypos (- (frame-char-height))))
4303 (unless lh
4304 (let ((wend (pos-visible-in-window-p t nil t)))
4305 (setq rbot (nth 3 wend)
4306 vpos (nth 5 wend))))
4307 (cond
4308 ;; If last line of window is fully visible, move forward.
4309 ((or (null rbot) (= rbot 0))
4310 nil)
4311 ;; If cursor is not in the bottom scroll margin, move forward.
4312 ((and (> vpos 0)
4313 (< (setq py
4314 (or (nth 1 (window-line-height))
4315 (let ((ppos (posn-at-point)))
4316 (cdr (or (posn-actual-col-row ppos)
4317 (posn-col-row ppos))))))
4318 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4319 nil)
4320 ;; When already vscrolled, we vscroll some more if we can,
4321 ;; or clear vscroll and move forward at end of tall image.
4322 ((> (setq vs (window-vscroll nil t)) 0)
4323 (when (> rbot 0)
4324 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4325 ;; If cursor just entered the bottom scroll margin, move forward,
4326 ;; but also vscroll one line so redisplay wont recenter.
4327 ((and (> vpos 0)
4328 (= py (min (- (window-text-height) scroll-margin 1)
4329 (1- vpos))))
4330 (set-window-vscroll nil (frame-char-height) t)
4331 (line-move-1 arg noerror to-end)
4332 t)
4333 ;; If there are lines above the last line, scroll-up one line.
4334 ((> vpos 0)
4335 (scroll-up 1)
4336 t)
4337 ;; Finally, start vscroll.
4338 (t
4339 (set-window-vscroll nil (frame-char-height) t)))))))
4342 ;; This is like line-move-1 except that it also performs
4343 ;; vertical scrolling of tall images if appropriate.
4344 ;; That is not really a clean thing to do, since it mixes
4345 ;; scrolling with cursor motion. But so far we don't have
4346 ;; a cleaner solution to the problem of making C-n do something
4347 ;; useful given a tall image.
4348 (defun line-move (arg &optional noerror to-end try-vscroll)
4349 (unless (and auto-window-vscroll try-vscroll
4350 ;; Only vscroll for single line moves
4351 (= (abs arg) 1)
4352 ;; But don't vscroll in a keyboard macro.
4353 (not defining-kbd-macro)
4354 (not executing-kbd-macro)
4355 (line-move-partial arg noerror to-end))
4356 (set-window-vscroll nil 0 t)
4357 (if (and line-move-visual
4358 ;; Display-based column are incompatible with goal-column.
4359 (not goal-column)
4360 ;; When auto-hscroll-mode is turned off and the text in
4361 ;; the window is scrolled to the left, display-based
4362 ;; motion doesn't make sense (because each logical line
4363 ;; occupies exactly one screen line).
4364 (not (and (null auto-hscroll-mode)
4365 (> (window-hscroll) 0))))
4366 (line-move-visual arg noerror)
4367 (line-move-1 arg noerror to-end))))
4369 ;; Display-based alternative to line-move-1.
4370 ;; Arg says how many lines to move. The value is t if we can move the
4371 ;; specified number of lines.
4372 (defun line-move-visual (arg &optional noerror)
4373 (let ((opoint (point))
4374 (hscroll (window-hscroll))
4375 target-hscroll)
4376 ;; Check if the previous command was a line-motion command, or if
4377 ;; we were called from some other command.
4378 (if (and (consp temporary-goal-column)
4379 (memq last-command `(next-line previous-line ,this-command)))
4380 ;; If so, there's no need to reset `temporary-goal-column',
4381 ;; but we may need to hscroll.
4382 (if (or (/= (cdr temporary-goal-column) hscroll)
4383 (> (cdr temporary-goal-column) 0))
4384 (setq target-hscroll (cdr temporary-goal-column)))
4385 ;; Otherwise, we should reset `temporary-goal-column'.
4386 (let ((posn (posn-at-point)))
4387 (cond
4388 ;; Handle the `overflow-newline-into-fringe' case:
4389 ((eq (nth 1 posn) 'right-fringe)
4390 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4391 ((car (posn-x-y posn))
4392 (setq temporary-goal-column
4393 (cons (/ (float (car (posn-x-y posn)))
4394 (frame-char-width)) hscroll))))))
4395 (if target-hscroll
4396 (set-window-hscroll (selected-window) target-hscroll))
4397 (or (and (= (vertical-motion
4398 (cons (or goal-column
4399 (if (consp temporary-goal-column)
4400 (car temporary-goal-column)
4401 temporary-goal-column))
4402 arg))
4403 arg)
4404 (or (>= arg 0)
4405 (/= (point) opoint)
4406 ;; If the goal column lies on a display string,
4407 ;; `vertical-motion' advances the cursor to the end
4408 ;; of the string. For arg < 0, this can cause the
4409 ;; cursor to get stuck. (Bug#3020).
4410 (= (vertical-motion arg) arg)))
4411 (unless noerror
4412 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4413 nil)))))
4415 ;; This is the guts of next-line and previous-line.
4416 ;; Arg says how many lines to move.
4417 ;; The value is t if we can move the specified number of lines.
4418 (defun line-move-1 (arg &optional noerror _to-end)
4419 ;; Don't run any point-motion hooks, and disregard intangibility,
4420 ;; for intermediate positions.
4421 (let ((inhibit-point-motion-hooks t)
4422 (opoint (point))
4423 (orig-arg arg))
4424 (if (consp temporary-goal-column)
4425 (setq temporary-goal-column (+ (car temporary-goal-column)
4426 (cdr temporary-goal-column))))
4427 (unwind-protect
4428 (progn
4429 (if (not (memq last-command '(next-line previous-line)))
4430 (setq temporary-goal-column
4431 (if (and track-eol (eolp)
4432 ;; Don't count beg of empty line as end of line
4433 ;; unless we just did explicit end-of-line.
4434 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4435 most-positive-fixnum
4436 (current-column))))
4438 (if (not (or (integerp selective-display)
4439 line-move-ignore-invisible))
4440 ;; Use just newline characters.
4441 ;; Set ARG to 0 if we move as many lines as requested.
4442 (or (if (> arg 0)
4443 (progn (if (> arg 1) (forward-line (1- arg)))
4444 ;; This way of moving forward ARG lines
4445 ;; verifies that we have a newline after the last one.
4446 ;; It doesn't get confused by intangible text.
4447 (end-of-line)
4448 (if (zerop (forward-line 1))
4449 (setq arg 0)))
4450 (and (zerop (forward-line arg))
4451 (bolp)
4452 (setq arg 0)))
4453 (unless noerror
4454 (signal (if (< arg 0)
4455 'beginning-of-buffer
4456 'end-of-buffer)
4457 nil)))
4458 ;; Move by arg lines, but ignore invisible ones.
4459 (let (done)
4460 (while (and (> arg 0) (not done))
4461 ;; If the following character is currently invisible,
4462 ;; skip all characters with that same `invisible' property value.
4463 (while (and (not (eobp)) (invisible-p (point)))
4464 (goto-char (next-char-property-change (point))))
4465 ;; Move a line.
4466 ;; We don't use `end-of-line', since we want to escape
4467 ;; from field boundaries occurring exactly at point.
4468 (goto-char (constrain-to-field
4469 (let ((inhibit-field-text-motion t))
4470 (line-end-position))
4471 (point) t t
4472 'inhibit-line-move-field-capture))
4473 ;; If there's no invisibility here, move over the newline.
4474 (cond
4475 ((eobp)
4476 (if (not noerror)
4477 (signal 'end-of-buffer nil)
4478 (setq done t)))
4479 ((and (> arg 1) ;; Use vertical-motion for last move
4480 (not (integerp selective-display))
4481 (not (invisible-p (point))))
4482 ;; We avoid vertical-motion when possible
4483 ;; because that has to fontify.
4484 (forward-line 1))
4485 ;; Otherwise move a more sophisticated way.
4486 ((zerop (vertical-motion 1))
4487 (if (not noerror)
4488 (signal 'end-of-buffer nil)
4489 (setq done t))))
4490 (unless done
4491 (setq arg (1- arg))))
4492 ;; The logic of this is the same as the loop above,
4493 ;; it just goes in the other direction.
4494 (while (and (< arg 0) (not done))
4495 ;; For completely consistency with the forward-motion
4496 ;; case, we should call beginning-of-line here.
4497 ;; However, if point is inside a field and on a
4498 ;; continued line, the call to (vertical-motion -1)
4499 ;; below won't move us back far enough; then we return
4500 ;; to the same column in line-move-finish, and point
4501 ;; gets stuck -- cyd
4502 (forward-line 0)
4503 (cond
4504 ((bobp)
4505 (if (not noerror)
4506 (signal 'beginning-of-buffer nil)
4507 (setq done t)))
4508 ((and (< arg -1) ;; Use vertical-motion for last move
4509 (not (integerp selective-display))
4510 (not (invisible-p (1- (point)))))
4511 (forward-line -1))
4512 ((zerop (vertical-motion -1))
4513 (if (not noerror)
4514 (signal 'beginning-of-buffer nil)
4515 (setq done t))))
4516 (unless done
4517 (setq arg (1+ arg))
4518 (while (and ;; Don't move over previous invis lines
4519 ;; if our target is the middle of this line.
4520 (or (zerop (or goal-column temporary-goal-column))
4521 (< arg 0))
4522 (not (bobp)) (invisible-p (1- (point))))
4523 (goto-char (previous-char-property-change (point))))))))
4524 ;; This is the value the function returns.
4525 (= arg 0))
4527 (cond ((> arg 0)
4528 ;; If we did not move down as far as desired, at least go
4529 ;; to end of line. Be sure to call point-entered and
4530 ;; point-left-hooks.
4531 (let* ((npoint (prog1 (line-end-position)
4532 (goto-char opoint)))
4533 (inhibit-point-motion-hooks nil))
4534 (goto-char npoint)))
4535 ((< arg 0)
4536 ;; If we did not move up as far as desired,
4537 ;; at least go to beginning of line.
4538 (let* ((npoint (prog1 (line-beginning-position)
4539 (goto-char opoint)))
4540 (inhibit-point-motion-hooks nil))
4541 (goto-char npoint)))
4542 (t
4543 (line-move-finish (or goal-column temporary-goal-column)
4544 opoint (> orig-arg 0)))))))
4546 (defun line-move-finish (column opoint forward)
4547 (let ((repeat t))
4548 (while repeat
4549 ;; Set REPEAT to t to repeat the whole thing.
4550 (setq repeat nil)
4552 (let (new
4553 (old (point))
4554 (line-beg (line-beginning-position))
4555 (line-end
4556 ;; Compute the end of the line
4557 ;; ignoring effectively invisible newlines.
4558 (save-excursion
4559 ;; Like end-of-line but ignores fields.
4561 (while (and (not (eobp)) (invisible-p (point)))
4562 (goto-char (next-char-property-change (point)))
4564 (point))))
4566 ;; Move to the desired column.
4567 (line-move-to-column (truncate column))
4569 ;; Corner case: suppose we start out in a field boundary in
4570 ;; the middle of a continued line. When we get to
4571 ;; line-move-finish, point is at the start of a new *screen*
4572 ;; line but the same text line; then line-move-to-column would
4573 ;; move us backwards. Test using C-n with point on the "x" in
4574 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4575 (and forward
4576 (< (point) old)
4577 (goto-char old))
4579 (setq new (point))
4581 ;; Process intangibility within a line.
4582 ;; With inhibit-point-motion-hooks bound to nil, a call to
4583 ;; goto-char moves point past intangible text.
4585 ;; However, inhibit-point-motion-hooks controls both the
4586 ;; intangibility and the point-entered/point-left hooks. The
4587 ;; following hack avoids calling the point-* hooks
4588 ;; unnecessarily. Note that we move *forward* past intangible
4589 ;; text when the initial and final points are the same.
4590 (goto-char new)
4591 (let ((inhibit-point-motion-hooks nil))
4592 (goto-char new)
4594 ;; If intangibility moves us to a different (later) place
4595 ;; in the same line, use that as the destination.
4596 (if (<= (point) line-end)
4597 (setq new (point))
4598 ;; If that position is "too late",
4599 ;; try the previous allowable position.
4600 ;; See if it is ok.
4601 (backward-char)
4602 (if (if forward
4603 ;; If going forward, don't accept the previous
4604 ;; allowable position if it is before the target line.
4605 (< line-beg (point))
4606 ;; If going backward, don't accept the previous
4607 ;; allowable position if it is still after the target line.
4608 (<= (point) line-end))
4609 (setq new (point))
4610 ;; As a last resort, use the end of the line.
4611 (setq new line-end))))
4613 ;; Now move to the updated destination, processing fields
4614 ;; as well as intangibility.
4615 (goto-char opoint)
4616 (let ((inhibit-point-motion-hooks nil))
4617 (goto-char
4618 ;; Ignore field boundaries if the initial and final
4619 ;; positions have the same `field' property, even if the
4620 ;; fields are non-contiguous. This seems to be "nicer"
4621 ;; behavior in many situations.
4622 (if (eq (get-char-property new 'field)
4623 (get-char-property opoint 'field))
4624 new
4625 (constrain-to-field new opoint t t
4626 'inhibit-line-move-field-capture))))
4628 ;; If all this moved us to a different line,
4629 ;; retry everything within that new line.
4630 (when (or (< (point) line-beg) (> (point) line-end))
4631 ;; Repeat the intangibility and field processing.
4632 (setq repeat t))))))
4634 (defun line-move-to-column (col)
4635 "Try to find column COL, considering invisibility.
4636 This function works only in certain cases,
4637 because what we really need is for `move-to-column'
4638 and `current-column' to be able to ignore invisible text."
4639 (if (zerop col)
4640 (beginning-of-line)
4641 (move-to-column col))
4643 (when (and line-move-ignore-invisible
4644 (not (bolp)) (invisible-p (1- (point))))
4645 (let ((normal-location (point))
4646 (normal-column (current-column)))
4647 ;; If the following character is currently invisible,
4648 ;; skip all characters with that same `invisible' property value.
4649 (while (and (not (eobp))
4650 (invisible-p (point)))
4651 (goto-char (next-char-property-change (point))))
4652 ;; Have we advanced to a larger column position?
4653 (if (> (current-column) normal-column)
4654 ;; We have made some progress towards the desired column.
4655 ;; See if we can make any further progress.
4656 (line-move-to-column (+ (current-column) (- col normal-column)))
4657 ;; Otherwise, go to the place we originally found
4658 ;; and move back over invisible text.
4659 ;; that will get us to the same place on the screen
4660 ;; but with a more reasonable buffer position.
4661 (goto-char normal-location)
4662 (let ((line-beg (line-beginning-position)))
4663 (while (and (not (bolp)) (invisible-p (1- (point))))
4664 (goto-char (previous-char-property-change (point) line-beg))))))))
4666 (defun move-end-of-line (arg)
4667 "Move point to end of current line as displayed.
4668 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4669 If point reaches the beginning or end of buffer, it stops there.
4671 To ignore the effects of the `intangible' text or overlay
4672 property, bind `inhibit-point-motion-hooks' to t.
4673 If there is an image in the current line, this function
4674 disregards newlines that are part of the text on which the image
4675 rests."
4676 (interactive "^p")
4677 (or arg (setq arg 1))
4678 (let (done)
4679 (while (not done)
4680 (let ((newpos
4681 (save-excursion
4682 (let ((goal-column 0)
4683 (line-move-visual nil))
4684 (and (line-move arg t)
4685 ;; With bidi reordering, we may not be at bol,
4686 ;; so make sure we are.
4688 (not (bobp))
4689 (progn
4690 (while (and (not (bobp)) (invisible-p (1- (point))))
4691 (goto-char (previous-single-char-property-change
4692 (point) 'invisible)))
4693 (backward-char 1)))
4694 (point)))))
4695 (goto-char newpos)
4696 (if (and (> (point) newpos)
4698 (backward-char 1)
4699 (if (and (> (point) newpos) (not (eobp))
4701 ;; If we skipped something intangible and now we're not
4702 ;; really at eol, keep going.
4703 (setq arg 1)
4704 (setq done t)))))))
4706 (defun move-beginning-of-line (arg)
4707 "Move point to beginning of current line as displayed.
4708 \(If there's an image in the line, this disregards newlines
4709 which are part of the text that the image rests on.)
4711 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4712 If point reaches the beginning or end of buffer, it stops there.
4713 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4714 (interactive "^p")
4715 (or arg (setq arg 1))
4717 (let ((orig (point))
4718 first-vis first-vis-field-value)
4720 ;; Move by lines, if ARG is not 1 (the default).
4721 (if (/= arg 1)
4722 (let ((line-move-visual nil))
4723 (line-move (1- arg) t)))
4725 ;; Move to beginning-of-line, ignoring fields and invisibles.
4727 (while (and (not (bobp)) (invisible-p (1- (point))))
4728 (goto-char (previous-char-property-change (point)))
4731 ;; Now find first visible char in the line
4732 (while (and (not (eobp)) (invisible-p (point)))
4733 (goto-char (next-char-property-change (point))))
4734 (setq first-vis (point))
4736 ;; See if fields would stop us from reaching FIRST-VIS.
4737 (setq first-vis-field-value
4738 (constrain-to-field first-vis orig (/= arg 1) t nil))
4740 (goto-char (if (/= first-vis-field-value first-vis)
4741 ;; If yes, obey them.
4742 first-vis-field-value
4743 ;; Otherwise, move to START with attention to fields.
4744 ;; (It is possible that fields never matter in this case.)
4745 (constrain-to-field (point) orig
4746 (/= arg 1) t nil)))))
4749 ;; Many people have said they rarely use this feature, and often type
4750 ;; it by accident. Maybe it shouldn't even be on a key.
4751 (put 'set-goal-column 'disabled t)
4753 (defun set-goal-column (arg)
4755 Those commands will move to this position in the line moved to
4756 rather than trying to keep the same horizontal position.
4757 With a non-nil argument ARG, clears out the goal column
4759 The goal column is stored in the variable `goal-column'."
4760 (interactive "P")
4761 (if arg
4762 (progn
4763 (setq goal-column nil)
4764 (message "No goal column"))
4765 (setq goal-column (current-column))
4766 ;; The older method below can be erroneous if `set-goal-column' is bound
4767 ;; to a sequence containing %
4768 ;;(message (substitute-command-keys
4770 ;;goal-column)
4771 (message "%s"
4772 (concat
4773 (format "Goal column %d " goal-column)
4774 (substitute-command-keys
4777 )
4778 nil)
4779 \f
4780 ;;; Editing based on visual lines, as opposed to logical lines.
4782 (defun end-of-visual-line (&optional n)
4783 "Move point to end of current visual line.
4784 With argument N not nil or 1, move forward N - 1 visual lines first.
4785 If point reaches the beginning or end of buffer, it stops there.
4786 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4787 (interactive "^p")
4788 (or n (setq n 1))
4789 (if (/= n 1)
4790 (let ((line-move-visual t))
4791 (line-move (1- n) t)))
4792 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4793 ;; constrain to field boundaries, so we don't either.
4794 (vertical-motion (cons (window-width) 0)))
4796 (defun beginning-of-visual-line (&optional n)
4797 "Move point to beginning of current visual line.
4798 With argument N not nil or 1, move forward N - 1 visual lines first.
4799 If point reaches the beginning or end of buffer, it stops there.
4800 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4801 (interactive "^p")
4802 (or n (setq n 1))
4803 (let ((opoint (point)))
4804 (if (/= n 1)
4805 (let ((line-move-visual t))
4806 (line-move (1- n) t)))
4807 (vertical-motion 0)
4808 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4809 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4811 (defun kill-visual-line (&optional arg)
4812 "Kill the rest of the visual line.
4813 With prefix argument ARG, kill that many visual lines from point.
4814 If ARG is negative, kill visual lines backward.
4815 If ARG is zero, kill the text before point on the current visual
4816 line.
4818 If you want to append the killed line to the last killed text,
4821 If the buffer is read-only, Emacs will beep and refrain from deleting
4822 the line, but put the line in the kill ring anyway. This means that
4823 you can use this command to copy text from a read-only buffer.
4824 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4825 even beep.)"
4826 (interactive "P")
4827 ;; Like in `kill-line', it's better to move point to the other end
4828 ;; of the kill before killing.
4829 (let ((opoint (point))
4830 (kill-whole-line (and kill-whole-line (bolp))))
4831 (if arg
4832 (vertical-motion (prefix-numeric-value arg))
4833 (end-of-visual-line 1)
4834 (if (= (point) opoint)
4835 (vertical-motion 1)
4836 ;; Skip any trailing whitespace at the end of the visual line.
4837 ;; We used to do this only if `show-trailing-whitespace' is
4838 ;; nil, but that's wrong; the correct thing would be to check
4839 ;; whether the trailing whitespace is highlighted. But, it's
4840 ;; OK to just do this unconditionally.
4843 (1+ (point))
4844 (point)))))
4846 (defun next-logical-line (&optional arg try-vscroll)
4847 "Move cursor vertically down ARG lines.
4848 This is identical to `next-line', except that it always moves
4849 by logical lines instead of visual lines, ignoring the value of
4850 the variable `line-move-visual'."
4852 (let ((line-move-visual nil))
4853 (with-no-warnings
4854 (next-line arg try-vscroll))))
4856 (defun previous-logical-line (&optional arg try-vscroll)
4857 "Move cursor vertically up ARG lines.
4858 This is identical to `previous-line', except that it always moves
4859 by logical lines instead of visual lines, ignoring the value of
4860 the variable `line-move-visual'."
4862 (let ((line-move-visual nil))
4863 (with-no-warnings
4864 (previous-line arg try-vscroll))))
4866 (defgroup visual-line nil
4867 "Editing based on visual lines."
4868 :group 'convenience
4869 :version "23.1")
4871 (defvar visual-line-mode-map
4872 (let ((map (make-sparse-keymap)))
4873 (define-key map [remap kill-line] 'kill-visual-line)
4874 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4875 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4876 ;; These keybindings interfere with xterm function keys. Are
4877 ;; there any other suitable bindings?
4878 ;; (define-key map "\M-[" 'previous-logical-line)
4879 ;; (define-key map "\M-]" 'next-logical-line)
4880 map))
4882 (defcustom visual-line-fringe-indicators '(nil nil)
4883 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4884 The value should be a list of the form (LEFT RIGHT), where LEFT
4885 and RIGHT are symbols representing the bitmaps to display, to
4886 indicate wrapped lines, in the left and right fringes respectively.
4887 See also `fringe-indicator-alist'.
4888 The default is not to display fringe indicators for wrapped lines.
4889 This variable does not affect fringe indicators displayed for
4890 other purposes."
4891 :type '(list (choice (const :tag "Hide left indicator" nil)
4892 (const :tag "Left curly arrow" left-curly-arrow)
4893 (symbol :tag "Other bitmap"))
4894 (choice (const :tag "Hide right indicator" nil)
4895 (const :tag "Right curly arrow" right-curly-arrow)
4896 (symbol :tag "Other bitmap")))
4897 :set (lambda (symbol value)
4898 (dolist (buf (buffer-list))
4899 (with-current-buffer buf
4900 (when (and (boundp 'visual-line-mode)
4901 (symbol-value 'visual-line-mode))
4902 (setq fringe-indicator-alist
4903 (cons (cons 'continuation value)
4904 (assq-delete-all
4905 'continuation
4906 (copy-tree fringe-indicator-alist)))))))
4907 (set-default symbol value)))
4909 (defvar visual-line--saved-state nil)
4911 (define-minor-mode visual-line-mode
4912 "Toggle visual line based editing (Visual Line mode).
4913 With a prefix argument ARG, enable Visual Line mode if ARG is
4914 positive, and disable it otherwise. If called from Lisp, enable
4915 the mode if ARG is omitted or nil.
4917 When Visual Line mode is enabled, `word-wrap' is turned on in
4918 this buffer, and simple editing commands are redefined to act on
4919 visual lines, not logical lines. See Info node `Visual Line
4920 Mode' for details."
4921 :keymap visual-line-mode-map
4922 :group 'visual-line
4923 :lighter " Wrap"
4924 (if visual-line-mode
4925 (progn
4926 (set (make-local-variable 'visual-line--saved-state) nil)
4927 ;; Save the local values of some variables, to be restored if
4928 ;; visual-line-mode is turned off.
4929 (dolist (var '(line-move-visual truncate-lines
4930 truncate-partial-width-windows
4931 word-wrap fringe-indicator-alist))
4932 (if (local-variable-p var)
4933 (push (cons var (symbol-value var))
4934 visual-line--saved-state)))
4935 (set (make-local-variable 'line-move-visual) t)
4936 (set (make-local-variable 'truncate-partial-width-windows) nil)
4937 (setq truncate-lines nil
4938 word-wrap t
4939 fringe-indicator-alist
4940 (cons (cons 'continuation visual-line-fringe-indicators)
4941 fringe-indicator-alist)))
4942 (kill-local-variable 'line-move-visual)
4943 (kill-local-variable 'word-wrap)
4944 (kill-local-variable 'truncate-lines)
4945 (kill-local-variable 'truncate-partial-width-windows)
4946 (kill-local-variable 'fringe-indicator-alist)
4947 (dolist (saved visual-line--saved-state)
4948 (set (make-local-variable (car saved)) (cdr saved)))
4949 (kill-local-variable 'visual-line--saved-state)))
4951 (defun turn-on-visual-line-mode ()
4952 (visual-line-mode 1))
4954 (define-globalized-minor-mode global-visual-line-mode
4955 visual-line-mode turn-on-visual-line-mode
4956 :lighter " vl")
4958 \f
4959 (defun transpose-chars (arg)
4960 "Interchange characters around point, moving forward one character.
4961 With prefix arg ARG, effect is to take character before point
4962 and drag it forward past ARG other characters (backward if ARG negative).
4963 If no argument and at end of line, the previous two chars are exchanged."
4964 (interactive "*P")
4965 (and (null arg) (eolp) (forward-char -1))
4966 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4968 (defun transpose-words (arg)
4969 "Interchange words around point, leaving point at end of them.
4970 With prefix arg ARG, effect is to take word before or around point
4971 and drag it forward past ARG other words (backward if ARG negative).
4972 If ARG is zero, the words around or after point and around or after mark
4973 are interchanged."
4974 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4975 (interactive "*p")
4976 (transpose-subr 'forward-word arg))
4978 (defun transpose-sexps (arg)
4980 Does not work on a sexp that point is in the middle of
4981 if it is a list or string."
4982 (interactive "*p")
4983 (transpose-subr
4984 (lambda (arg)
4985 ;; Here we should try to simulate the behavior of
4986 ;; (cons (progn (forward-sexp x) (point))
4987 ;; (progn (forward-sexp (- x)) (point)))
4988 ;; Except that we don't want to rely on the second forward-sexp
4989 ;; putting us back to where we want to be, since forward-sexp-function
4990 ;; might do funny things like infix-precedence.
4991 (if (if (> arg 0)
4993 (and (not (bobp))
4995 ;; Jumping over a symbol. We might be inside it, mind you.
4996 (progn (funcall (if (> arg 0)
4997 'skip-syntax-backward 'skip-syntax-forward)
4998 "w_")
4999 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5000 ;; Otherwise, we're between sexps. Take a step back before jumping
5001 ;; to make sure we'll obey the same precedence no matter which direction
5002 ;; we're going.
5003 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5004 (cons (save-excursion (forward-sexp arg) (point))
5005 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5006 (not (zerop (funcall (if (> arg 0)
5007 'skip-syntax-forward
5008 'skip-syntax-backward)
5009 ".")))))
5010 (point)))))
5011 arg 'special))
5013 (defun transpose-lines (arg)
5014 "Exchange current line and previous line, leaving point after both.
5015 With argument ARG, takes previous line and moves it past ARG lines.
5016 With argument 0, interchanges line point is in with line mark is in."
5017 (interactive "*p")
5018 (transpose-subr (function
5019 (lambda (arg)
5020 (if (> arg 0)
5021 (progn
5022 ;; Move forward over ARG lines,
5023 ;; but create newlines if necessary.
5024 (setq arg (forward-line arg))
5026 (setq arg (1+ arg)))
5027 (if (> arg 0)
5028 (newline arg)))
5029 (forward-line arg))))
5030 arg))
5032 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5033 ;; which seems inconsistent with the ARG /= 0 case.
5034 ;; FIXME document SPECIAL.
5035 (defun transpose-subr (mover arg &optional special)
5036 "Subroutine to do the work of transposing objects.
5037 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5038 moves forward by units of the given object (e.g. forward-sentence,
5039 forward-paragraph). If ARG is zero, exchanges the current object
5040 with the one containing mark. If ARG is an integer, moves the
5041 current object past ARG following (if ARG is positive) or
5042 preceding (if ARG is negative) objects, leaving point after the
5043 current object."
5044 (let ((aux (if special mover
5045 (lambda (x)
5046 (cons (progn (funcall mover x) (point))
5047 (progn (funcall mover (- x)) (point))))))
5048 pos1 pos2)
5049 (cond
5050 ((= arg 0)
5051 (save-excursion
5052 (setq pos1 (funcall aux 1))
5053 (goto-char (or (mark) (error "No mark set in this buffer")))
5054 (setq pos2 (funcall aux 1))
5055 (transpose-subr-1 pos1 pos2))
5056 (exchange-point-and-mark))
5057 ((> arg 0)
5058 (setq pos1 (funcall aux -1))
5059 (setq pos2 (funcall aux arg))
5060 (transpose-subr-1 pos1 pos2)
5061 (goto-char (car pos2)))
5062 (t
5063 (setq pos1 (funcall aux -1))
5064 (goto-char (car pos1))
5065 (setq pos2 (funcall aux arg))
5066 (transpose-subr-1 pos1 pos2)))))
5068 (defun transpose-subr-1 (pos1 pos2)
5069 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5070 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5071 (when (> (car pos1) (car pos2))
5072 (let ((swap pos1))
5073 (setq pos1 pos2 pos2 swap)))
5074 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5075 (atomic-change-group
5076 (let (word2)
5077 ;; FIXME: We first delete the two pieces of text, so markers that
5078 ;; used to point to after the text end up pointing to before it :-(
5079 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5080 (goto-char (car pos2))
5081 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5082 (goto-char (car pos1))
5083 (insert word2))))
5084 \f
5085 (defun backward-word (&optional arg)
5086 "Move backward until encountering the beginning of a word.
5087 With argument ARG, do this that many times."
5088 (interactive "^p")
5089 (forward-word (- (or arg 1))))
5091 (defun mark-word (&optional arg allow-extend)
5092 "Set mark ARG words away from point.
5094 move to with the same argument.
5095 Interactively, if this command is repeated
5096 or (in Transient Mark mode) if the mark is active,
5097 it marks the next ARG words after the ones already marked."
5099 (cond ((and allow-extend
5100 (or (and (eq last-command this-command) (mark t))
5101 (region-active-p)))
5102 (setq arg (if arg (prefix-numeric-value arg)
5103 (if (< (mark) (point)) -1 1)))
5104 (set-mark
5105 (save-excursion
5106 (goto-char (mark))
5107 (forward-word arg)
5108 (point))))
5109 (t
5110 (push-mark
5111 (save-excursion
5112 (forward-word (prefix-numeric-value arg))
5113 (point))
5114 nil t))))
5116 (defun kill-word (arg)
5117 "Kill characters forward until encountering the end of a word.
5118 With argument ARG, do this that many times."
5119 (interactive "p")
5120 (kill-region (point) (progn (forward-word arg) (point))))
5122 (defun backward-kill-word (arg)
5123 "Kill characters backward until encountering the beginning of a word.
5124 With argument ARG, do this that many times."
5125 (interactive "p")
5126 (kill-word (- arg)))
5128 (defun current-word (&optional strict really-word)
5129 "Return the symbol or word that point is on (or a nearby one) as a string.
5130 The return value includes no text properties.
5131 If optional arg STRICT is non-nil, return nil unless point is within
5132 or adjacent to a symbol or word. In all cases the value can be nil
5133 if there is no word nearby.
5134 The function, belying its name, normally finds a symbol.
5135 If optional arg REALLY-WORD is non-nil, it finds just a word."
5136 (save-excursion
5137 (let* ((oldpoint (point)) (start (point)) (end (point))
5138 (syntaxes (if really-word "w" "w_"))
5139 (not-syntaxes (concat "^" syntaxes)))
5140 (skip-syntax-backward syntaxes) (setq start (point))
5141 (goto-char oldpoint)
5142 (skip-syntax-forward syntaxes) (setq end (point))
5143 (when (and (eq start oldpoint) (eq end oldpoint)
5144 ;; Point is neither within nor adjacent to a word.
5145 (not strict))
5146 ;; Look for preceding word in same line.
5147 (skip-syntax-backward not-syntaxes (line-beginning-position))
5148 (if (bolp)
5149 ;; No preceding word in same line.
5150 ;; Look for following word in same line.
5151 (progn
5152 (skip-syntax-forward not-syntaxes (line-end-position))
5153 (setq start (point))
5154 (skip-syntax-forward syntaxes)
5155 (setq end (point)))
5156 (setq end (point))
5157 (skip-syntax-backward syntaxes)
5158 (setq start (point))))
5159 ;; If we found something nonempty, return it as a string.
5160 (unless (= start end)
5161 (buffer-substring-no-properties start end)))))
5162 \f
5163 (defcustom fill-prefix nil
5164 "String for filling to insert at front of new line, or nil for none."
5165 :type '(choice (const :tag "None" nil)
5166 string)
5167 :group 'fill)
5168 (make-variable-buffer-local 'fill-prefix)
5169 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5171 (defcustom auto-fill-inhibit-regexp nil
5172 "Regexp to match lines which should not be auto-filled."
5173 :type '(choice (const :tag "None" nil)
5174 regexp)
5175 :group 'fill)
5177 (defun do-auto-fill ()
5178 "The default value for `normal-auto-fill-function'.
5179 This is the default auto-fill function, some major modes use a different one.
5180 Returns t if it really did any work."
5181 (let (fc justify give-up
5182 (fill-prefix fill-prefix))
5183 (if (or (not (setq justify (current-justification)))
5184 (null (setq fc (current-fill-column)))
5185 (and (eq justify 'left)
5186 (<= (current-column) fc))
5187 (and auto-fill-inhibit-regexp
5188 (save-excursion (beginning-of-line)
5189 (looking-at auto-fill-inhibit-regexp))))
5190 nil ;; Auto-filling not required
5191 (if (memq justify '(full center right))
5192 (save-excursion (unjustify-current-line)))
5194 ;; Choose a fill-prefix automatically.
5195 (when (and adaptive-fill-mode
5196 (or (null fill-prefix) (string= fill-prefix "")))
5197 (let ((prefix
5198 (fill-context-prefix
5199 (save-excursion (fill-forward-paragraph -1) (point))
5200 (save-excursion (fill-forward-paragraph 1) (point)))))
5201 (and prefix (not (equal prefix ""))
5202 ;; Use auto-indentation rather than a guessed empty prefix.
5203 (not (and fill-indent-according-to-mode
5205 (setq fill-prefix prefix))))
5207 (while (and (not give-up) (> (current-column) fc))
5208 ;; Determine where to split the line.
5209 (let* (after-prefix
5210 (fill-point
5211 (save-excursion
5212 (beginning-of-line)
5213 (setq after-prefix (point))
5214 (and fill-prefix
5215 (looking-at (regexp-quote fill-prefix))
5216 (setq after-prefix (match-end 0)))
5217 (move-to-column (1+ fc))
5218 (fill-move-to-break-point after-prefix)
5219 (point))))
5221 ;; See whether the place we found is any good.
5222 (if (save-excursion
5223 (goto-char fill-point)
5224 (or (bolp)
5225 ;; There is no use breaking at end of line.
5226 (save-excursion (skip-chars-forward " ") (eolp))
5227 ;; It is futile to split at the end of the prefix
5228 ;; since we would just insert the prefix again.
5229 (and after-prefix (<= (point) after-prefix))
5230 ;; Don't split right after a comment starter
5231 ;; since we would just make another comment starter.
5232 (and comment-start-skip
5233 (let ((limit (point)))
5234 (beginning-of-line)
5235 (and (re-search-forward comment-start-skip
5236 limit t)
5237 (eq (point) limit))))))
5238 ;; No good place to break => stop trying.
5239 (setq give-up t)
5240 ;; Ok, we have a useful place to break the line. Do it.
5241 (let ((prev-column (current-column)))
5242 ;; If point is at the fill-point, do not `save-excursion'.
5243 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5244 ;; point will end up before it rather than after it.
5245 (if (save-excursion
5247 (= (point) fill-point))
5248 (default-indent-new-line t)
5249 (save-excursion
5250 (goto-char fill-point)
5251 (default-indent-new-line t)))
5252 ;; Now do justification, if required
5253 (if (not (eq justify 'left))
5254 (save-excursion
5255 (end-of-line 0)
5256 (justify-current-line justify nil t)))
5257 ;; If making the new line didn't reduce the hpos of
5258 ;; the end of the line, then give up now;
5259 ;; trying again will not help.
5260 (if (>= (current-column) prev-column)
5261 (setq give-up t))))))
5262 ;; Justify last line.
5263 (justify-current-line justify t t)
5264 t)))
5266 (defvar comment-line-break-function 'comment-indent-new-line
5267 "*Mode-specific function which line breaks and continues a comment.
5268 This function is called during auto-filling when a comment syntax
5269 is defined.
5270 The function should take a single optional argument, which is a flag
5271 indicating whether it should use soft newlines.")
5273 (defun default-indent-new-line (&optional soft)
5274 "Break line at point and indent.
5275 If a comment syntax is defined, call `comment-indent-new-line'.
5277 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5278 unless optional argument SOFT is non-nil."
5279 (interactive)
5280 (if comment-start
5281 (funcall comment-line-break-function soft)
5282 ;; Insert the newline before removing empty space so that markers
5283 ;; get preserved better.
5285 (save-excursion (forward-char -1) (delete-horizontal-space))
5286 (delete-horizontal-space)
5288 (if (and fill-prefix (not adaptive-fill-mode))
5289 ;; Blindly trust a non-adaptive fill-prefix.
5290 (progn
5291 (indent-to-left-margin)
5292 (insert-before-markers-and-inherit fill-prefix))
5294 (cond
5295 ;; If there's an adaptive prefix, use it unless we're inside
5296 ;; a comment and the prefix is not a comment starter.
5297 (fill-prefix
5298 (indent-to-left-margin)
5299 (insert-and-inherit fill-prefix))
5300 ;; If we're not inside a comment, just try to indent.
5301 (t (indent-according-to-mode))))))
5303 (defvar normal-auto-fill-function 'do-auto-fill
5304 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5305 Some major modes set this.")
5307 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5308 ;; `functions' and `hooks' are usually unsafe to set, but setting
5309 ;; auto-fill-function to nil in a file-local setting is safe and
5310 ;; can be useful to prevent auto-filling.
5311 (put 'auto-fill-function 'safe-local-variable 'null)
5313 (define-minor-mode auto-fill-mode
5314 "Toggle automatic line breaking (Auto Fill mode).
5315 With a prefix argument ARG, enable Auto Fill mode if ARG is
5316 positive, and disable it otherwise. If called from Lisp, enable
5317 the mode if ARG is omitted or nil.
5319 When Auto Fill mode is enabled, inserting a space at a column
5320 beyond `current-fill-column' automatically breaks the line at a
5321 previous space.
5323 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5324 non-`nil'.
5326 The value of `normal-auto-fill-function' specifies the function to use
5327 for `auto-fill-function' when turning Auto Fill mode on."
5328 :variable (eq auto-fill-function normal-auto-fill-function))
5330 ;; This holds a document string used to document auto-fill-mode.
5331 (defun auto-fill-function ()
5332 "Automatically break line at a previous space, in insertion of text."
5333 nil)
5335 (defun turn-on-auto-fill ()
5336 "Unconditionally turn on Auto Fill mode."
5337 (auto-fill-mode 1))
5339 (defun turn-off-auto-fill ()
5340 "Unconditionally turn off Auto Fill mode."
5341 (auto-fill-mode -1))
5343 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5345 (defun set-fill-column (arg)
5346 "Set `fill-column' to specified argument.
5349 (interactive
5350 (list (or current-prefix-arg
5351 ;; We used to use current-column silently, but C-x f is too easily
5352 ;; typed as a typo for C-x C-f, so we turned it into an error and
5353 ;; now an interactive prompt.
5354 (read-number "Set fill-column to: " (current-column)))))
5355 (if (consp arg)
5356 (setq arg (current-column)))
5357 (if (not (integerp arg))
5358 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5359 (error "set-fill-column requires an explicit argument")
5360 (message "Fill column set to %d (was %d)" arg fill-column)
5361 (setq fill-column arg)))
5362 \f
5363 (defun set-selective-display (arg)
5364 "Set `selective-display' to ARG; clear it if no arg.
5365 When the value of `selective-display' is a number > 0,
5366 lines whose indentation is >= that value are not displayed.
5367 The variable `selective-display' has a separate value for each buffer."
5368 (interactive "P")
5369 (if (eq selective-display t)
5370 (error "selective-display already in use for marked lines"))
5371 (let ((current-vpos
5372 (save-restriction
5373 (narrow-to-region (point-min) (point))
5374 (goto-char (window-start))
5375 (vertical-motion (window-height)))))
5376 (setq selective-display
5377 (and arg (prefix-numeric-value arg)))
5378 (recenter current-vpos))
5379 (set-window-start (selected-window) (window-start (selected-window)))
5380 (princ "selective-display set to " t)
5381 (prin1 selective-display t)
5382 (princ "." t))
5384 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5386 (defun toggle-truncate-lines (&optional arg)
5387 "Toggle truncating of long lines for the current buffer.
5388 When truncating is off, long lines are folded.
5389 With prefix argument ARG, truncate long lines if ARG is positive,
5390 otherwise fold them. Note that in side-by-side windows, this
5391 command has no effect if `truncate-partial-width-windows' is
5392 non-nil."
5393 (interactive "P")
5394 (setq truncate-lines
5395 (if (null arg)
5396 (not truncate-lines)
5397 (> (prefix-numeric-value arg) 0)))
5398 (force-mode-line-update)
5399 (unless truncate-lines
5400 (let ((buffer (current-buffer)))
5401 (walk-windows (lambda (window)
5402 (if (eq buffer (window-buffer window))
5403 (set-window-hscroll window 0)))
5404 nil t)))
5405 (message "Truncate long lines %s"
5406 (if truncate-lines "enabled" "disabled")))
5408 (defun toggle-word-wrap (&optional arg)
5409 "Toggle whether to use word-wrapping for continuation lines.
5410 With prefix argument ARG, wrap continuation lines at word boundaries
5411 if ARG is positive, otherwise wrap them at the right screen edge.
5412 This command toggles the value of `word-wrap'. It has no effect
5413 if long lines are truncated."
5414 (interactive "P")
5415 (setq word-wrap
5416 (if (null arg)
5417 (not word-wrap)
5418 (> (prefix-numeric-value arg) 0)))
5419 (force-mode-line-update)
5420 (message "Word wrapping %s"
5421 (if word-wrap "enabled" "disabled")))
5423 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5424 "The string displayed in the mode line when in overwrite mode.")
5425 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5426 "The string displayed in the mode line when in binary overwrite mode.")
5428 (define-minor-mode overwrite-mode
5429 "Toggle Overwrite mode.
5430 With a prefix argument ARG, enable Overwrite mode if ARG is
5431 positive, and disable it otherwise. If called from Lisp, enable
5432 the mode if ARG is omitted or nil.
5434 When Overwrite mode is enabled, printing characters typed in
5435 replace existing text on a one-for-one basis, rather than pushing
5436 it to the right. At the end of a line, such characters extend
5437 the line. Before a tab, such characters insert until the tab is
5439 overwrite mode; this is supposed to make it easier to insert
5440 characters when necessary."
5441 :variable (eq overwrite-mode 'overwrite-mode-textual))
5443 (define-minor-mode binary-overwrite-mode
5444 "Toggle Binary Overwrite mode.
5445 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5446 is positive, and disable it otherwise. If called from Lisp,
5447 enable the mode if ARG is omitted or nil.
5449 When Binary Overwrite mode is enabled, printing characters typed
5450 in replace existing text. Newlines are not treated specially, so
5451 typing at the end of a line joins the line to the next, with the
5452 typed character between them. Typing before a tab character
5453 simply replaces the tab with the character typed.
5455 ordinary typing characters do.
5457 Note that Binary Overwrite mode is not its own minor mode; it is
5458 a specialization of overwrite mode, entered by setting the
5459 `overwrite-mode' variable to `overwrite-mode-binary'."
5460 :variable (eq overwrite-mode 'overwrite-mode-binary))
5462 (define-minor-mode line-number-mode
5463 "Toggle line number display in the mode line (Line Number mode).
5464 With a prefix argument ARG, enable Line Number mode if ARG is
5465 positive, and disable it otherwise. If called from Lisp, enable
5466 the mode if ARG is omitted or nil.
5468 Line numbers do not appear for very large buffers and buffers
5469 with very long lines; see variables `line-number-display-limit'
5470 and `line-number-display-limit-width'."
5471 :init-value t :global t :group 'mode-line)
5473 (define-minor-mode column-number-mode
5474 "Toggle column number display in the mode line (Column Number mode).
5475 With a prefix argument ARG, enable Column Number mode if ARG is
5476 positive, and disable it otherwise.
5478 If called from Lisp, enable the mode if ARG is omitted or nil."
5479 :global t :group 'mode-line)
5481 (define-minor-mode size-indication-mode
5482 "Toggle buffer size display in the mode line (Size Indication mode).
5483 With a prefix argument ARG, enable Size Indication mode if ARG is
5484 positive, and disable it otherwise.
5486 If called from Lisp, enable the mode if ARG is omitted or nil."
5487 :global t :group 'mode-line)
5489 (define-minor-mode auto-save-mode
5490 "Toggle auto-saving in the current buffer (Auto Save mode).
5491 With a prefix argument ARG, enable Auto Save mode if ARG is
5492 positive, and disable it otherwise.
5494 If called from Lisp, enable the mode if ARG is omitted or nil."
5495 :variable ((and buffer-auto-save-file-name
5496 ;; If auto-save is off because buffer has shrunk,
5497 ;; then toggling should turn it on.
5498 (>= buffer-saved-size 0))
5499 . (lambda (val)
5500 (setq buffer-auto-save-file-name
5501 (cond
5502 ((null val) nil)
5503 ((and buffer-file-name auto-save-visited-file-name
5504 (not buffer-read-only))
5505 buffer-file-name)
5506 (t (make-auto-save-file-name))))))
5507 ;; If -1 was stored here, to temporarily turn off saving,
5508 ;; turn it back on.
5509 (and (< buffer-saved-size 0)
5510 (setq buffer-saved-size 0)))
5511 \f
5512 (defgroup paren-blinking nil
5513 "Blinking matching of parens and expressions."
5514 :prefix "blink-matching-"
5515 :group 'paren-matching)
5517 (defcustom blink-matching-paren t
5518 "Non-nil means show matching open-paren when close-paren is inserted."
5519 :type 'boolean
5520 :group 'paren-blinking)
5522 (defcustom blink-matching-paren-on-screen t
5523 "Non-nil means show matching open-paren when it is on screen.
5524 If nil, don't show it (but the open-paren can still be shown
5525 when it is off screen).
5527 This variable has no effect if `blink-matching-paren' is nil.
5528 \(In that case, the open-paren is never shown.)
5529 It is also ignored if `show-paren-mode' is enabled."
5530 :type 'boolean
5531 :group 'paren-blinking)
5533 (defcustom blink-matching-paren-distance (* 100 1024)
5534 "If non-nil, maximum distance to search backwards for matching open-paren.
5535 If nil, search stops at the beginning of the accessible portion of the buffer."
5536 :version "23.2" ; 25->100k
5537 :type '(choice (const nil) integer)
5538 :group 'paren-blinking)
5540 (defcustom blink-matching-delay 1
5541 "Time in seconds to delay after showing a matching paren."
5542 :type 'number
5543 :group 'paren-blinking)
5545 (defcustom blink-matching-paren-dont-ignore-comments nil
5546 "If nil, `blink-matching-paren' ignores comments.
5547 More precisely, when looking for the matching parenthesis,
5548 it skips the contents of comments that end before point."
5549 :type 'boolean
5550 :group 'paren-blinking)
5552 (defun blink-matching-check-mismatch (start end)
5553 "Return whether or not START...END are matching parens.
5554 END is the current point and START is the blink position.
5555 START might be nil if no matching starter was found.
5556 Returns non-nil if we find there is a mismatch."
5557 (let* ((end-syntax (syntax-after (1- end)))
5558 (matching-paren (and (consp end-syntax)
5559 (eq (syntax-class end-syntax) 5)
5560 (cdr end-syntax))))
5561 ;; For self-matched chars like " and $, we can't know when they're
5562 ;; mismatched or unmatched, so we can only do it for parens.
5563 (when matching-paren
5564 (not (and start
5565 (or
5566 (eq (char-after start) matching-paren)
5567 ;; The cdr might hold a new paren-class info rather than
5568 ;; a matching-char info, in which case the two CDRs
5569 ;; should match.
5570 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5572 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5573 "Function to check parentheses mismatches.
5574 The function takes two arguments (START and END) where START is the
5575 position just before the opening token and END is the position right after.
5576 START can be nil, if it was not found.
5577 The function should return non-nil if the two tokens do not match.")
5579 (defun blink-matching-open ()
5580 "Move cursor momentarily to the beginning of the sexp before point."
5581 (interactive)
5582 (when (and (not (bobp))
5583 blink-matching-paren)
5584 (let* ((oldpos (point))
5585 (message-log-max nil) ; Don't log messages about paren matching.
5586 (blinkpos
5587 (save-excursion
5588 (save-restriction
5589 (if blink-matching-paren-distance
5590 (narrow-to-region
5591 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5592 (- (point) blink-matching-paren-distance))
5593 oldpos))
5594 (let ((parse-sexp-ignore-comments
5595 (and parse-sexp-ignore-comments
5596 (not blink-matching-paren-dont-ignore-comments))))
5597 (condition-case ()
5598 (progn
5599 (forward-sexp -1)
5600 ;; backward-sexp skips backward over prefix chars,
5601 ;; so move back to the matching paren.
5602 (while (and (< (point) (1- oldpos))
5603 (let ((code (syntax-after (point))))
5604 (or (eq (syntax-class code) 6)
5605 (eq (logand 1048576 (car code))
5606 1048576))))
5607 (forward-char 1))
5608 (point))
5609 (error nil))))))
5610 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5611 (cond
5612 (mismatch
5613 (if blinkpos
5614 (if (minibufferp)
5615 (minibuffer-message "Mismatched parentheses")
5616 (message "Mismatched parentheses"))
5617 (if (minibufferp)
5618 (minibuffer-message "No matching parenthesis found")
5619 (message "No matching parenthesis found"))))
5620 ((not blinkpos) nil)
5621 ((pos-visible-in-window-p blinkpos)
5622 ;; Matching open within window, temporarily move to blinkpos but only
5623 ;; if `blink-matching-paren-on-screen' is non-nil.
5624 (and blink-matching-paren-on-screen
5625 (not show-paren-mode)
5626 (save-excursion
5627 (goto-char blinkpos)
5628 (sit-for blink-matching-delay))))
5629 (t
5630 (save-excursion
5631 (goto-char blinkpos)
5632 (let ((open-paren-line-string
5633 ;; Show what precedes the open in its line, if anything.
5634 (cond
5636 (buffer-substring (line-beginning-position)
5637 (1+ blinkpos)))
5638 ;; Show what follows the open in its line, if anything.
5639 ((save-excursion
5640 (forward-char 1)
5642 (not (eolp)))
5643 (buffer-substring blinkpos
5644 (line-end-position)))
5645 ;; Otherwise show the previous nonblank line,
5646 ;; if there is one.
5648 (concat
5649 (buffer-substring (progn
5651 (line-beginning-position))
5652 (progn (end-of-line)
5654 (point)))
5655 ;; Replace the newline and other whitespace with `...'.
5656 "..."
5657 (buffer-substring blinkpos (1+ blinkpos))))
5658 ;; There is nothing to show except the char itself.
5659 (t (buffer-substring blinkpos (1+ blinkpos))))))
5660 (message "Matches %s"
5661 (substring-no-properties open-paren-line-string)))))))))
5663 (defvar blink-paren-function 'blink-matching-open
5664 "Function called, if non-nil, whenever a close parenthesis is inserted.
5665 More precisely, a char with closeparen syntax is self-inserted.")
5667 (defun blink-paren-post-self-insert-function ()
5668 (when (and (eq (char-before) last-command-event) ; Sanity check.
5669 (memq (char-syntax last-command-event) '(?\) ?\$))
5670 blink-paren-function
5671 (not executing-kbd-macro)
5672 (not noninteractive)
5673 ;; Verify an even number of quoting characters precede the close.
5674 (= 1 (logand 1 (- (point)
5675 (save-excursion
5676 (forward-char -1)
5678 (point))))))
5679 (funcall blink-paren-function)))
5681 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5682 ;; Most likely, this hook is nil, so this arg doesn't matter,
5683 ;; but I use it as a reminder that this function usually
5684 ;; likes to be run after others since it does `sit-for'.
5685 'append)
5686 \f
5687 ;; This executes C-g typed while Emacs is waiting for a command.
5688 ;; Quitting out of a program does not go through here;
5689 ;; that happens in the QUIT macro at the C code level.
5690 (defun keyboard-quit ()
5691 "Signal a `quit' condition.
5692 During execution of Lisp code, this character causes a quit directly.
5693 At top-level, as an editor command, this simply beeps."
5694 (interactive)
5695 ;; Avoid adding the region to the window selection.
5696 (setq saved-region-selection nil)
5697 (let (select-active-regions)
5698 (deactivate-mark))
5699 (if (fboundp 'kmacro-keyboard-quit)
5700 (kmacro-keyboard-quit))
5701 (setq defining-kbd-macro nil)
5702 (let ((debug-on-quit nil))
5703 (signal 'quit nil)))
5705 (defvar buffer-quit-function nil
5708 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5710 (defun keyboard-escape-quit ()
5712 This command can exit an interactive command such as `query-replace',
5713 can clear out a prefix argument or a region,
5714 can get out of the minibuffer or other recursive edit,
5715 cancel the use of the current buffer (for special-purpose buffers),
5716 or go back to just one window (by deleting all but the selected window)."
5717 (interactive)
5718 (cond ((eq last-command 'mode-exited) nil)
5719 ((region-active-p)
5720 (deactivate-mark))
5721 ((> (minibuffer-depth) 0)
5722 (abort-recursive-edit))
5723 (current-prefix-arg
5724 nil)
5725 ((> (recursion-depth) 0)
5726 (exit-recursive-edit))
5727 (buffer-quit-function
5728 (funcall buffer-quit-function))
5729 ((not (one-window-p t))
5730 (delete-other-windows))
5732 (bury-buffer))))
5734 (defun play-sound-file (file &optional volume device)
5735 "Play sound stored in FILE.
5736 VOLUME and DEVICE correspond to the keywords of the sound
5737 specification for `play-sound'."
5738 (interactive "fPlay sound file: ")
5739 (let ((sound (list :file file)))
5740 (if volume
5741 (plist-put sound :volume volume))
5742 (if device
5743 (plist-put sound :device device))
5744 (push 'sound sound)
5745 (play-sound sound)))
5747 \f
5748 (defcustom read-mail-command 'rmail
5749 "Your preference for a mail reading package.
5750 This is used by some keybindings which support reading mail.
5751 See also `mail-user-agent' concerning sending mail."
5754 (function-item :tag "Emacs interface to MH"
5756 (function :tag "Other"))
5757 :version "21.1"
5758 :group 'mail)
5760 (defcustom mail-user-agent 'message-user-agent
5761 "Your preference for a mail composition package.
5762 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5763 outgoing email message. This variable lets you specify which
5764 mail-sending package you prefer.
5766 Valid values include:
5768 `message-user-agent' -- use the Message package.
5769 See Info node `(message)'.
5770 `sendmail-user-agent' -- use the Mail package.
5771 See Info node `(emacs)Sending Mail'.
5772 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5773 See Info node `(mh-e)'.
5774 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5775 paraphernalia, particularly the Gcc: header for
5776 archiving.
5778 Additional valid symbols may be available; check with the author of
5779 your package for details. The function should return non-nil if it
5780 succeeds.
5782 See also `read-mail-command' concerning reading mail."
5783 :type '(radio (function-item :tag "Message package"
5785 message-user-agent)
5786 (function-item :tag "Mail package"
5788 sendmail-user-agent)
5789 (function-item :tag "Emacs interface to MH"
5791 mh-e-user-agent)
5792 (function-item :tag "Message with full Gnus features"
5794 gnus-user-agent)
5795 (function :tag "Other"))
5796 :version "23.2" ; sendmail->message
5797 :group 'mail)
5799 (defcustom compose-mail-user-agent-warnings t
5800 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5801 If the value of `mail-user-agent' is the default, and the user
5802 appears to have customizations applying to the old default,
5803 `compose-mail' issues a warning."
5804 :type 'boolean
5805 :version "23.2"
5806 :group 'mail)
5808 (defun rfc822-goto-eoh ()
5809 "If the buffer starts with a mail header, move point to the header's end.
5810 Otherwise, moves to `point-min'.
5811 The end of the header is the start of the next line, if there is one,
5812 else the end of the last line. This function obeys RFC822."
5813 (goto-char (point-min))
5814 (when (re-search-forward
5816 (goto-char (match-beginning 0))))
5818 ;; Used by Rmail (e.g., rmail-forward).
5819 (defvar mail-encode-mml nil
5820 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5821 the outgoing message before sending it.")
5823 (defun compose-mail (&optional to subject other-headers continue
5824 switch-function yank-action send-actions
5825 return-action)
5826 "Start composing a mail message to send.
5827 This uses the user's chosen mail composition package
5828 as selected with the variable `mail-user-agent'.
5829 The optional arguments TO and SUBJECT specify recipients
5830 and the initial Subject field, respectively.
5832 OTHER-HEADERS is an alist specifying additional
5833 header fields. Elements look like (HEADER . VALUE) where both
5834 HEADER and VALUE are strings.
5836 CONTINUE, if non-nil, says to continue editing a message already
5837 being composed. Interactively, CONTINUE is the prefix argument.
5839 SWITCH-FUNCTION, if non-nil, is a function to use to
5840 switch to and display the buffer used for mail composition.
5842 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5843 to insert the raw text of the message being replied to.
5844 It has the form (FUNCTION . ARGS). The user agent will apply
5845 FUNCTION to ARGS, to insert the raw text of the original message.
5846 \(The user agent will also run `mail-citation-hook', *after* the
5847 original text has been inserted in this way.)
5849 SEND-ACTIONS is a list of actions to call when the message is sent.
5850 Each action has the form (FUNCTION . ARGS).
5852 RETURN-ACTION, if non-nil, is an action for returning to the
5853 caller. It has the form (FUNCTION . ARGS). The function is
5854 called after the mail has been sent or put aside, and the mail
5855 buffer buried."
5856 (interactive
5857 (list nil nil nil current-prefix-arg))
5859 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5860 ;; from sendmail-user-agent to message-user-agent. Some users may
5861 ;; encounter incompatibilities. This hack tries to detect problems
5862 ;; and warn about them.
5863 (and compose-mail-user-agent-warnings
5864 (eq mail-user-agent 'message-user-agent)
5865 (let (warn-vars)
5866 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5867 mail-yank-hooks mail-archive-file-name
5868 mail-default-reply-to mail-mailing-lists
5869 mail-self-blind))
5870 (and (boundp var)
5871 (symbol-value var)
5872 (push var warn-vars)))
5873 (when warn-vars
5874 (display-warning 'mail
5875 (format "\
5876 The default mail mode is now Message mode.
5877 You have the following Mail mode variable%s customized:
5879 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5880 (if (> (length warn-vars) 1) "s" "")
5881 (mapconcat 'symbol-name
5882 warn-vars " "))))))
5884 (let ((function (get mail-user-agent 'composefunc)))
5885 (funcall function to subject other-headers continue switch-function
5886 yank-action send-actions return-action)))
5888 (defun compose-mail-other-window (&optional to subject other-headers continue
5889 yank-action send-actions
5890 return-action)
5892 (interactive (list nil nil nil current-prefix-arg))
5893 (compose-mail to subject other-headers continue
5894 'switch-to-buffer-other-window yank-action send-actions
5895 return-action))
5897 (defun compose-mail-other-frame (&optional to subject other-headers continue
5898 yank-action send-actions
5899 return-action)
5901 (interactive (list nil nil nil current-prefix-arg))
5902 (compose-mail to subject other-headers continue
5903 'switch-to-buffer-other-frame yank-action send-actions
5904 return-action))
5906 \f
5907 (defvar set-variable-value-history nil
5908 "History of values entered with `set-variable'.
5910 Maximum length of the history list is determined by the value
5911 of `history-length', which see.")
5913 (defun set-variable (variable value &optional make-local)
5914 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5915 VARIABLE should be a user option variable name, a Lisp variable
5916 meant to be customized by users. You should enter VALUE in Lisp syntax,
5917 so if you want VALUE to be a string, you must surround it with doublequotes.
5918 VALUE is used literally, not evaluated.
5920 If VARIABLE has a `variable-interactive' property, that is used as if
5921 it were the arg to `interactive' (which see) to interactively read VALUE.
5923 If VARIABLE has been defined with `defcustom', then the type information
5924 in the definition is used to check that VALUE is valid.
5926 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5927 (interactive
5928 (let* ((default-var (variable-at-point))
5929 (var (if (user-variable-p default-var)
5930 (read-variable (format "Set variable (default %s): " default-var)
5931 default-var)
5932 (read-variable "Set variable: ")))
5933 (minibuffer-help-form '(describe-variable var))
5934 (prop (get var 'variable-interactive))
5935 (obsolete (car (get var 'byte-obsolete-variable)))
5936 (prompt (format "Set %s %s to value: " var
5937 (cond ((local-variable-p var)
5938 "(buffer-local)")
5939 ((or current-prefix-arg
5940 (local-variable-if-set-p var))
5941 "buffer-locally")
5942 (t "globally"))))
5943 (val (progn
5944 (when obsolete
5945 (message (concat "`%S' is obsolete; "
5946 (if (symbolp obsolete) "use `%S' instead" "%s"))
5947 var obsolete)
5948 (sit-for 3))
5949 (if prop
5950 ;; Use VAR's `variable-interactive' property
5951 ;; as an interactive spec for prompting.
5952 (call-interactively `(lambda (arg)
5953 (interactive ,prop)
5954 arg))
5955 (read
5956 (read-string prompt nil
5957 'set-variable-value-history
5958 (format "%S" (symbol-value var))))))))
5959 (list var val current-prefix-arg)))
5961 (and (custom-variable-p variable)
5962 (not (get variable 'custom-type))
5963 (custom-load-symbol variable))
5964 (let ((type (get variable 'custom-type)))
5965 (when type
5966 ;; Match with custom type.
5967 (require 'cus-edit)
5968 (setq type (widget-convert type))
5969 (unless (widget-apply type :match value)
5970 (error "Value `%S' does not match type %S of %S"
5971 value (car type) variable))))
5973 (if make-local
5974 (make-local-variable variable))
5976 (set variable value)
5978 ;; Force a thorough redisplay for the case that the variable
5979 ;; has an effect on the display, like `tab-width' has.
5980 (force-mode-line-update))
5981 \f
5982 ;; Define the major mode for lists of completions.
5984 (defvar completion-list-mode-map
5985 (let ((map (make-sparse-keymap)))
5986 (define-key map [mouse-2] 'mouse-choose-completion)
5987 (define-key map [follow-link] 'mouse-face)
5988 (define-key map [down-mouse-2] nil)
5989 (define-key map "\C-m" 'choose-completion)
5990 (define-key map "\e\e\e" 'delete-completion-window)
5991 (define-key map [left] 'previous-completion)
5992 (define-key map [right] 'next-completion)
5993 (define-key map "q" 'quit-window)
5994 (define-key map "z" 'kill-this-buffer)
5995 map)
5996 "Local map for completion list buffers.")
5998 ;; Completion mode is suitable only for specially formatted data.
5999 (put 'completion-list-mode 'mode-class 'special)
6001 (defvar completion-reference-buffer nil
6002 "Record the buffer that was current when the completion list was requested.
6003 This is a local variable in the completion list buffer.
6004 Initial value is nil to avoid some compiler warnings.")
6006 (defvar completion-no-auto-exit nil
6007 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6008 This also applies to other functions such as `choose-completion'.")
6010 (defvar completion-base-position nil
6011 "Position of the base of the text corresponding to the shown completions.
6012 This variable is used in the *Completions* buffers.
6013 Its value is a list of the form (START END) where START is the place
6014 where the completion should be inserted and END (if non-nil) is the end
6015 of the text to replace. If END is nil, point is used instead.")
6017 (defvar completion-list-insert-choice-function #'completion--replace
6018 "Function to use to insert the text chosen in *Completions*.
6019 Called with 3 arguments (BEG END TEXT), it should replace the text
6020 between BEG and END with TEXT. Expected to be set buffer-locally
6021 in the *Completions* buffer.")
6023 (defvar completion-base-size nil
6024 "Number of chars before point not involved in completion.
6025 This is a local variable in the completion list buffer.
6026 It refers to the chars in the minibuffer if completing in the
6027 minibuffer, or in `completion-reference-buffer' otherwise.
6028 Only characters in the field at point are included.
6030 If nil, Emacs determines which part of the tail end of the
6031 buffer's text is involved in completion by comparing the text
6032 directly.")
6033 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6035 (defun delete-completion-window ()
6036 "Delete the completion list window.
6037 Go to the window from which completion was requested."
6038 (interactive)
6039 (let ((buf completion-reference-buffer))
6040 (if (one-window-p t)
6041 (if (window-dedicated-p (selected-window))
6042 (delete-frame (selected-frame)))
6043 (delete-window (selected-window))
6044 (if (get-buffer-window buf)
6045 (select-window (get-buffer-window buf))))))
6047 (defun previous-completion (n)
6048 "Move to the previous item in the completion list."
6049 (interactive "p")
6050 (next-completion (- n)))
6052 (defun next-completion (n)
6053 "Move to the next item in the completion list.
6054 With prefix argument N, move N items (negative N means move backward)."
6055 (interactive "p")
6056 (let ((beg (point-min)) (end (point-max)))
6057 (while (and (> n 0) (not (eobp)))
6058 ;; If in a completion, move to the end of it.
6059 (when (get-text-property (point) 'mouse-face)
6060 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6061 ;; Move to start of next one.
6062 (unless (get-text-property (point) 'mouse-face)
6063 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6064 (setq n (1- n)))
6065 (while (and (< n 0) (not (bobp)))
6066 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6067 ;; If in a completion, move to the start of it.
6068 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6069 (goto-char (previous-single-property-change
6070 (point) 'mouse-face nil beg)))
6071 ;; Move to end of the previous completion.
6072 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6073 (goto-char (previous-single-property-change
6074 (point) 'mouse-face nil beg)))
6075 ;; Move to the start of that one.
6076 (goto-char (previous-single-property-change
6077 (point) 'mouse-face nil beg))
6078 (setq n (1+ n))))))
6080 (defun choose-completion (&optional event)
6081 "Choose the completion at point."
6082 (interactive (list last-nonmenu-event))
6083 ;; In case this is run via the mouse, give temporary modes such as
6084 ;; isearch a chance to turn off.
6085 (run-hooks 'mouse-leave-buffer-hook)
6086 (with-current-buffer (window-buffer (posn-window (event-start event)))
6087 (let ((buffer completion-reference-buffer)
6088 (base-size completion-base-size)
6089 (base-position completion-base-position)
6090 (insert-function completion-list-insert-choice-function)
6091 (choice
6092 (save-excursion
6093 (goto-char (posn-point (event-start event)))
6094 (let (beg end)
6095 (cond
6096 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6097 (setq end (point) beg (1+ (point))))
6098 ((and (not (bobp))
6099 (get-text-property (1- (point)) 'mouse-face))
6100 (setq end (1- (point)) beg (point)))
6101 (t (error "No completion here")))
6102 (setq beg (previous-single-property-change beg 'mouse-face))
6103 (setq end (or (next-single-property-change end 'mouse-face)
6104 (point-max)))
6105 (buffer-substring-no-properties beg end))))
6106 (owindow (selected-window)))
6108 (unless (buffer-live-p buffer)
6109 (error "Destination buffer is dead"))
6110 (select-window (posn-window (event-start event)))
6111 (if (and (one-window-p t 'selected-frame)
6112 (window-dedicated-p (selected-window)))
6113 ;; This is a special buffer's frame
6114 (iconify-frame (selected-frame))
6115 (or (window-dedicated-p (selected-window))
6116 (bury-buffer)))
6117 (select-window
6118 (or (get-buffer-window buffer 0)
6119 owindow))
6121 (with-current-buffer buffer
6122 (choose-completion-string
6123 choice buffer
6124 (or base-position
6125 (when base-size
6126 ;; Someone's using old completion code that doesn't know
6127 ;; about base-position yet.
6128 (list (+ base-size (field-beginning))))
6129 ;; If all else fails, just guess.
6130 (list (choose-completion-guess-base-position choice)))
6131 insert-function)))))
6133 ;; Delete the longest partial match for STRING
6134 ;; that can be found before POINT.
6135 (defun choose-completion-guess-base-position (string)
6136 (save-excursion
6137 (let ((opoint (point))
6138 len)
6139 ;; Try moving back by the length of the string.
6140 (goto-char (max (- (point) (length string))
6141 (minibuffer-prompt-end)))
6142 ;; See how far back we were actually able to move. That is the
6143 ;; upper bound on how much we can match and delete.
6144 (setq len (- opoint (point)))
6145 (if completion-ignore-case
6146 (setq string (downcase string)))
6147 (while (and (> len 0)
6148 (let ((tail (buffer-substring (point) opoint)))
6149 (if completion-ignore-case
6150 (setq tail (downcase tail)))
6151 (not (string= tail (substring string 0 len)))))
6152 (setq len (1- len))
6153 (forward-char 1))
6154 (point))))
6156 (defun choose-completion-delete-max-match (string)
6157 (delete-region (choose-completion-guess-base-position string) (point)))
6158 (make-obsolete 'choose-completion-delete-max-match
6159 'choose-completion-guess-base-position "23.2")
6161 (defvar choose-completion-string-functions nil
6162 "Functions that may override the normal insertion of a completion choice.
6163 These functions are called in order with four arguments:
6164 CHOICE - the string to insert in the buffer,
6165 BUFFER - the buffer in which the choice should be inserted,
6166 MINI-P - non-nil if BUFFER is a minibuffer, and
6167 BASE-SIZE - the number of characters in BUFFER before
6168 the string being completed.
6170 If a function in the list returns non-nil, that function is supposed
6171 to have inserted the CHOICE in the BUFFER, and possibly exited
6172 the minibuffer; no further functions will be called.
6174 If all functions in the list return nil, that means to use
6175 the default method of inserting the completion in BUFFER.")
6177 (defun choose-completion-string (choice &optional
6178 buffer base-position insert-function)
6179 "Switch to BUFFER and insert the completion choice CHOICE.
6180 BASE-POSITION, says where to insert the completion."
6182 ;; If BUFFER is the minibuffer, exit the minibuffer
6183 ;; unless it is reading a file name and CHOICE is a directory,
6184 ;; or completion-no-auto-exit is non-nil.
6186 ;; Some older code may call us passing `base-size' instead of
6187 ;; `base-position'. It's difficult to make any use of `base-size',
6188 ;; so we just ignore it.
6189 (unless (consp base-position)
6190 (message "Obsolete `base-size' passed to choose-completion-string")
6191 (setq base-position nil))
6193 (let* ((buffer (or buffer completion-reference-buffer))
6194 (mini-p (minibufferp buffer)))
6195 ;; If BUFFER is a minibuffer, barf unless it's the currently
6196 ;; active minibuffer.
6197 (if (and mini-p
6198 (not (and (active-minibuffer-window)
6199 (equal buffer
6200 (window-buffer (active-minibuffer-window))))))
6201 (error "Minibuffer is not active for completion")
6202 ;; Set buffer so buffer-local choose-completion-string-functions works.
6203 (set-buffer buffer)
6204 (unless (run-hook-with-args-until-success
6205 'choose-completion-string-functions
6206 ;; The fourth arg used to be `mini-p' but was useless
6207 ;; (since minibufferp can be used on the `buffer' arg)
6208 ;; and indeed unused. The last used to be `base-size', so we
6209 ;; keep it to try and avoid breaking old code.
6210 choice buffer base-position nil)
6211 ;; This remove-text-properties should be unnecessary since `choice'
6212 ;; comes from buffer-substring-no-properties.
6213 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6214 ;; Insert the completion into the buffer where it was requested.
6215 (funcall (or insert-function completion-list-insert-choice-function)
6216 (or (car base-position) (point))
6217 (or (cadr base-position) (point))
6218 choice)
6219 ;; Update point in the window that BUFFER is showing in.
6220 (let ((window (get-buffer-window buffer t)))
6221 (set-window-point window (point)))
6222 ;; If completing for the minibuffer, exit it with this choice.
6223 (and (not completion-no-auto-exit)
6224 (minibufferp buffer)
6225 minibuffer-completion-table
6226 ;; If this is reading a file name, and the file name chosen
6227 ;; is a directory, don't exit the minibuffer.
6228 (let* ((result (buffer-substring (field-beginning) (point)))
6229 (bounds
6230 (completion-boundaries result minibuffer-completion-table
6231 minibuffer-completion-predicate
6232 "")))
6233 (if (eq (car bounds) (length result))
6234 ;; The completion chosen leads to a new set of completions
6235 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6236 (let ((mini (active-minibuffer-window)))
6237 (select-window mini)
6238 (when minibuffer-auto-raise
6239 (raise-frame (window-frame mini))))
6240 (exit-minibuffer))))))))
6242 (define-derived-mode completion-list-mode nil "Completion List"
6243 "Major mode for buffers showing lists of possible completions.
6245 to select the completion near point.
6247 with the mouse.
6250 (set (make-local-variable 'completion-base-size) nil))
6252 (defun completion-list-mode-finish ()
6253 "Finish setup of the completions buffer.
6254 Called from `temp-buffer-show-hook'."
6255 (when (eq major-mode 'completion-list-mode)
6256 (toggle-read-only 1)))
6258 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6261 ;; Variables and faces used in `completion-setup-function'.
6263 (defcustom completion-show-help t
6264 "Non-nil means show help message in *Completions* buffer."
6265 :type 'boolean
6266 :version "22.1"
6267 :group 'completion)
6269 ;; This function goes in completion-setup-hook, so that it is called
6270 ;; after the text of the completion list buffer is written.
6271 (defun completion-setup-function ()
6272 (let* ((mainbuf (current-buffer))
6273 (base-dir
6274 ;; When reading a file name in the minibuffer,
6275 ;; try and find the right default-directory to set in the
6276 ;; completion list buffer.
6277 ;; FIXME: Why do we do that, actually? --Stef
6278 (if minibuffer-completing-file-name
6279 (file-name-as-directory
6280 (expand-file-name
6281 (substring (minibuffer-completion-contents)
6282 0 (or completion-base-size 0)))))))
6283 (with-current-buffer standard-output
6284 (let ((base-size completion-base-size) ;Read before killing localvars.
6285 (base-position completion-base-position)
6286 (insert-fun completion-list-insert-choice-function))
6287 (completion-list-mode)
6288 (set (make-local-variable 'completion-base-size) base-size)
6289 (set (make-local-variable 'completion-base-position) base-position)
6290 (set (make-local-variable 'completion-list-insert-choice-function)
6291 insert-fun))
6292 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6293 (if base-dir (setq default-directory base-dir))
6294 ;; Maybe insert help string.
6295 (when completion-show-help
6296 (goto-char (point-min))
6297 (if (display-mouse-p)
6298 (insert (substitute-command-keys
6300 (insert (substitute-command-keys
6304 (add-hook 'completion-setup-hook 'completion-setup-function)
6306 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6307 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6309 (defun switch-to-completions ()
6310 "Select the completion list window."
6311 (interactive)
6312 (let ((window (or (get-buffer-window "*Completions*" 0)
6313 ;; Make sure we have a completions window.
6314 (progn (minibuffer-completion-help)
6315 (get-buffer-window "*Completions*" 0)))))
6316 (when window
6317 (select-window window)
6318 ;; In the new buffer, go to the first completion.
6319 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6320 (when (bobp)
6321 (next-completion 1)))))
6322 \f
6323 ;;; Support keyboard commands to turn on various modifiers.
6325 ;; These functions -- which are not commands -- each add one modifier
6326 ;; to the following event.
6328 (defun event-apply-alt-modifier (_ignore-prompt)
6331 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6332 (defun event-apply-super-modifier (_ignore-prompt)
6335 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6336 (defun event-apply-hyper-modifier (_ignore-prompt)
6339 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6340 (defun event-apply-shift-modifier (_ignore-prompt)
6343 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6344 (defun event-apply-control-modifier (_ignore-prompt)
6347 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6348 (defun event-apply-meta-modifier (_ignore-prompt)
6351 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6353 (defun event-apply-modifier (event symbol lshiftby prefix)
6354 "Apply a modifier flag to event EVENT.
6355 SYMBOL is the name of this modifier, as a symbol.
6356 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6357 PREFIX is the string that represents this modifier in an event type symbol."
6358 (if (numberp event)
6359 (cond ((eq symbol 'control)
6360 (if (and (<= (downcase event) ?z)
6361 (>= (downcase event) ?a))
6362 (- (downcase event) ?a -1)
6363 (if (and (<= (downcase event) ?Z)
6364 (>= (downcase event) ?A))
6365 (- (downcase event) ?A -1)
6366 (logior (lsh 1 lshiftby) event))))
6367 ((eq symbol 'shift)
6368 (if (and (<= (downcase event) ?z)
6369 (>= (downcase event) ?a))
6370 (upcase event)
6371 (logior (lsh 1 lshiftby) event)))
6372 (t
6373 (logior (lsh 1 lshiftby) event)))
6374 (if (memq symbol (event-modifiers event))
6375 event
6376 (let ((event-type (if (symbolp event) event (car event))))
6377 (setq event-type (intern (concat prefix (symbol-name event-type))))
6378 (if (symbolp event)
6379 event-type
6380 (cons event-type (cdr event)))))))
6382 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6383 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6384 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6385 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6386 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6387 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6388 \f
6389 ;;;; Keypad support.
6391 ;; Make the keypad keys act like ordinary typing keys. If people add
6392 ;; bindings for the function key symbols, then those bindings will
6393 ;; override these, so this shouldn't interfere with any existing
6394 ;; bindings.
6396 ;; Also tell read-char how to handle these keys.
6397 (mapc
6398 (lambda (keypad-normal)
6399 (let ((keypad (nth 0 keypad-normal))
6400 (normal (nth 1 keypad-normal)))
6401 (put keypad 'ascii-character normal)
6402 (define-key function-key-map (vector keypad) (vector normal))))
6403 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6404 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6405 (kp-space ?\s)
6408 (kp-multiply ?*)
6409 (kp-add ?+)
6410 (kp-separator ?,)
6411 (kp-subtract ?-)
6412 (kp-decimal ?.)
6413 (kp-divide ?/)
6414 (kp-equal ?=)
6415 ;; Do the same for various keys that are represented as symbols under
6416 ;; GUIs but naturally correspond to characters.
6417 (backspace 127)
6418 (delete 127)
6421 (clear ?\C-l)
6422 (return ?\C-m)
6423 (escape ?\e)
6424 ))
6425 \f
6426 ;;;;
6427 ;;;; forking a twin copy of a buffer.
6428 ;;;;
6430 (defvar clone-buffer-hook nil
6431 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6433 (defvar clone-indirect-buffer-hook nil
6434 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6436 (defun clone-process (process &optional newname)
6437 "Create a twin copy of PROCESS.
6438 If NEWNAME is nil, it defaults to PROCESS' name;
6439 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6440 If PROCESS is associated with a buffer, the new process will be associated
6441 with the current buffer instead.
6442 Returns nil if PROCESS has already terminated."
6443 (setq newname (or newname (process-name process)))
6445 (setq newname (substring newname 0 (match-beginning 0))))
6446 (when (memq (process-status process) '(run stop open))
6447 (let* ((process-connection-type (process-tty-name process))
6448 (new-process
6449 (if (memq (process-status process) '(open))
6450 (let ((args (process-contact process t)))
6451 (setq args (plist-put args :name newname))
6452 (setq args (plist-put args :buffer
6453 (if (process-buffer process)
6454 (current-buffer))))
6455 (apply 'make-network-process args))
6456 (apply 'start-process newname
6457 (if (process-buffer process) (current-buffer))
6458 (process-command process)))))
6459 (set-process-query-on-exit-flag
6460 new-process (process-query-on-exit-flag process))
6461 (set-process-inherit-coding-system-flag
6462 new-process (process-inherit-coding-system-flag process))
6463 (set-process-filter new-process (process-filter process))
6464 (set-process-sentinel new-process (process-sentinel process))
6465 (set-process-plist new-process (copy-sequence (process-plist process)))
6466 new-process)))
6468 ;; things to maybe add (currently partly covered by `funcall mode'):
6469 ;; - syntax-table
6470 ;; - overlays
6471 (defun clone-buffer (&optional newname display-flag)
6472 "Create and return a twin copy of the current buffer.
6473 Unlike an indirect buffer, the new buffer can be edited
6474 independently of the old one (if it is not read-only).
6475 NEWNAME is the name of the new buffer. It may be modified by
6476 adding or incrementing <N> at the end as necessary to create a
6477 unique buffer name. If nil, it defaults to the name of the
6478 current buffer, with the proper suffix. If DISPLAY-FLAG is
6479 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6480 clone a file-visiting buffer, or a buffer whose major mode symbol
6481 has a non-nil `no-clone' property, results in an error.
6483 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6484 current buffer with appropriate suffix. However, if a prefix
6485 argument is given, then the command prompts for NEWNAME in the
6486 minibuffer.
6488 This runs the normal hook `clone-buffer-hook' in the new buffer
6489 after it has been set up properly in other respects."
6490 (interactive
6491 (progn
6492 (if buffer-file-name
6493 (error "Cannot clone a file-visiting buffer"))
6494 (if (get major-mode 'no-clone)
6495 (error "Cannot clone a buffer in %s mode" mode-name))
6496 (list (if current-prefix-arg
6497 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6498 t)))
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 (setq newname (or newname (buffer-name)))
6505 (setq newname (substring newname 0 (match-beginning 0))))
6506 (let ((buf (current-buffer))
6507 (ptmin (point-min))
6508 (ptmax (point-max))
6509 (pt (point))
6510 (mk (if mark-active (mark t)))
6511 (modified (buffer-modified-p))
6512 (mode major-mode)
6513 (lvars (buffer-local-variables))
6514 (process (get-buffer-process (current-buffer)))
6515 (new (generate-new-buffer (or newname (buffer-name)))))
6516 (save-restriction
6517 (widen)
6518 (with-current-buffer new
6519 (insert-buffer-substring buf)))
6520 (with-current-buffer new
6521 (narrow-to-region ptmin ptmax)
6522 (goto-char pt)
6523 (if mk (set-mark mk))
6524 (set-buffer-modified-p modified)
6526 ;; Clone the old buffer's process, if any.
6527 (when process (clone-process process))
6529 ;; Now set up the major mode.
6530 (funcall mode)
6532 ;; Set up other local variables.
6533 (mapc (lambda (v)
6534 (condition-case () ;in case var is read-only
6535 (if (symbolp v)
6536 (makunbound v)
6537 (set (make-local-variable (car v)) (cdr v)))
6538 (error nil)))
6539 lvars)
6541 ;; Run any hooks (typically set up by the major mode
6542 ;; for cloning to work properly).
6543 (run-hooks 'clone-buffer-hook))
6544 (if display-flag
6545 ;; Presumably the current buffer is shown in the selected frame, so
6546 ;; we want to display the clone elsewhere.
6547 (let ((same-window-regexps nil)
6548 (same-window-buffer-names))
6549 (pop-to-buffer new)))
6550 new))
6553 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6554 "Create an indirect buffer that is a twin copy of the current buffer.
6556 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6557 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6558 or if not called with a prefix arg, NEWNAME defaults to the current
6559 buffer's name. The name is modified by adding a `<N>' suffix to it
6560 or by incrementing the N in an existing suffix. Trying to clone a
6561 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6562 property results in an error.
6564 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6565 This is always done when called interactively.
6567 Optional third arg NORECORD non-nil means do not put this buffer at the
6568 front of the list of recently selected ones."
6569 (interactive
6570 (progn
6571 (if (get major-mode 'no-clone-indirect)
6572 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6573 (list (if current-prefix-arg
6574 (read-buffer "Name of indirect buffer: " (current-buffer)))
6575 t)))
6576 (if (get major-mode 'no-clone-indirect)
6577 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6578 (setq newname (or newname (buffer-name)))
6580 (setq newname (substring newname 0 (match-beginning 0))))
6581 (let* ((name (generate-new-buffer-name newname))
6582 (buffer (make-indirect-buffer (current-buffer) name t)))
6583 (with-current-buffer buffer
6584 (run-hooks 'clone-indirect-buffer-hook))
6585 (when display-flag
6586 (pop-to-buffer buffer norecord))
6587 buffer))
6590 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6591 "Like `clone-indirect-buffer' but display in another window."
6592 (interactive
6593 (progn
6594 (if (get major-mode 'no-clone-indirect)
6595 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6596 (list (if current-prefix-arg
6597 (read-buffer "Name of indirect buffer: " (current-buffer)))
6598 t)))
6599 (let ((pop-up-windows t))
6600 (clone-indirect-buffer newname display-flag norecord)))
6602 \f
6603 ;;; Handling of Backspace and Delete keys.
6605 (defcustom normal-erase-is-backspace 'maybe
6606 "Set the default behavior of the Delete and Backspace keys.
6608 If set to t, Delete key deletes forward and Backspace key deletes
6609 backward.
6611 If set to nil, both Delete and Backspace keys delete backward.
6613 If set to 'maybe (which is the default), Emacs automatically
6614 selects a behavior. On window systems, the behavior depends on
6615 the keyboard used. If the keyboard has both a Backspace key and
6616 a Delete key, and both are mapped to their usual meanings, the
6617 option's default value is set to t, so that Backspace can be used
6618 to delete backward, and Delete can be used to delete forward.
6620 If not running under a window system, customizing this option
6621 accomplishes a similar effect by mapping C-h, which is usually
6622 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6623 via `keyboard-translate'. The former functionality of C-h is
6624 available on the F1 key. You should probably not use this
6625 setting if you don't have both Backspace, Delete and F1 keys.
6627 Setting this variable with setq doesn't take effect. Programmatically,
6628 call `normal-erase-is-backspace-mode' (which see) instead."
6629 :type '(choice (const :tag "Off" nil)
6630 (const :tag "Maybe" maybe)
6631 (other :tag "On" t))
6632 :group 'editing-basics
6633 :version "21.1"
6634 :set (lambda (symbol value)
6635 ;; The fboundp is because of a problem with :set when
6636 ;; dumping Emacs. It doesn't really matter.
6637 (if (fboundp 'normal-erase-is-backspace-mode)
6638 (normal-erase-is-backspace-mode (or value 0))
6639 (set-default symbol value))))
6641 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6642 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6643 (unless frame (setq frame (selected-frame)))
6644 (with-selected-frame frame
6645 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6646 (normal-erase-is-backspace-mode
6647 (if (if (eq normal-erase-is-backspace 'maybe)
6648 (and (not noninteractive)
6649 (or (memq system-type '(ms-dos windows-nt))
6650 (memq window-system '(ns))
6651 (and (memq window-system '(x))
6652 (fboundp 'x-backspace-delete-keys-p)
6653 (x-backspace-delete-keys-p))
6654 ;; If the terminal Emacs is running on has erase char
6655 ;; set to ^H, use the Backspace key for deleting
6656 ;; backward, and the Delete key for deleting forward.
6657 (and (null window-system)
6658 (eq tty-erase-char ?\^H))))
6659 normal-erase-is-backspace)
6660 1 0)))))
6662 (define-minor-mode normal-erase-is-backspace-mode
6663 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6664 With a prefix argument ARG, enable this feature if ARG is
6665 positive, and disable it otherwise. If called from Lisp, enable
6666 the mode if ARG is omitted or nil.
6668 On window systems, when this mode is on, Delete is mapped to C-d
6669 and Backspace is mapped to DEL; when this mode is off, both
6670 Delete and Backspace are mapped to DEL. (The remapping goes via
6671 `local-function-key-map', so binding Delete or Backspace in the
6672 global or local keymap will override that.)
6674 In addition, on window systems, the bindings of C-Delete, M-Delete,
6675 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6676 the global keymap in accordance with the functionality of Delete and
6677 Backspace. For example, if Delete is remapped to C-d, which deletes
6678 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6679 to DEL, which deletes backward, C-Delete is bound to
6680 `backward-kill-word'.
6682 If not running on a window system, a similar effect is accomplished by
6683 remapping C-h (normally produced by the Backspace key) and DEL via
6684 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6685 to C-d; if it's off, the keys are not remapped.
6687 When not running on a window system, and this mode is turned on, the
6688 former functionality of C-h is available on the F1 key. You should
6689 probably not turn on this mode on a text-only terminal if you don't
6690 have both Backspace, Delete and F1 keys.
6692 See also `normal-erase-is-backspace'."
6693 :variable (eq (terminal-parameter
6694 nil 'normal-erase-is-backspace) 1)
6695 (let ((enabled (eq 1 (terminal-parameter
6696 nil 'normal-erase-is-backspace))))
6698 (cond ((or (memq window-system '(x w32 ns pc))
6699 (memq system-type '(ms-dos windows-nt)))
6700 (let ((bindings
6701 `(([M-delete] [M-backspace])
6702 ([C-M-delete] [C-M-backspace])
6703 ([?\e C-delete] [?\e C-backspace]))))
6705 (if enabled
6706 (progn
6707 (define-key local-function-key-map [delete] [deletechar])
6708 (define-key local-function-key-map [kp-delete] [?\C-d])
6709 (define-key local-function-key-map [backspace] [?\C-?])
6710 (dolist (b bindings)
6711 ;; Not sure if input-decode-map is really right, but
6712 ;; keyboard-translate-table (used below) only works
6713 ;; for integer events, and key-translation-table is
6714 ;; global (like the global-map, used earlier).
6715 (define-key input-decode-map (car b) nil)
6716 (define-key input-decode-map (cadr b) nil)))
6717 (define-key local-function-key-map [delete] [?\C-?])
6718 (define-key local-function-key-map [kp-delete] [?\C-?])
6719 (define-key local-function-key-map [backspace] [?\C-?])
6720 (dolist (b bindings)
6721 (define-key input-decode-map (car b) (cadr b))
6722 (define-key input-decode-map (cadr b) (car b))))))
6723 (t
6724 (if enabled
6725 (progn
6726 (keyboard-translate ?\C-h ?\C-?)
6727 (keyboard-translate ?\C-? ?\C-d))
6728 (keyboard-translate ?\C-h ?\C-h)
6729 (keyboard-translate ?\C-? ?\C-?))))
6731 (if (called-interactively-p 'interactive)
6732 (message "Delete key deletes %s"
6733 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6734 "forward" "backward")))))
6735 \f
6736 (defvar vis-mode-saved-buffer-invisibility-spec nil
6737 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6739 (define-minor-mode visible-mode
6740 "Toggle making all invisible text temporarily visible (Visible mode).
6741 With a prefix argument ARG, enable Visible mode if ARG is
6742 positive, and disable it otherwise. If called from Lisp, enable
6743 the mode if ARG is omitted or nil.
6745 This mode works by saving the value of `buffer-invisibility-spec'
6746 and setting it to nil."
6747 :lighter " Vis"
6748 :group 'editing-basics
6749 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6750 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6751 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6752 (when visible-mode
6753 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6754 buffer-invisibility-spec)
6755 (setq buffer-invisibility-spec nil)))
6756 \f
6757 ;; Minibuffer prompt stuff.
6759 ;;(defun minibuffer-prompt-modification (start end)
6760 ;; (error "You cannot modify the prompt"))
6761 ;;
6762 ;;
6763 ;;(defun minibuffer-prompt-insertion (start end)
6764 ;; (let ((inhibit-modification-hooks t))
6765 ;; (delete-region start end)
6766 ;; ;; Discard undo information for the text insertion itself
6767 ;; ;; and for the text deletion.above.
6768 ;; (when (consp buffer-undo-list)
6769 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6770 ;; (message "You cannot modify the prompt")))
6771 ;;
6772 ;;
6773 ;;(setq minibuffer-prompt-properties
6774 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6775 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6777 \f
6778 ;;;; Problematic external packages.
6780 ;; rms says this should be done by specifying symbols that define
6781 ;; versions together with bad values. This is therefore not as
6782 ;; flexible as it could be. See the thread:
6783 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6784 (defconst bad-packages-alist
6785 ;; Not sure exactly which semantic versions have problems.
6786 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6788 "The version of `semantic' loaded does not work in Emacs 22.
6789 It can cause constant high CPU load.
6790 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6791 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6792 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6793 ;; provided the `CUA-mode' feature. Since this is no longer true,
6794 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6795 (CUA-mode t nil
6796 "CUA-mode is now part of the standard GNU Emacs distribution,
6797 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6799 You have loaded an older version of CUA-mode which does not work
6800 correctly with this version of Emacs. You should remove the old
6801 version and use the one distributed with Emacs."))
6802 "Alist of packages known to cause problems in this version of Emacs.
6803 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6804 PACKAGE is either a regular expression to match file names, or a
6805 symbol (a feature name); see the documentation of
6806 `after-load-alist', to which this variable adds functions.
6807 SYMBOL is either the name of a string variable, or `t'. Upon
6808 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6809 warning using STRING as the message.")
6811 (defun bad-package-check (package)
6812 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6813 (condition-case nil
6814 (let* ((list (assoc package bad-packages-alist))
6815 (symbol (nth 1 list)))
6816 (and list
6817 (boundp symbol)
6818 (or (eq symbol t)
6819 (and (stringp (setq symbol (eval symbol)))
6820 (string-match-p (nth 2 list) symbol)))
6821 (display-warning package (nth 3 list) :warning)))
6822 (error nil)))
6824 (mapc (lambda (elem)
6825 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6826 bad-packages-alist)
6829 (provide 'simple)
6831 ;;; simple.el ends here