| blob | 0877f396faacb8483eb6b650820d447088baf281 |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2012 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
34 ;;; From compile.el
39 "Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
53 \f
54 ;;; next-error support framework
57 "`next-error' support framework."
63 "Face used to highlight next error locus."
68 "Highlighting of locations in selected source buffers.
69 If a number, highlight the locus in `next-error' face for the given time
70 in seconds, or until the next command is executed.
71 If t, highlight the locus until the next command is executed, or until
72 some other locus replaces it.
73 If nil, don't highlight the locus in the source buffer.
74 If `fringe-arrow', indicate the locus by the fringe arrow
75 indefinitely until some other locus replaces it."
84 "Highlighting of locations in `next-error-no-select'.
85 If number, highlight the locus in `next-error' face for given time in seconds.
86 If t, highlight the locus indefinitely until some other locus replaces it.
87 If nil, don't highlight the locus in the source buffer.
88 If `fringe-arrow', indicate the locus by the fringe arrow
89 indefinitely until some other locus replaces it."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 With a prefix argument ARG, enable mode if ARG is positive, and
323 disable it otherwise. If called from Lisp, enable mode if ARG is
324 omitted or nil.
325 When turned on, cursor motion in the compilation, grep, occur or diff
326 buffer causes automatic display of the corresponding source code 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.
569 Trailing lines are deleted only if `delete-trailing-whitespace'
570 is called on the entire buffer (rather than an active region)."
576 "Delete trailing whitespace between START and END.
577 If called interactively, START and END are the start/end of the
578 region if the mark is active, or of the buffer's accessible
579 portion if the mark is inactive.
581 This command deletes whitespace characters after the last
582 non-whitespace character in each line between START and END. It
583 does not consider formfeed characters to be whitespace.
585 If this command acts on the entire buffer (i.e. if called
586 interactively with the mark inactive, or called from Lisp with
587 END nil), it also deletes all trailing lines at the end of the
588 buffer if the variable `delete-trailing-lines' is non-nil."
601 ;; Don't delete formfeeds, even if they are considered whitespace.
605 ;; Delete trailing empty lines.
608 delete-trailing-lines
609 ;; Really the end of buffer.
614 ;; Return nil for the benefit of `write-file-functions'.
615 nil)
618 "Insert a newline, then indent according to major mode.
619 Indentation is done using the value of `indent-line-function'.
620 In programming language modes, this is the same as TAB.
621 In some text modes, where TAB inserts a tab, this command indents to the
622 column specified by the function `current-left-margin'."
629 "Reindent current line, insert newline, then indent the new line.
630 Indentation of both lines is done according to the current major mode,
631 which means calling the current value of `indent-line-function'.
632 In programming language modes, this is the same as TAB.
633 In some text modes, where TAB inserts a tab, this indents to the
634 column specified by the function `current-left-margin'."
637 ;; Be careful to insert the newline before indenting the line.
638 ;; Otherwise, the indentation might be wrong.
642 ;; We are at EOL before the call to indent-according-to-mode, and
643 ;; after it we usually are as well, but not always. We tried to
644 ;; address it with `save-excursion' but that uses a normal marker
645 ;; whereas we need `move after insertion', so we do the save/restore
646 ;; by hand.
650 ;; Remove the trailing white-space after indentation because
651 ;; indentation may introduce the whitespace.
656 "Read next input character and insert it.
657 This is useful for inserting control characters.
658 With argument, insert ARG copies of the character.
660 If the first character you type after this command is an octal digit,
661 you should type a sequence of octal digits which specify a character code.
662 Any nondigit terminates the sequence. If the terminator is a RET,
663 it is discarded; any other terminator is used itself as input.
664 The variable `read-quoted-char-radix' specifies the radix for this feature;
665 set it to 10 or 16 to use decimal or hex instead of octal.
667 In overwrite mode, this function inserts the character anyway, and
668 does not handle octal digits specially. This means that if you use
669 overwrite as your normal editing mode, you can use this function to
670 insert characters when necessary.
672 In binary overwrite mode, this function does overwrite, and octal
673 digits are interpreted as a character code. This is intended to be
674 useful for editing binary files."
677 ;; Avoid "obsolete" warnings for translation-table-for-input.
684 ;; This used to assume character codes 0240 - 0377 stand for
685 ;; characters in some single-byte character set, and converted them
686 ;; to Emacs characters. But in 23.1 this feature is deprecated
687 ;; in favor of inserting the corresponding Unicode characters.
688 ;; (if (and enable-multibyte-characters
689 ;; (>= char ?\240)
690 ;; (<= char ?\377))
691 ;; (setq char (unibyte-char-to-multibyte char)))
700 "Move forward ARG lines and position at first nonblank character."
706 "Move backward ARG lines and position at first nonblank character."
712 "Move point to the first non-whitespace character on this line."
716 ;; Move back over chars that have whitespace syntax but have the p flag.
720 "Fixup white space between objects around point.
721 Leave one space or none, according to the context."
728 nil
732 "Delete all spaces and tabs around point.
733 If BACKWARD-ONLY is non-nil, only delete them before point."
738 orig-pos
747 "Delete all spaces and tabs around point, leaving one space (or N spaces).
748 If N is negative, delete newlines as well."
765 \f
767 "Move point to the beginning of the buffer.
768 With numeric arg N, put point N/10 of the way from the beginning.
769 If the buffer is narrowed, this command uses the beginning of the
770 accessible part of the buffer.
772 If Transient Mark mode is disabled, leave mark at previous
775 Don't use this command in Lisp programs!
776 \(goto-char (point-min)) is faster."
785 ;; Avoid overflow for large buffer sizes!
793 "Move point to the end of the buffer.
794 With numeric arg N, put point N/10 of the way from the end.
795 If the buffer is narrowed, this command uses the end of the
796 accessible part of the buffer.
798 If Transient Mark mode is disabled, leave mark at previous
801 Don't use this command in Lisp programs!
802 \(goto-char (point-max)) is faster."
809 ;; Avoid overflow for large buffer sizes!
814 ;; If we went to a place in the middle of the buffer,
815 ;; adjust it to the beginning of a line.
818 ;; If the end of the buffer is not already on the screen,
819 ;; then scroll specially to put it near, but not at, the bottom.
824 "Whether single-char deletion commands delete an active region.
825 This has an effect only if Transient Mark mode is enabled, and
826 affects `delete-forward-char' and `delete-backward-char', though
827 not `delete-char'.
829 If the value is the symbol `kill', the active region is killed
830 instead of deleted."
838 "Delete the previous N characters (following if N is negative).
839 If Transient Mark mode is enabled, the mark is active, and N is 1,
840 delete the text in the region and deactivate the mark instead.
841 To disable this, set `delete-active-region' to nil.
843 Optional second arg KILLFLAG, if non-nil, means to kill (save in
844 kill ring) instead of delete. Interactively, N is the prefix
845 arg, and KILLFLAG is set if N is explicitly specified.
847 In Overwrite mode, single character backward deletion may replace
848 tabs with spaces so as to back over columns, unless point is at
849 the end of the line."
854 delete-active-region
856 ;; If a region is active, kill or delete it.
860 ;; In Overwrite mode, maybe untabify while deleting
870 ;; Otherwise, do simple deletion.
874 "Delete the following N characters (previous if N is negative).
875 If Transient Mark mode is enabled, the mark is active, and N is 1,
876 delete the text in the region and deactivate the mark instead.
877 To disable this, set `delete-active-region' to nil.
879 Optional second arg KILLFLAG non-nil means to kill (save in kill
880 ring) instead of delete. Interactively, N is the prefix arg, and
881 KILLFLAG is set if N was explicitly specified."
886 delete-active-region
888 ;; If a region is active, kill or delete it.
892 ;; Otherwise, do simple deletion.
896 "Put point at beginning and mark at end of buffer.
897 If narrowing is in effect, only uses the accessible part of the buffer.
898 You probably should not use this function in Lisp programs;
899 it is usually a mistake for a Lisp function to use any subroutine
900 that uses or sets the mark."
905 \f
907 ;; Counting lines, one way or another.
910 "Go to LINE, counting from line 1 at beginning of buffer.
911 If called interactively, a numeric prefix argument specifies
912 LINE; without a numeric prefix argument, read LINE from the
913 minibuffer.
915 If optional argument BUFFER is non-nil, switch to that buffer and
917 as argument, BUFFER is the most recently selected other buffer.
919 Prior to moving point, this function sets the mark (without
920 activating it), unless Transient Mark mode is enabled and the
921 mark is already active.
923 This function is usually the wrong thing to use in a Lisp program.
924 What you probably want instead is something like:
925 (goto-char (point-min))
926 (forward-line (1- N))
927 If at all possible, an even better solution is to use char counts
928 rather than line counts."
932 ;; Look for a default, a number in the buffer at point.
942 ;; Decide if we're switching buffers.
950 ;; Read the argument, offering that number (if any) as default.
953 buffer))))
954 ;; Switch to the desired buffer, one way or another.
959 ;; Leave mark at previous position
961 ;; Move to the specified line number in that buffer.
970 "Count the number of words in the region.
971 If called interactively, print a message reporting the number of
972 lines, words, and chars in the region.
973 If called from Lisp, return the number of words between positions
974 START and END."
981 "Count words between START and END.
982 If called interactively, START and END are normally the start and
983 end of the buffer; but if the region is active, START and END are
984 the start and end of the region. Print a message reporting the
985 number of lines, words, and chars.
987 If called from Lisp, return the number of words between START and
988 END, without printing any message."
998 words))
1004 "Buffer"
1013 str
1021 "Print the current buffer line number and narrowed line number of point."
1034 "Return number of lines between START and END.
1035 This is usually the number of newlines between them,
1036 but can be one more if START is not equal to END
1037 and the greater of them is not at the start of a line."
1053 done)))
1057 "Return (narrowed) buffer line number at position POS.
1058 If POS is nil, use current buffer location.
1059 Counting starts at (point-min), so the value refers
1060 to the contents of the accessible portion of the buffer."
1070 "Print info on cursor position (on screen and within buffer).
1071 Also describe the character after point, and give its character code
1072 in octal, decimal and hex.
1074 For a non-ASCII multibyte character, also give its encoding in the
1075 buffer's selected coding system if the coding system encodes the
1076 character safely. If the character is encoded into one byte, that
1077 code is shown in hex. If the character is encoded into more than one
1080 In addition, with prefix argument, show details about that character
1081 in *Help* buffer. See also the command `describe-char'."
1086 ;; If the character is one of LRE, LRO, RLE, RLO, it
1087 ;; will start a directional embedding, which could
1088 ;; completely disrupt the rest of the line (e.g., RLO
1089 ;; will display the rest of the line right-to-left).
1090 ;; So we put an invisible PDF character after these
1091 ;; characters, to end the embedding, which eliminates
1092 ;; any effects on the rest of the line.
1094 ;; Strong right-to-left characters cause reordering of
1095 ;; the following numerical characters which show the
1096 ;; codepoint, so append LRM to countermand that.
1106 ;; Avoid overflow from multiplying by 100!
1110 ""
1116 pos total percent beg end col hscroll)
1118 pos total col hscroll))
1120 encoded encoding-msg display-prop under-display)
1127 ;; Check if the character is displayed with some `display'
1128 ;; text property. In that case, set under-display to the
1129 ;; buffer substring covered by that property.
1140 under-display)))
1146 char char char under-display)
1148 char char char under-display display-prop))
1151 char char char
1153 "..."
1157 ;; We show the detailed information about CHAR.
1164 bidi-fixer
1165 encoding-msg pos total percent beg end col hscroll)
1172 bidi-fixer encoding-msg pos total percent col hscroll))))))
1173 \f
1174 ;; Initialize read-expression-map. It is defined at C level.
1177 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1178 ;; too rarely useful.
1188 "The current default value or list of default values in the minibuffer.
1189 The functions `read-from-minibuffer' and `completing-read' bind
1193 "Value for `print-level' while printing value in `eval-expression'.
1194 A value of nil means no limit."
1200 "Value for `print-length' while printing value in `eval-expression'.
1201 A value of nil means no limit."
1207 "If non-nil set `debug-on-error' to t in `eval-expression'.
1208 If nil, don't change the value of `debug-on-error'."
1214 "Format VALUE as a result of evaluated expression.
1215 Return a formatted string which is displayed in the echo area
1216 in addition to the value printed by prin1 in functions which
1217 display the result of expression evaluation."
1230 ;; We define this, rather than making `eval' interactive,
1231 ;; for the sake of completion of names like eval-region, eval-buffer.
1234 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1235 When called interactively, read an Emacs Lisp expression and
1236 evaluate it.
1237 Value is also consed on to front of the variable `values'.
1238 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1239 with prefix argument) means insert the result into the current buffer
1240 instead of printing it in the echo area. Truncates long output
1241 according to the value of the variables `eval-expression-print-length'
1242 and `eval-expression-print-level'.
1244 If `eval-expression-debug-on-error' is non-nil, which is the default,
1245 this command arranges for all errors to enter the debugger."
1249 nil read-expression-map t
1251 current-prefix-arg))
1256 ;; Bind debug-on-error to something unique so that we can
1257 ;; detect when evalled code changes it.
1261 ;; If evalled code has changed the value of debug-on-error,
1262 ;; propagate that change to the global binding.
1278 "Prompting with PROMPT, let user edit COMMAND and eval result.
1279 COMMAND is a Lisp expression. Let user edit that expression in
1280 the minibuffer, then read and evaluate the result."
1287 read-expression-map t
1289 ;; If command was added to command-history as a string,
1290 ;; get rid of that. We want only evaluable expressions there.
1294 ;; If command to be redone does not match front of history,
1295 ;; add it to the history.
1301 "Edit and re-evaluate last complex command, or ARGth from last.
1302 A complex command is one which used the minibuffer.
1303 The command is placed in the minibuffer as a Lisp form for editing.
1304 The result is executed, repeating the command as changed.
1305 If the command has been changed or is not the most recent previous
1306 command it is added to the front of the command history.
1307 You can use the minibuffer history commands \
1309 to get different commands to edit and resubmit."
1312 newcmd)
1324 ;; If command was added to command-history as a
1325 ;; string, get rid of that. We want only
1326 ;; evaluable expressions there.
1330 ;; If command to be redone does not match front of history,
1331 ;; add it to the history.
1340 "Read command name to invoke in `execute-extended-command'."
1345 ;; Get a command name at point in the original buffer
1346 ;; to propose it after M-n.
1350 ;; Read a string, completing from and restricting to the set of
1351 ;; all defined commands. Don't provide any initial input.
1352 ;; Save the command read on the extended-command history list.
1363 ;; This isn't strictly correct if `execute-extended-command'
1364 ;; is bound to anything else (e.g. [menu]).
1365 ;; It could use (key-description (this-single-command-keys)),
1366 ;; but actually a prompt other than "M-x" would be confusing,
1367 ;; because "M-x" is a well-known prompt to read a command
1368 ;; and it serves as a shorthand for "Extended command: ".
1373 "Non-nil means show the equivalent key-binding when M-x command has one.
1374 The value can be a length of time to show the message for.
1375 If the value is non-nil and not a number, we wait 2 seconds."
1382 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1383 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1384 "Read function name, then read its arguments and call it.
1386 To pass a numeric argument to the command you are invoking with, specify
1387 the numeric argument to this command.
1389 Noninteractively, the argument PREFIXARG is the prefix argument to
1390 give to the command you invoke, if it asks for an argument."
1392 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1401 ;; Normally `real-this-command' should never be changed, but here we really
1402 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1403 ;; binding" for <cmd>, so the command the user really wanted to run is
1404 ;; `function' and not `execute-extended-command'. The difference is
1405 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1409 ;; If enabled, show which key runs this command.
1411 ;; But first wait, and skip the message if there is input.
1413 ;; If this command displayed something in the echo area;
1414 ;; wait a few seconds, then display our suggestion message.
1424 suggest-key-bindings
1426 \f
1428 "Default minibuffer history list.
1429 This is used for all minibuffer input
1430 except when an alternate history list is specified.
1432 Maximum length of the history list is determined by the value
1435 "Control whether history list elements are expressions or strings.
1436 If the value of this variable equals current minibuffer depth,
1437 they are expressions; otherwise they are strings.
1438 \(That convention is designed to do the right thing for
1445 "Text that was in this minibuffer before any history commands.
1446 This is nil if there have not yet been any history commands
1455 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1459 "Minibuffer history variables for which matching should ignore case.
1460 If a history variable is a member of this list, then the
1462 commands ignore case when searching it, regardless of `case-fold-search'."
1467 "Find the previous history element that matches REGEXP.
1468 \(Previous history elements refer to earlier actions.)
1469 With prefix argument N, search for Nth previous match.
1470 If N is negative, find the next or Nth next match.
1471 Normally, history elements are matched case-insensitively if
1472 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1473 makes the search case-sensitive.
1474 See also `minibuffer-history-case-insensitive-variables'."
1478 nil
1479 minibuffer-local-map
1480 nil
1481 'minibuffer-history-search-history
1483 ;; Use the last regexp specified, by default, if input is empty.
1488 regexp)
1498 ;; On some systems, ignore case for file names.
1500 minibuffer-history-case-insensitive-variables)
1501 t
1502 ;; Respect the user's setting for case-fold-search:
1503 case-fold-search)
1504 nil))
1505 prevpos
1506 match-string
1507 match-offset
1514 "No later matching history item"
1535 next-matching-history-element))
1539 "Find the next history element that matches REGEXP.
1540 \(The next history element refers to a more recent action.)
1541 With prefix argument N, search for Nth next match.
1542 If N is negative, find the previous or Nth previous match.
1543 Normally, history elements are matched case-insensitively if
1544 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1545 makes the search case-sensitive."
1549 nil
1550 minibuffer-local-map
1551 nil
1552 'minibuffer-history-search-history
1554 ;; Use the last regexp specified, by default, if input is empty.
1559 regexp)
1566 "Function run by `goto-history-element' before consuming default values.
1567 This is useful to dynamically add more elements to the list of default values
1568 when `goto-history-element' reaches the end of this list.
1569 Before calling this function `goto-history-element' sets the variable
1570 `minibuffer-default-add-done' to t, so it will call this function only
1571 once. In special cases, when this function needs to be called more
1572 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1576 "When nil, add more elements to the end of the list of default values.
1577 The value nil causes `goto-history-element' to add more elements to
1578 the list of defaults when it reaches the end of this list. It does
1584 "Return a list of all completions without the default value.
1585 This function is used to add all elements of the completion table to
1586 the end of the list of defaults just after the default value."
1589 minibuffer-completion-table
1590 minibuffer-completion-predicate)))
1596 "Puts element of the minibuffer history in the minibuffer.
1597 The argument NABS specifies the absolute history position."
1611 elt minibuffer-returned-to-present)
1618 "End of defaults; no next item"
1623 previous-history-element))
1635 minibuffer-default)))
1647 elt))
1651 "Puts next element of the minibuffer history in the minibuffer.
1652 With argument N, it uses the Nth following element."
1658 "Puts previous element of the minibuffer history in the minibuffer.
1659 With argument N, it uses the Nth previous element."
1665 "Get next history element which completes the minibuffer before the point.
1666 The contents of the minibuffer after the point are deleted, and replaced
1667 by the new completion."
1673 n)
1674 ;; next-matching-history-element always puts us at (point-min).
1675 ;; Move to the position we were at before changing the buffer contents.
1676 ;; This is still sensible, because the text before point has not changed.
1680 "\
1681 Get previous history element which completes the minibuffer before the point.
1682 The contents of the minibuffer after the point are deleted, and replaced
1683 by the new completion."
1687 ;; For compatibility with the old subr of the same name.
1689 "Return the display width of the minibuffer prompt.
1690 Return 0 if current buffer is not a minibuffer."
1691 ;; Return the width of everything before the field at the end of
1692 ;; the buffer; this should be 0 for normal buffers.
1694 \f
1695 ;; isearch minibuffer history
1702 "Set up a minibuffer for using isearch to search the minibuffer history.
1703 Intended to be added to `minibuffer-setup-hook'."
1715 "Clean up the minibuffer after terminating isearch in the minibuffer."
1720 "Return the proper search function, for isearch in minibuffer history."
1723 ;; Use standard functions to search within minibuffer text
1725 found)
1726 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1727 ;; searching forward. Lazy-highlight calls this lambda with the
1728 ;; bound arg, so skip the minibuffer prompt.
1732 ;; 1. First try searching in the initial minibuffer text
1735 noerror)
1736 ;; 2. If the above search fails, start putting next/prev history
1737 ;; elements in the minibuffer successively, and search the string
1738 ;; in them. Do this only when bound is nil (i.e. not while
1739 ;; lazy-highlighting search strings in the current minibuffer text).
1751 ;; After putting the next/prev history element, search
1752 ;; the string in them again, until next-history-element
1753 ;; or previous-history-element raises an error at the
1754 ;; beginning/end of history.
1757 ;; For backward search, don't search
1758 ;; in the minibuffer prompt
1760 noerror)))
1761 ;; Return point of the new search result
1763 ;; Return nil when next(prev)-history-element fails
1767 "Display the minibuffer history search prompt.
1768 If there are no search errors, this function displays an overlay with
1769 the isearch prompt which replaces the original minibuffer prompt.
1770 Otherwise, it displays the standard isearch message returned from
1771 `isearch-message'."
1773 ;; Use standard function `isearch-message' when not in the minibuffer,
1774 ;; or search fails, or has an error (like incomplete regexp).
1775 ;; This function overwrites minibuffer text with isearch message,
1776 ;; so it's possible to see what is wrong in the search string.
1778 ;; Otherwise, put the overlay with the standard isearch prompt over
1779 ;; the initial minibuffer prompt.
1788 ;; And clear any previous isearch message.
1792 "Wrap the minibuffer history search when search fails.
1793 Move point to the first history element for a forward search,
1794 or to the last history element for a backward search."
1795 ;; When `minibuffer-history-isearch-search' fails on reaching the
1796 ;; beginning/end of the history, wrap the search to the first/last
1797 ;; minibuffer history element.
1805 "Save a function restoring the state of minibuffer history search.
1806 Save `minibuffer-history-position' to the additional state parameter
1807 in the search status stack."
1812 "Restore the minibuffer history search state.
1813 Go to the history element by the absolute history position HIST-POS."
1816 \f
1817 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1821 "Table mapping redo records to the corresponding undo one.
1822 A redo record for undo-in-region maps to t.
1832 "Within a run of consecutive undo commands, list remaining to be undone.
1836 "Undo some previous changes.
1837 Repeat this command to undo more changes.
1838 A numeric ARG serves as a repeat count.
1840 In Transient Mark mode when the mark is active, only undo changes within
1842 as an argument limits undo to changes within the current region."
1844 ;; Make last-command indicate for the next command that this was an undo.
1845 ;; That way, another undo will undo more.
1846 ;; If we get to the end of the undo history and get an error,
1847 ;; another undo command will find the undo history empty
1848 ;; and will get another error. To begin undoing the undos,
1849 ;; you must type some other command.
1852 message)
1853 ;; If we get an error in undo-start,
1854 ;; the next command should not be a "consecutive undo".
1855 ;; So set `this-command' to something other than `undo'.
1860 ;; If something (a timer or filter?) changed the buffer
1861 ;; since the previous command, don't continue the undo seq.
1865 ;; If the last undo record made was made by undo
1866 ;; it shows nothing else happened in between.
1873 ;; get rid of initial undo boundary
1875 ;; If we got this far, the next command should be a consecutive undo.
1877 ;; Check to see whether we're hitting a redo record, and if
1878 ;; so, ask the user whether she wants to skip the redo/undo pair.
1885 ;; The equiv entry might point to another redo record if we have done
1886 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1894 ;; Record the fact that the just-generated undo records come from an
1895 ;; undo operation--that is, they are redo records.
1896 ;; In the ordinary case (not within a region), map the redo
1897 ;; record to the following undos.
1898 ;; I don't know how to do that in the undo-in-region case.
1900 ;; Strip any leading undo boundaries there might be, like we do
1901 ;; above when checking.
1905 undo-equiv-table))
1906 ;; Don't specify a position in the undo record for the undo command.
1907 ;; Instead, undoing this should move point to where the change is.
1926 ;; Record what the current undo list says,
1927 ;; so the next command can tell if the buffer was modified in between.
1930 ;; Display a message announcing success.
1935 "Make BUFFER stop keeping undo information.
1936 No argument or nil as argument means do this for the current buffer."
1942 "Undo some previous changes.
1943 Repeat this command to undo more changes.
1944 A numeric ARG serves as a repeat count.
1945 Contrary to `undo', this will not redo a previous undo."
1950 "Non-nil while performing an undo.
1954 "Undo back N undo-boundaries beyond what was already undone recently.
1955 Call `undo-start' to get ready to undo recent changes,
1956 then call `undo-more' one or more times to undo them."
1961 ;; Note: The following, while pulling elements off
1962 ;; `pending-undo-list' will call primitive change functions which
1963 ;; will push more elements onto `buffer-undo-list'.
1968 ;; Deep copy of a list
1970 "Make a copy of undo list LIST."
1976 elt))
1979 "Set `pending-undo-list' to the front of the undo list.
1980 The next call to `undo-more' will undo the most recently made change.
1981 If BEG and END are specified, then only undo elements
1982 that apply to text between BEG and END are used; other undo elements
1983 are ignored. If BEG and END are nil, all undo elements are used."
1989 buffer-undo-list)))
1994 "Return a list of undo elements for the region START to END.
1995 The elements come from `buffer-undo-list', but we keep only
1996 the elements inside this region, and discard those outside this region.
1997 If we find an element that crosses an edge of this region,
1998 we stop and ignore all further elements."
2001 undo-adjusted-markers
2002 some-rejected
2003 undo-elt temp-undo-list delta)
2008 ;; This is a "was unmodified" element.
2009 ;; Keep it if we have kept everything thus far.
2016 ;; Don't put two nils together in the list
2030 ;; Loop down the earlier events adjusting their buffer
2031 ;; positions to reflect the fact that a change to the buffer
2032 ;; isn't being undone. We only need to process those element
2033 ;; types which undo-elt-in-region will return as being in
2034 ;; the region since only those types can ever get into the
2035 ;; output
2044 ;; (TEXT . POSITION)
2051 ;; (BEGIN . END)
2056 ;; (nil PROPERTY VALUE BEG . END)
2066 "Determine whether UNDO-ELT falls inside the region START ... END.
2067 If it crosses the edge, we return nil."
2072 t)
2074 nil)
2076 ;; (TEXT . POSITION)
2080 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2081 ;; See if MARKER is inside the region.
2092 ;; (nil PROPERTY VALUE BEG . END)
2097 ;; (BEGIN . END)
2102 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2103 This assumes we have already decided that UNDO-ELT
2104 is not *inside* the region START...END."
2107 ;; (nil PROPERTY VALUE BEG . END)
2112 ;; (BEGIN . END)
2116 ;; Return the first affected buffer position and the delta for an undo element
2117 ;; delta is defined as the change in subsequent buffer positions if we *did*
2118 ;; the undo.
2122 ;; (TEXT . POSITION)
2125 ;; (BEGIN . END)
2132 "If non-nil ask about discarding undo info for the current command.
2133 Normally, Emacs discards the undo info for the current command if
2134 it exceeds `undo-outer-limit'. But if you set this option
2135 non-nil, it asks in the echo area whether to discard the info.
2136 If you answer no, there is a slight risk that Emacs might crash, so
2137 only do it if you really want to undo the command.
2139 This option is mainly intended for debugging. You have to be
2140 careful if you use it for other purposes. Garbage collection is
2141 inhibited while the question is asked, meaning that Emacs might
2142 leak memory. So you should make sure that you do not wait
2143 excessively long before answering the question."
2149 "If non-nil, an extra level of size that's ok in an undo item.
2150 We don't ask the user about truncating the undo list until the
2151 current item gets bigger than this amount.
2156 ;; When the first undo batch in an undo list is longer than
2157 ;; undo-outer-limit, this function gets called to warn the user that
2158 ;; the undo info for the current command was discarded. Garbage
2159 ;; collection is inhibited around the call, so it had better not do a
2160 ;; lot of consing.
2166 ;; Don't ask the question again unless it gets even bigger.
2167 ;; This applies, in particular, if the user quits from the question.
2168 ;; Such a quit quits out of GC, but something else will call GC
2169 ;; again momentarily. It will call this function again,
2170 ;; but we don't want to ask the question again.
2177 t)
2178 nil))
2183 "The undo info was discarded because it exceeded \
2184 `undo-outer-limit'.
2186 This is normal if you executed a command that made a huge change
2187 to the buffer. In that case, to prevent similar problems in the
2188 future, set `undo-outer-limit' to a value that is large enough to
2189 cover the maximum size of normal changes you expect a single
2190 command to make, but not so large that it might exceed the
2191 maximum memory allotted to Emacs.
2193 If you did not execute any such command, the situation is
2194 probably due to a bug and you should report it.
2196 You can disable the popping up of this buffer by adding the entry
2197 \(undo discard-info) to the user option `warning-suppress-types',
2201 t))
2202 \f
2204 "History list for some commands that read shell commands.
2206 Maximum length of the history list is determined by the value
2213 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2214 This buffer is used when `shell-command' or `shell-command-on-region'
2215 is run interactively. A value of nil means that output to stderr and
2222 "Return a list of all commands associated with the current file.
2223 This function is used to add all related commands retrieved by `mailcap'
2224 to the end of the list of defaults just after the default value."
2228 minibuffer-default))
2233 commands))
2244 map)
2248 "Read a shell command from the minibuffer.
2249 The arguments are the same as the ones of `read-from-minibuffer',
2250 except READ and KEYMAP are missing and HIST defaults
2251 to `shell-command-history'."
2259 minibuffer-local-shell-command-map
2260 nil
2262 args)))
2265 "What to do when the output buffer is used by another shell command.
2266 This option specifies how to resolve the conflict where a new command
2267 wants to direct its output to the buffer `*Async Shell Command*',
2268 but this buffer is already taken by another running shell command.
2270 The value `confirm-kill-process' is used to ask for confirmation before
2271 killing the already running process and running a new process
2272 in the same buffer, `confirm-new-buffer' for confirmation before running
2273 the command in a new buffer with a name other than the default buffer name,
2274 `new-buffer' for doing the same without confirmation,
2275 `confirm-rename-buffer' for confirmation before renaming the existing
2276 output buffer and running a new command in the default buffer,
2277 `rename-buffer' for doing the same without confirmation."
2279 confirm-kill-process)
2281 confirm-new-buffer)
2283 new-buffer)
2285 confirm-rename-buffer)
2287 rename-buffer))
2292 "Execute string COMMAND asynchronously in background.
2294 Like `shell-command', but adds `&' at the end of COMMAND
2295 to execute it asynchronously.
2297 The output appears in the buffer `*Async Shell Command*'.
2298 That buffer is in shell mode.
2300 In Elisp, you will often be better served by calling `start-process'
2301 directly, since it offers more control and does not impose the use of a
2302 shell (with its need to quote arguments)."
2312 current-prefix-arg
2313 shell-command-default-error-buffer))
2319 "Execute string COMMAND in inferior shell; display output, if any.
2320 With prefix argument, insert the COMMAND's output at point.
2322 If COMMAND ends in `&', execute it asynchronously.
2323 The output appears in the buffer `*Async Shell Command*'.
2324 That buffer is in shell mode. You can also use
2325 `async-shell-command' that automatically adds `&'.
2327 Otherwise, COMMAND is executed synchronously. The output appears in
2328 the buffer `*Shell Command Output*'. If the output is short enough to
2329 display in the echo area (which is determined by the variables
2330 `resize-mini-windows' and `max-mini-window-height'), it is shown
2331 there, but it is nonetheless available in buffer `*Shell Command
2332 Output*' even though that buffer is not automatically displayed.
2334 To specify a coding system for converting non-ASCII characters
2336 before this command.
2338 Noninteractive callers can specify coding systems by binding
2339 `coding-system-for-read' and `coding-system-for-write'.
2341 The optional second argument OUTPUT-BUFFER, if non-nil,
2342 says to put the output in some other buffer.
2343 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2344 If OUTPUT-BUFFER is not a buffer and not nil,
2345 insert output in current buffer. (This cannot be done asynchronously.)
2346 In either case, the buffer is first erased, and the output is
2347 inserted after point (leaving mark after it).
2349 If the command terminates without error, but generates output,
2351 the output can be displayed in the echo area or in its buffer.
2352 If the output is short enough to display in the echo area
2353 \(determined by the variable `max-mini-window-height' if
2354 `resize-mini-windows' is non-nil), it is shown there.
2355 Otherwise,the buffer containing the output is displayed.
2359 of the output.
2361 If there is no output, or if output is inserted in the current buffer,
2362 then `*Shell Command Output*' is deleted.
2364 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2365 or buffer name to which to direct the command's standard error output.
2366 If it is nil, error output is mingled with regular output.
2367 In an interactive call, the variable `shell-command-default-error-buffer'
2368 specifies the value of ERROR-BUFFER.
2370 In Elisp, you will often be better served by calling `call-process' or
2371 `start-process' directly, since it offers more control and does not impose
2372 the use of a shell (with its need to quote arguments)."
2383 current-prefix-arg
2384 shell-command-default-error-buffer))
2385 ;; Look for a handler in case default-directory is a remote file name.
2393 ;; Output goes in current buffer.
2399 temporary-file-directory)))
2400 nil)))
2403 ;; We do not use -f for csh; we will not support broken use of
2404 ;; .cshrcs. Even the BSD csh manual says to use
2405 ;; "if ($?prompt) exit" before things which are not useful
2406 ;; non-interactively. Besides, if someone wants their other
2407 ;; aliases for shell commands then they can still have them.
2411 t)
2412 nil shell-command-switch command)
2419 ;; Do no formatting while reading error file,
2420 ;; because that can run a shell command, and we
2421 ;; don't want that to cause an infinite recursion.
2423 ;; Put point after the inserted errors.
2427 ;; This is like exchange-point-and-mark, but doesn't
2428 ;; activate the mark. It is cleaner to avoid activation,
2429 ;; even though the command loop would deactivate the mark
2430 ;; because we inserted text.
2434 ;; Output goes in a separate buffer.
2435 ;; Preserve the match data in case called from a program.
2438 ;; Command ending with ampersand means asynchronous.
2442 proc)
2443 ;; Remove the ampersand.
2445 ;; Ask the user what to do with already running process.
2450 ;; If will kill a process, query first.
2455 ;; If will create a new buffer, query first.
2461 ;; It will create a new buffer.
2465 ;; If will rename the buffer, query first.
2474 ;; It will rename the buffer.
2481 ;; Setting buffer-read-only to nil doesn't suffice
2482 ;; if some text has a non-nil read-only property,
2483 ;; which comint sometimes adds for prompts.
2489 shell-command-switch command))
2493 ;; Use the comint filter for proper handling of carriage motion
2494 ;; (see `comint-inhibit-carriage-motion'),.
2496 ))
2497 ;; Otherwise, command is executed synchronously.
2499 output-buffer nil error-buffer)))))))
2503 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2504 MESSAGE may be either a string or a buffer.
2506 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2507 the maximum height of the echo area, as defined by `max-mini-window-height'
2508 if `resize-mini-windows' is non-nil.
2510 Returns either the string shown in the echo area, or when a pop-up
2511 buffer is used, the window used to display it.
2513 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2514 name of the buffer used to display it in the case where a pop-up buffer
2515 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2516 string and it is displayed in the echo area, it is not specified whether
2517 the contents are inserted into the buffer anyway.
2519 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2520 and only used if a buffer is displayed."
2522 ;; Trivial case where we can use the echo area
2526 ;; Trivial case where we can just remove single trailing newline
2529 ;; General case
2532 message
2541 0
2545 (<= lines
2549 max-mini-window-height))
2551 max-mini-window-height)
2555 ;; Don't use the echo area if the output buffer is
2556 ;; already displayed in the selected frame.
2558 ;; Echo area
2564 ;; Buffer
2567 not-this-window frame))))))))
2570 ;; We have a sentinel to prevent insertion of a termination message
2571 ;; in the buffer itself.
2579 &optional output-buffer replace
2580 error-buffer display-error-buffer)
2581 "Execute string COMMAND in inferior shell with region as input.
2582 Normally display output (if any) in temp buffer `*Shell Command Output*';
2583 Prefix arg means replace the region with it. Return the exit code of
2584 COMMAND.
2586 To specify a coding system for converting non-ASCII characters
2588 before this command. By default, the input (from the current buffer)
2589 is encoded using coding-system specified by `process-coding-system-alist',
2590 falling back to `default-process-coding-system' if no match for COMMAND
2591 is found in `process-coding-system-alist'.
2593 The noninteractive arguments are START, END, COMMAND,
2594 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2595 Noninteractive callers can specify coding systems by binding
2596 `coding-system-for-read' and `coding-system-for-write'.
2598 If the command generates output, the output may be displayed
2599 in the echo area or in a buffer.
2600 If the output is short enough to display in the echo area
2601 \(determined by the variable `max-mini-window-height' if
2602 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2603 it is displayed in the buffer `*Shell Command Output*'. The output
2604 is available in that buffer in both cases.
2606 If there is output and an error, a message about the error
2607 appears at the end of the output.
2609 If there is no output, or if output is inserted in the current buffer,
2610 then `*Shell Command Output*' is deleted.
2612 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2613 that says to put the output in some other buffer.
2614 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2615 If OUTPUT-BUFFER is not a buffer and not nil,
2616 insert output in the current buffer.
2617 In either case, the output is inserted after point (leaving mark after it).
2619 If REPLACE, the optional fifth argument, is non-nil, that means insert
2620 the output in place of text from START to END, putting point and mark
2621 around it.
2623 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2624 or buffer name to which to direct the command's standard error output.
2625 If it is nil, error output is mingled with regular output.
2626 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2627 were any errors. (This is always t, interactively.)
2628 In an interactive call, the variable `shell-command-default-error-buffer'
2629 specifies the value of ERROR-BUFFER."
2633 ;; Do this before calling region-beginning
2634 ;; and region-end, in case subprocess output
2635 ;; relocates them while we are in the minibuffer.
2637 ;; call-interactively recognizes region-beginning and
2638 ;; region-end specially, leaving them in the history.
2640 string
2641 current-prefix-arg
2642 current-prefix-arg
2643 shell-command-default-error-buffer
2644 t)))
2650 temporary-file-directory)))
2651 nil))
2652 exit-status)
2656 ;; Replace specified region with output from command.
2658 ;; Don't muck with mark unless REPLACE says we should.
2665 t)
2666 nil shell-command-switch command))
2667 ;; It is rude to delete a buffer which the command is not using.
2668 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2669 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2670 ;; (kill-buffer shell-buffer)))
2671 ;; Don't muck with mark unless REPLACE says we should.
2673 ;; No prefix argument: put the output in a temp buffer,
2674 ;; replacing its entire contents.
2679 ;; If the input is the same buffer as the output,
2680 ;; delete everything but the specified region,
2681 ;; then replace that region with the output.
2687 shell-file-name t
2690 t)
2691 nil shell-command-switch
2692 command)))
2693 ;; Clear the output buffer, then run the command with
2694 ;; output there.
2705 buffer)
2706 nil shell-command-switch command)))
2707 ;; Report the output.
2717 ;; There's some output, display it
2719 ;; No output; error?
2726 shell-command-default-error-buffer)
2733 output))
2736 exit-status))
2739 exit-status output))))
2740 ;; Don't kill: there might be useful info in the undo-log.
2741 ;; (kill-buffer buffer)
2742 ))))
2750 ;; Do no formatting while reading error file,
2751 ;; because that can run a shell command, and we
2752 ;; don't want that to cause an infinite recursion.
2754 ;; Put point after the inserted errors.
2759 exit-status))
2762 "Execute shell command COMMAND and return its output as a string."
2765 standard-output
2769 "Process files synchronously in a separate process.
2770 Similar to `call-process', but may invoke a file handler based on
2771 `default-directory'. The current working directory of the
2772 subprocess is `default-directory'.
2774 File names in INFILE and BUFFER are handled normally, but file
2775 names in ARGS should be relative to `default-directory', as they
2776 are passed to the process verbatim. \(This is a difference to
2777 `call-process' which does not support file handlers for INFILE
2778 and BUFFER.\)
2780 Some file handlers might not support all variants, for example
2781 they might behave as if DISPLAY was nil, regardless of the actual
2782 value passed."
2784 lc stderr-file)
2794 display args)
2800 "Whether a call of `process-file' changes remote files.
2802 By default, this variable is always set to `t', meaning that a
2803 call of `process-file' could potentially change any file on a
2804 remote host. When set to `nil', a file handler could optimize
2805 its behavior with respect to remote file attribute caching.
2807 You should only ever change this variable with a let-binding;
2811 "Start a program in a subprocess. Return the process object for it.
2813 Similar to `start-process', but may invoke a file handler based on
2814 `default-directory'. See Info node `(elisp)Magic File Names'.
2816 This handler ought to run PROGRAM, perhaps on the local host,
2817 perhaps on a remote host that corresponds to `default-directory'.
2818 In the latter case, the local part of `default-directory' becomes
2819 the working directory of the process.
2821 PROGRAM and PROGRAM-ARGS might be file names. They are not
2822 objects of file handler invocation. File handlers might not
2823 support pty association, if PROGRAM is nil."
2827 \f
2828 ;;;; Process menu
2840 "Major mode for listing the processes called by Emacs."
2852 "Recompute the list of processes for the Process List buffer.
2853 Also, delete any process that is exited or signaled."
2866 face link
2869 follow-link t
2870 process-buffer ,buf
2871 action process-menu-visit-buffer)
2880 "datagram"
2897 tabulated-list-entries))))))
2903 "Display a list of all processes.
2904 If optional argument QUERY-ONLY is non-nil, only processes with
2905 the query-on-exit flag set are listed.
2906 Any process listed as exited or signaled is actually eliminated
2907 after the listing is made.
2908 Optional argument BUFFER specifies a buffer to use, instead of
2910 The return value is always nil."
2922 nil)
2923 \f
2927 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2928 (define-key map [switch-frame] nil)
2929 (define-key map [?\C-u] 'universal-argument-more)
2930 (define-key map [?-] 'universal-argument-minus)
2931 (define-key map [?0] 'digit-argument)
2932 (define-key map [?1] 'digit-argument)
2933 (define-key map [?2] 'digit-argument)
2934 (define-key map [?3] 'digit-argument)
2935 (define-key map [?4] 'digit-argument)
2936 (define-key map [?5] 'digit-argument)
2937 (define-key map [?6] 'digit-argument)
2938 (define-key map [?7] 'digit-argument)
2939 (define-key map [?8] 'digit-argument)
2940 (define-key map [?9] 'digit-argument)
2941 (define-key map [kp-0] 'digit-argument)
2942 (define-key map [kp-1] 'digit-argument)
2943 (define-key map [kp-2] 'digit-argument)
2944 (define-key map [kp-3] 'digit-argument)
2945 (define-key map [kp-4] 'digit-argument)
2946 (define-key map [kp-5] 'digit-argument)
2947 (define-key map [kp-6] 'digit-argument)
2948 (define-key map [kp-7] 'digit-argument)
2949 (define-key map [kp-8] 'digit-argument)
2950 (define-key map [kp-9] 'digit-argument)
2951 (define-key map [kp-subtract] 'universal-argument-minus)
2952 map)
2955 (defvar universal-argument-num-events nil
2956 "Number of argument-specifying events read by `universal-argument'.
2957 `universal-argument-other-key' uses this to discard those events
2958 from (this-command-keys), and reread only the final command.")
2960 (defvar saved-overriding-map t
2961 "The saved value of `overriding-terminal-local-map'.
2965 (defun save&set-overriding-map (map)
2966 "Set `overriding-terminal-local-map' to MAP."
2967 (when (eq saved-overriding-map t)
2968 (setq saved-overriding-map overriding-terminal-local-map)
2969 (setq overriding-terminal-local-map map)))
2971 (defun restore-overriding-map ()
2972 "Restore `overriding-terminal-local-map' to its saved value."
2973 (setq overriding-terminal-local-map saved-overriding-map)
2974 (setq saved-overriding-map t))
2976 (defun universal-argument ()
2977 "Begin a numeric argument for the following command.
2982 multiplies the argument by 4 each time.
2984 which is different in effect from any particular numeric argument.
2986 (interactive)
2987 (setq prefix-arg (list 4))
2988 (setq universal-argument-num-events (length (this-command-keys)))
2989 (save&set-overriding-map universal-argument-map))
2991 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2992 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2993 (defun universal-argument-more (arg)
2994 (interactive "P")
2995 (if (consp arg)
2996 (setq prefix-arg (list (* 4 (car arg))))
2997 (if (eq arg '-)
2998 (setq prefix-arg (list -4))
2999 (setq prefix-arg arg)
3000 (restore-overriding-map)))
3001 (setq universal-argument-num-events (length (this-command-keys))))
3003 (defun negative-argument (arg)
3004 "Begin a negative numeric argument for the next command.
3006 (interactive "P")
3007 (cond ((integerp arg)
3008 (setq prefix-arg (- arg)))
3009 ((eq arg '-)
3010 (setq prefix-arg nil))
3011 (t
3012 (setq prefix-arg '-)))
3013 (setq universal-argument-num-events (length (this-command-keys)))
3014 (save&set-overriding-map universal-argument-map))
3016 (defun digit-argument (arg)
3017 "Part of the numeric argument for the next command.
3019 (interactive "P")
3020 (let* ((char (if (integerp last-command-event)
3021 last-command-event
3022 (get last-command-event 'ascii-character)))
3024 (cond ((integerp arg)
3025 (setq prefix-arg (+ (* arg 10)
3026 (if (< arg 0) (- digit) digit))))
3027 ((eq arg '-)
3028 ;; Treat -0 as just -, so that -01 will work.
3029 (setq prefix-arg (if (zerop digit) '- (- digit))))
3030 (t
3031 (setq prefix-arg digit))))
3032 (setq universal-argument-num-events (length (this-command-keys)))
3033 (save&set-overriding-map universal-argument-map))
3035 ;; For backward compatibility, minus with no modifiers is an ordinary
3036 ;; command if digits have already been entered.
3037 (defun universal-argument-minus (arg)
3038 (interactive "P")
3039 (if (integerp arg)
3040 (universal-argument-other-key arg)
3041 (negative-argument arg)))
3043 ;; Anything else terminates the argument and is left in the queue to be
3044 ;; executed as a command.
3045 (defun universal-argument-other-key (arg)
3046 (interactive "P")
3047 (setq prefix-arg arg)
3048 (let* ((key (this-command-keys))
3049 (keylist (listify-key-sequence key)))
3050 (setq unread-command-events
3051 (append (nthcdr universal-argument-num-events keylist)
3052 unread-command-events)))
3053 (reset-this-command-lengths)
3054 (restore-overriding-map))
3055 \f
3057 (defvar filter-buffer-substring-functions nil
3058 "This variable is a wrapper hook around `filter-buffer-substring'.
3059 Each member of the hook should be a function accepting four arguments:
3060 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
3061 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3062 as those of `filter-buffer-substring' in each case.
3064 The first hook function to be called receives a FUN equivalent
3065 to the default operation of `filter-buffer-substring',
3066 i.e. one that returns the buffer-substring between BEG and
3067 END (processed by any `buffer-substring-filters'). Normally,
3068 the hook function will call FUN and then do its own processing
3069 of the result. The next hook function receives a FUN equivalent
3070 to the previous hook function, calls it, and does its own
3071 processing, and so on. The overall result is that of all hook
3072 functions acting in sequence.
3074 Any hook may choose not to call FUN though, in which case it
3075 effectively replaces the default behavior with whatever it chooses.
3076 Of course, a later hook function may do the same thing.")
3078 (defvar buffer-substring-filters nil
3079 "List of filter functions for `filter-buffer-substring'.
3080 Each function must accept a single argument, a string, and return
3081 a string. The buffer substring is passed to the first function
3082 in the list, and the return value of each function is passed to
3083 the next. The final result (if `buffer-substring-filters' is
3084 nil, this is the unfiltered buffer-substring) is passed to the
3085 first function on `filter-buffer-substring-functions'.
3087 As a special convention, point is set to the start of the buffer text
3088 being operated on (i.e., the first argument of `filter-buffer-substring')
3089 before these functions are called.")
3090 (make-obsolete-variable 'buffer-substring-filters
3091 'filter-buffer-substring-functions "24.1")
3093 (defun filter-buffer-substring (beg end &optional delete)
3094 "Return the buffer substring between BEG and END, after filtering.
3095 The wrapper hook `filter-buffer-substring-functions' performs
3096 the actual filtering. The obsolete variable `buffer-substring-filters'
3097 is also consulted. If both of these are nil, no filtering is done.
3099 If DELETE is non-nil, the text between BEG and END is deleted
3100 from the buffer.
3102 This function should be used instead of `buffer-substring',
3103 `buffer-substring-no-properties', or `delete-and-extract-region'
3104 when you want to allow filtering to take place. For example,
3105 major or minor modes can use `filter-buffer-substring-functions' to
3106 extract characters that are special to a buffer, and should not
3107 be copied into other buffers."
3108 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3109 (cond
3110 ((or delete buffer-substring-filters)
3111 (save-excursion
3112 (goto-char beg)
3113 (let ((string (if delete (delete-and-extract-region beg end)
3114 (buffer-substring beg end))))
3115 (dolist (filter buffer-substring-filters)
3116 (setq string (funcall filter string)))
3117 string)))
3118 (t
3119 (buffer-substring beg end)))))
3122 ;;;; Window system cut and paste hooks.
3124 (defvar interprogram-cut-function nil
3125 "Function to call to make a killed region available to other programs.
3126 Most window systems provide a facility for cutting and pasting
3127 text between different programs, such as the clipboard on X and
3128 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3130 This variable holds a function that Emacs calls whenever text is
3131 put in the kill ring, to make the new kill available to other
3132 programs. The function takes one argument, TEXT, which is a
3133 string containing the text which should be made available.")
3135 (defvar interprogram-paste-function nil
3136 "Function to call to get text cut from other programs.
3137 Most window systems provide a facility for cutting and pasting
3138 text between different programs, such as the clipboard on X and
3139 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3141 This variable holds a function that Emacs calls to obtain text
3142 that other programs have provided for pasting. The function is
3143 called with no arguments. If no other program has provided text
3144 to paste, the function should return nil (in which case the
3145 caller, usually `current-kill', should use the top of the Emacs
3146 kill ring). If another program has provided text to paste, the
3147 function should return that text as a string (in which case the
3148 caller should put this string in the kill ring as the latest
3149 kill).
3151 The function may also return a list of strings if the window
3152 system supports multiple selections. The first string will be
3153 used as the pasted text, but the other will be placed in the kill
3154 ring for easy access via `yank-pop'.
3156 Note that the function should return a string only if a program
3157 other than Emacs has provided a string for pasting; if Emacs
3158 provided the most recent string, the function should return nil.
3159 If it is difficult to tell whether Emacs or some other program
3160 provided the current string, it is probably good enough to return
3161 nil if the string is equal (according to `string=') to the last
3162 text Emacs provided.")
3163 \f
3166 ;;;; The kill ring data structure.
3168 (defvar kill-ring nil
3169 "List of killed text sequences.
3170 Since the kill ring is supposed to interact nicely with cut-and-paste
3171 facilities offered by window systems, use of this variable should
3172 interact nicely with `interprogram-cut-function' and
3173 `interprogram-paste-function'. The functions `kill-new',
3174 `kill-append', and `current-kill' are supposed to implement this
3175 interaction; you may want to use them instead of manipulating the kill
3176 ring directly.")
3178 (defcustom kill-ring-max 60
3179 "Maximum length of kill ring before oldest elements are thrown away."
3180 :type 'integer
3181 :group 'killing)
3183 (defvar kill-ring-yank-pointer nil
3184 "The tail of the kill ring whose car is the last thing yanked.")
3186 (defcustom save-interprogram-paste-before-kill nil
3187 "Save clipboard strings into kill ring before replacing them.
3188 When one selects something in another program to paste it into Emacs,
3189 but kills something in Emacs before actually pasting it,
3190 this selection is gone unless this variable is non-nil,
3191 in which case the other program's selection is saved in the `kill-ring'
3193 :type 'boolean
3194 :group 'killing
3195 :version "23.2")
3197 (defcustom kill-do-not-save-duplicates nil
3198 "Do not add a new string to `kill-ring' if it duplicates the last one.
3199 The comparison is done using `equal-including-properties'."
3200 :type 'boolean
3201 :group 'killing
3202 :version "23.2")
3204 (defun kill-new (string &optional replace yank-handler)
3205 "Make STRING the latest kill in the kill ring.
3206 Set `kill-ring-yank-pointer' to point to it.
3207 If `interprogram-cut-function' is non-nil, apply it to STRING.
3208 Optional second argument REPLACE non-nil means that STRING will replace
3209 the front of the kill ring, rather than being added to the list.
3211 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3212 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3213 STRING.
3215 When the yank handler has a non-nil PARAM element, the original STRING
3216 argument is not used by `insert-for-yank'. However, since Lisp code
3217 may access and use elements from the kill ring directly, the STRING
3219 (if (> (length string) 0)
3220 (if yank-handler
3221 (put-text-property 0 (length string)
3222 'yank-handler yank-handler string))
3223 (if yank-handler
3224 (signal 'args-out-of-range
3225 (list string "yank-handler specified for empty string"))))
3226 (unless (and kill-do-not-save-duplicates
3227 ;; Due to text properties such as 'yank-handler that
3228 ;; can alter the contents to yank, comparison using
3229 ;; `equal' is unsafe.
3230 (equal-including-properties string (car kill-ring)))
3231 (if (fboundp 'menu-bar-update-yank-menu)
3232 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3233 (when save-interprogram-paste-before-kill
3234 (let ((interprogram-paste (and interprogram-paste-function
3235 (funcall interprogram-paste-function))))
3236 (when interprogram-paste
3237 (dolist (s (if (listp interprogram-paste)
3238 (nreverse interprogram-paste)
3239 (list interprogram-paste)))
3240 (unless (and kill-do-not-save-duplicates
3241 (equal-including-properties s (car kill-ring)))
3242 (push s kill-ring))))))
3243 (unless (and kill-do-not-save-duplicates
3244 (equal-including-properties string (car kill-ring)))
3245 (if (and replace kill-ring)
3246 (setcar kill-ring string)
3247 (push string kill-ring)
3248 (if (> (length kill-ring) kill-ring-max)
3249 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3250 (setq kill-ring-yank-pointer kill-ring)
3251 (if interprogram-cut-function
3252 (funcall interprogram-cut-function string)))
3253 (set-advertised-calling-convention
3254 'kill-new '(string &optional replace) "23.3")
3256 (defun kill-append (string before-p &optional yank-handler)
3257 "Append STRING to the end of the latest kill in the kill ring.
3258 If BEFORE-P is non-nil, prepend STRING to the kill.
3259 If `interprogram-cut-function' is set, pass the resulting kill to it."
3260 (let* ((cur (car kill-ring)))
3261 (kill-new (if before-p (concat string cur) (concat cur string))
3262 (or (= (length cur) 0)
3263 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3264 yank-handler)))
3265 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3267 (defcustom yank-pop-change-selection nil
3268 "Whether rotating the kill ring changes the window system selection.
3269 If non-nil, whenever the kill ring is rotated (usually via the
3270 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3271 to copy the new kill to the window system selection."
3272 :type 'boolean
3273 :group 'killing
3274 :version "23.1")
3276 (defun current-kill (n &optional do-not-move)
3277 "Rotate the yanking point by N places, and then return that kill.
3278 If N is zero and `interprogram-paste-function' is set to a
3279 function that returns a string or a list of strings, and if that
3280 function doesn't return nil, then that string (or list) is added
3281 to the front of the kill ring and the string (or first string in
3282 the list) is returned as the latest kill.
3284 If N is not zero, and if `yank-pop-change-selection' is
3285 non-nil, use `interprogram-cut-function' to transfer the
3286 kill at the new yank point into the window system selection.
3288 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3289 move the yanking point; just return the Nth kill forward."
3291 (let ((interprogram-paste (and (= n 0)
3292 interprogram-paste-function
3293 (funcall interprogram-paste-function))))
3294 (if interprogram-paste
3295 (progn
3296 ;; Disable the interprogram cut function when we add the new
3297 ;; text to the kill ring, so Emacs doesn't try to own the
3298 ;; selection, with identical text.
3299 (let ((interprogram-cut-function nil))
3300 (if (listp interprogram-paste)
3301 (mapc 'kill-new (nreverse interprogram-paste))
3302 (kill-new interprogram-paste)))
3303 (car kill-ring))
3304 (or kill-ring (error "Kill ring is empty"))
3305 (let ((ARGth-kill-element
3306 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3307 (length kill-ring))
3308 kill-ring)))
3309 (unless do-not-move
3310 (setq kill-ring-yank-pointer ARGth-kill-element)
3311 (when (and yank-pop-change-selection
3312 (> n 0)
3313 interprogram-cut-function)
3314 (funcall interprogram-cut-function (car ARGth-kill-element))))
3315 (car ARGth-kill-element)))))
3319 ;;;; Commands for manipulating the kill ring.
3321 (defcustom kill-read-only-ok nil
3322 "Non-nil means don't signal an error for killing read-only text."
3323 :type 'boolean
3324 :group 'killing)
3326 (defun kill-region (beg end &optional yank-handler)
3328 This deletes the text from the buffer and saves it in the kill ring.
3332 If you want to append the killed region to the last killed text,
3335 If the buffer is read-only, Emacs will beep and refrain from deleting
3336 the text, but put the text in the kill ring anyway. This means that
3337 you can use the killing commands to copy text from a read-only buffer.
3339 Lisp programs should use this function for killing text.
3340 (To delete text, use `delete-region'.)
3341 Supply two arguments, character positions indicating the stretch of text
3342 to be killed.
3344 If the previous command was also a kill command,
3345 the text killed this time appends to the text killed last time
3346 to make one entry in the kill ring."
3347 ;; Pass point first, then mark, because the order matters
3348 ;; when calling kill-append.
3349 (interactive (list (point) (mark)))
3350 (unless (and beg end)
3351 (error "The mark is not set now, so there is no region"))
3352 (condition-case nil
3353 (let ((string (filter-buffer-substring beg end t)))
3354 (when string ;STRING is nil if BEG = END
3355 ;; Add that string to the kill ring, one way or another.
3356 (if (eq last-command 'kill-region)
3357 (kill-append string (< end beg) yank-handler)
3358 (kill-new string nil yank-handler)))
3359 (when (or string (eq last-command 'kill-region))
3360 (setq this-command 'kill-region))
3361 nil)
3362 ((buffer-read-only text-read-only)
3363 ;; The code above failed because the buffer, or some of the characters
3364 ;; in the region, are read-only.
3365 ;; We should beep, in case the user just isn't aware of this.
3366 ;; However, there's no harm in putting
3367 ;; the region's text in the kill ring, anyway.
3368 (copy-region-as-kill beg end)
3369 ;; Set this-command now, so it will be set even if we get an error.
3370 (setq this-command 'kill-region)
3371 ;; This should barf, if appropriate, and give us the correct error.
3372 (if kill-read-only-ok
3373 (progn (message "Read only text copied to kill ring") nil)
3374 ;; Signal an error if the buffer is read-only.
3375 (barf-if-buffer-read-only)
3376 ;; If the buffer isn't read-only, the text is.
3377 (signal 'text-read-only (list (current-buffer)))))))
3378 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3380 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3381 ;; to get two copies of the text when the user accidentally types M-w and
3382 ;; then corrects it with the intended C-w.
3383 (defun copy-region-as-kill (beg end)
3384 "Save the region as if killed, but don't kill it.
3385 In Transient Mark mode, deactivate the mark.
3386 If `interprogram-cut-function' is non-nil, also save the text for a window
3387 system cut and paste.
3389 This command's old key binding has been given to `kill-ring-save'."
3390 (interactive "r")
3391 (if (eq last-command 'kill-region)
3392 (kill-append (filter-buffer-substring beg end) (< end beg))
3393 (kill-new (filter-buffer-substring beg end)))
3394 (setq deactivate-mark t)
3395 nil)
3397 (defun kill-ring-save (beg end)
3398 "Save the region as if killed, but don't kill it.
3399 In Transient Mark mode, deactivate the mark.
3400 If `interprogram-cut-function' is non-nil, also save the text for a window
3401 system cut and paste.
3403 If you want to append the killed line to the last killed text,
3406 This command is similar to `copy-region-as-kill', except that it gives
3407 visual feedback indicating the extent of the region being copied."
3408 (interactive "r")
3409 (copy-region-as-kill beg end)
3410 ;; This use of called-interactively-p is correct because the code it
3411 ;; controls just gives the user visual feedback.
3412 (if (called-interactively-p 'interactive)
3413 (indicate-copied-region)))
3415 (defun indicate-copied-region (&optional message-len)
3416 "Indicate that the region text has been copied interactively.
3417 If the mark is visible in the selected window, blink the cursor
3418 between point and mark if there is currently no active region
3419 highlighting.
3421 If the mark lies outside the selected window, display an
3422 informative message containing a sample of the copied text. The
3423 optional argument MESSAGE-LEN, if non-nil, specifies the length
3424 of this sample text; it defaults to 40."
3425 (let ((mark (mark t))
3426 (point (point))
3427 ;; Inhibit quitting so we can make a quit here
3428 ;; look like a C-g typed as a command.
3429 (inhibit-quit t))
3430 (if (pos-visible-in-window-p mark (selected-window))
3431 ;; Swap point-and-mark quickly so as to show the region that
3432 ;; was selected. Don't do it if the region is highlighted.
3433 (unless (and (region-active-p)
3434 (face-background 'region))
3435 ;; Swap point and mark.
3436 (set-marker (mark-marker) (point) (current-buffer))
3437 (goto-char mark)
3438 (sit-for blink-matching-delay)
3439 ;; Swap back.
3440 (set-marker (mark-marker) mark (current-buffer))
3441 (goto-char point)
3442 ;; If user quit, deactivate the mark
3443 ;; as C-g would as a command.
3444 (and quit-flag mark-active
3445 (deactivate-mark)))
3446 (let ((len (min (abs (- mark point))
3447 (or message-len 40))))
3448 (if (< point mark)
3449 ;; Don't say "killed"; that is misleading.
3451 (buffer-substring-no-properties (- mark len) mark))
3453 (buffer-substring-no-properties mark (+ mark len))))))))
3455 (defun append-next-kill (&optional interactive)
3456 "Cause following command, if it kills, to append to previous kill.
3457 The argument is used for internal purposes; do not supply one."
3458 (interactive "p")
3459 ;; We don't use (interactive-p), since that breaks kbd macros.
3460 (if interactive
3461 (progn
3462 (setq this-command 'kill-region)
3463 (message "If the next command is a kill, it will append"))
3464 (setq last-command 'kill-region)))
3465 \f
3466 ;; Yanking.
3468 ;; This is actually used in subr.el but defcustom does not work there.
3469 (defcustom yank-excluded-properties
3470 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3471 yank-handler follow-link fontified)
3472 "Text properties to discard when yanking.
3473 The value should be a list of text properties to discard or t,
3474 which means to discard all text properties."
3475 :type '(choice (const :tag "All" t) (repeat symbol))
3476 :group 'killing
3477 :version "22.1")
3479 (defvar yank-window-start nil)
3480 (defvar yank-undo-function nil
3481 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3482 Function is called with two parameters, START and END corresponding to
3483 the value of the mark and point; it is guaranteed that START <= END.
3484 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3486 (defun yank-pop (&optional arg)
3487 "Replace just-yanked stretch of killed text with a different stretch.
3488 This command is allowed only immediately after a `yank' or a `yank-pop'.
3489 At such a time, the region contains a stretch of reinserted
3490 previously-killed text. `yank-pop' deletes that text and inserts in its
3491 place a different stretch of killed text.
3493 With no argument, the previous kill is inserted.
3494 With argument N, insert the Nth previous kill.
3495 If N is negative, this is a more recent kill.
3497 The sequence of kills wraps around, so that after the oldest one
3498 comes the newest one.
3500 When this command inserts killed text into the buffer, it honors
3501 `yank-excluded-properties' and `yank-handler' as described in the
3502 doc string for `insert-for-yank-1', which see."
3503 (interactive "*p")
3504 (if (not (eq last-command 'yank))
3505 (error "Previous command was not a yank"))
3506 (setq this-command 'yank)
3507 (unless arg (setq arg 1))
3508 (let ((inhibit-read-only t)
3509 (before (< (point) (mark t))))
3510 (if before
3511 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3512 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3513 (setq yank-undo-function nil)
3514 (set-marker (mark-marker) (point) (current-buffer))
3515 (insert-for-yank (current-kill arg))
3516 ;; Set the window start back where it was in the yank command,
3517 ;; if possible.
3518 (set-window-start (selected-window) yank-window-start t)
3519 (if before
3520 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3521 ;; It is cleaner to avoid activation, even though the command
3522 ;; loop would deactivate the mark because we inserted text.
3523 (goto-char (prog1 (mark t)
3524 (set-marker (mark-marker) (point) (current-buffer))))))
3525 nil)
3527 (defun yank (&optional arg)
3529 More precisely, reinsert the stretch of killed text most recently
3530 killed OR yanked. Put point at end, and set mark at beginning.
3531 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3532 With argument N, reinsert the Nth most recently killed stretch of killed
3533 text.
3535 When this command inserts killed text into the buffer, it honors
3536 `yank-excluded-properties' and `yank-handler' as described in the
3537 doc string for `insert-for-yank-1', which see.
3540 (interactive "*P")
3541 (setq yank-window-start (window-start))
3542 ;; If we don't get all the way thru, make last-command indicate that
3543 ;; for the following command.
3544 (setq this-command t)
3545 (push-mark (point))
3546 (insert-for-yank (current-kill (cond
3547 ((listp arg) 0)
3548 ((eq arg '-) -2)
3549 (t (1- arg)))))
3550 (if (consp arg)
3551 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3552 ;; It is cleaner to avoid activation, even though the command
3553 ;; loop would deactivate the mark because we inserted text.
3554 (goto-char (prog1 (mark t)
3555 (set-marker (mark-marker) (point) (current-buffer)))))
3556 ;; If we do get all the way thru, make this-command indicate that.
3557 (if (eq this-command t)
3558 (setq this-command 'yank))
3559 nil)
3561 (defun rotate-yank-pointer (arg)
3562 "Rotate the yanking point in the kill ring.
3563 With ARG, rotate that many kills forward (or backward, if negative)."
3564 (interactive "p")
3565 (current-kill arg))
3566 \f
3567 ;; Some kill commands.
3569 ;; Internal subroutine of delete-char
3570 (defun kill-forward-chars (arg)
3571 (if (listp arg) (setq arg (car arg)))
3572 (if (eq arg '-) (setq arg -1))
3573 (kill-region (point) (+ (point) arg)))
3575 ;; Internal subroutine of backward-delete-char
3576 (defun kill-backward-chars (arg)
3577 (if (listp arg) (setq arg (car arg)))
3578 (if (eq arg '-) (setq arg -1))
3579 (kill-region (point) (- (point) arg)))
3581 (defcustom backward-delete-char-untabify-method 'untabify
3582 "The method for untabifying when deleting backward.
3583 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3584 `hungry' -- delete all whitespace, both tabs and spaces;
3585 `all' -- delete all whitespace, including tabs, spaces and newlines;
3586 nil -- just delete one character."
3587 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3588 :version "20.3"
3589 :group 'killing)
3591 (defun backward-delete-char-untabify (arg &optional killp)
3592 "Delete characters backward, changing tabs into spaces.
3593 The exact behavior depends on `backward-delete-char-untabify-method'.
3594 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3595 Interactively, ARG is the prefix arg (default 1)
3596 and KILLP is t if a prefix arg was specified."
3598 (when (eq backward-delete-char-untabify-method 'untabify)
3599 (let ((count arg))
3600 (save-excursion
3601 (while (and (> count 0) (not (bobp)))
3603 (let ((col (current-column)))
3604 (forward-char -1)
3605 (setq col (- col (current-column)))
3606 (insert-char ?\s col)
3607 (delete-char 1)))
3608 (forward-char -1)
3609 (setq count (1- count))))))
3611 ((eq backward-delete-char-untabify-method 'all)
3613 (n (if skip
3614 (let* ((oldpt (point))
3615 (wh (- oldpt (save-excursion
3616 (skip-chars-backward skip)
3617 (constrain-to-field nil oldpt)))))
3618 (+ arg (if (zerop wh) 0 (1- wh))))
3619 arg)))
3620 ;; Avoid warning about delete-backward-char
3621 (with-no-warnings (delete-backward-char n killp))))
3623 (defun zap-to-char (arg char)
3624 "Kill up to and including ARGth occurrence of CHAR.
3625 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3626 Goes backward if ARG is negative; error if CHAR not found."
3627 (interactive (list (prefix-numeric-value current-prefix-arg)
3628 (read-char "Zap to char: " t)))
3629 ;; Avoid "obsolete" warnings for translation-table-for-input.
3630 (with-no-warnings
3631 (if (char-table-p translation-table-for-input)
3632 (setq char (or (aref translation-table-for-input char) char))))
3633 (kill-region (point) (progn
3634 (search-forward (char-to-string char) nil nil arg)
3635 (point))))
3637 ;; kill-line and its subroutines.
3639 (defcustom kill-whole-line nil
3640 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3641 :type 'boolean
3642 :group 'killing)
3644 (defun kill-line (&optional arg)
3645 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3646 With prefix argument ARG, kill that many lines from point.
3647 Negative arguments kill lines backward.
3648 With zero argument, kills the text before point on the current line.
3651 a number counts as a prefix arg.
3653 To kill a whole line, when point is not at the beginning, type \
3656 If `show-trailing-whitespace' is non-nil, this command will just
3657 kill the rest of the current line, even if there are only
3658 nonblanks there.
3660 If `kill-whole-line' is non-nil, then this command kills the whole line
3661 including its terminating newline, when used at the beginning of a line
3662 with no argument. As a consequence, you can always kill a whole line
3665 If you want to append the killed line to the last killed text,
3668 If the buffer is read-only, Emacs will beep and refrain from deleting
3669 the line, but put the line in the kill ring anyway. This means that
3670 you can use this command to copy text from a read-only buffer.
3671 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3672 even beep.)"
3673 (interactive "P")
3674 (kill-region (point)
3675 ;; It is better to move point to the other end of the kill
3676 ;; before killing. That way, in a read-only buffer, point
3677 ;; moves across the text that is copied to the kill ring.
3678 ;; The choice has no effect on undo now that undo records
3679 ;; the value of point from before the command was run.
3680 (progn
3681 (if arg
3682 (forward-visible-line (prefix-numeric-value arg))
3683 (if (eobp)
3684 (signal 'end-of-buffer nil))
3685 (let ((end
3686 (save-excursion
3687 (end-of-visible-line) (point))))
3688 (if (or (save-excursion
3689 ;; If trailing whitespace is visible,
3690 ;; don't treat it as nothing.
3691 (unless show-trailing-whitespace
3693 (= (point) end))
3694 (and kill-whole-line (bolp)))
3695 (forward-visible-line 1)
3696 (goto-char end))))
3697 (point))))
3699 (defun kill-whole-line (&optional arg)
3700 "Kill current line.
3701 With prefix ARG, kill that many lines starting from the current line.
3702 If ARG is negative, kill backward. Also kill the preceding newline.
3704 If ARG is zero, kill current line but exclude the trailing newline."
3705 (interactive "p")
3706 (or arg (setq arg 1))
3707 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3708 (signal 'end-of-buffer nil))
3709 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3710 (signal 'beginning-of-buffer nil))
3711 (unless (eq last-command 'kill-region)
3712 (kill-new "")
3713 (setq last-command 'kill-region))
3714 (cond ((zerop arg)
3715 ;; We need to kill in two steps, because the previous command
3716 ;; could have been a kill command, in which case the text
3717 ;; before point needs to be prepended to the current kill
3718 ;; ring entry and the text after point appended. Also, we
3719 ;; need to use save-excursion to avoid copying the same text
3720 ;; twice to the kill ring in read-only buffers.
3721 (save-excursion
3722 (kill-region (point) (progn (forward-visible-line 0) (point))))
3723 (kill-region (point) (progn (end-of-visible-line) (point))))
3724 ((< arg 0)
3725 (save-excursion
3726 (kill-region (point) (progn (end-of-visible-line) (point))))
3727 (kill-region (point)
3728 (progn (forward-visible-line (1+ arg))
3729 (unless (bobp) (backward-char))
3730 (point))))
3731 (t
3732 (save-excursion
3733 (kill-region (point) (progn (forward-visible-line 0) (point))))
3734 (kill-region (point)
3735 (progn (forward-visible-line arg) (point))))))
3737 (defun forward-visible-line (arg)
3738 "Move forward by ARG lines, ignoring currently invisible newlines only.
3739 If ARG is negative, move backward -ARG lines.
3740 If ARG is zero, move to the beginning of the current line."
3741 (condition-case nil
3742 (if (> arg 0)
3743 (progn
3744 (while (> arg 0)
3745 (or (zerop (forward-line 1))
3746 (signal 'end-of-buffer nil))
3747 ;; If the newline we just skipped is invisible,
3748 ;; don't count it.
3749 (let ((prop
3750 (get-char-property (1- (point)) 'invisible)))
3751 (if (if (eq buffer-invisibility-spec t)
3752 prop
3753 (or (memq prop buffer-invisibility-spec)
3754 (assq prop buffer-invisibility-spec)))
3755 (setq arg (1+ arg))))
3756 (setq arg (1- arg)))
3757 ;; If invisible text follows, and it is a number of complete lines,
3758 ;; skip it.
3759 (let ((opoint (point)))
3760 (while (and (not (eobp))
3761 (let ((prop
3762 (get-char-property (point) 'invisible)))
3763 (if (eq buffer-invisibility-spec t)
3764 prop
3765 (or (memq prop buffer-invisibility-spec)
3766 (assq prop buffer-invisibility-spec)))))
3767 (goto-char
3768 (if (get-text-property (point) 'invisible)
3769 (or (next-single-property-change (point) 'invisible)
3770 (point-max))
3771 (next-overlay-change (point)))))
3772 (unless (bolp)
3773 (goto-char opoint))))
3774 (let ((first t))
3775 (while (or first (<= arg 0))
3776 (if first
3777 (beginning-of-line)
3778 (or (zerop (forward-line -1))
3779 (signal 'beginning-of-buffer nil)))
3780 ;; If the newline we just moved to is invisible,
3781 ;; don't count it.
3782 (unless (bobp)
3783 (let ((prop
3784 (get-char-property (1- (point)) 'invisible)))
3785 (unless (if (eq buffer-invisibility-spec t)
3786 prop
3787 (or (memq prop buffer-invisibility-spec)
3788 (assq prop buffer-invisibility-spec)))
3789 (setq arg (1+ arg)))))
3790 (setq first nil))
3791 ;; If invisible text follows, and it is a number of complete lines,
3792 ;; skip it.
3793 (let ((opoint (point)))
3794 (while (and (not (bobp))
3795 (let ((prop
3796 (get-char-property (1- (point)) 'invisible)))
3797 (if (eq buffer-invisibility-spec t)
3798 prop
3799 (or (memq prop buffer-invisibility-spec)
3800 (assq prop buffer-invisibility-spec)))))
3801 (goto-char
3802 (if (get-text-property (1- (point)) 'invisible)
3803 (or (previous-single-property-change (point) 'invisible)
3804 (point-min))
3805 (previous-overlay-change (point)))))
3806 (unless (bolp)
3807 (goto-char opoint)))))
3808 ((beginning-of-buffer end-of-buffer)
3809 nil)))
3811 (defun end-of-visible-line ()
3812 "Move to end of current visible line."
3813 (end-of-line)
3814 ;; If the following character is currently invisible,
3815 ;; skip all characters with that same `invisible' property value,
3816 ;; then find the next newline.
3817 (while (and (not (eobp))
3818 (save-excursion
3820 (let ((prop
3821 (get-char-property (point) 'invisible)))
3822 (if (eq buffer-invisibility-spec t)
3823 prop
3824 (or (memq prop buffer-invisibility-spec)
3825 (assq prop buffer-invisibility-spec))))))
3827 (if (get-text-property (point) 'invisible)
3828 (goto-char (or (next-single-property-change (point) 'invisible)
3829 (point-max)))
3830 (goto-char (next-overlay-change (point))))
3831 (end-of-line)))
3832 \f
3833 (defun insert-buffer (buffer)
3834 "Insert after point the contents of BUFFER.
3835 Puts mark after the inserted text.
3836 BUFFER may be a buffer or a buffer name.
3838 This function is meant for the user to run interactively.
3839 Don't call it from programs: use `insert-buffer-substring' instead!"
3840 (interactive
3841 (list
3842 (progn
3843 (barf-if-buffer-read-only)
3844 (read-buffer "Insert buffer: "
3845 (if (eq (selected-window) (next-window (selected-window)))
3846 (other-buffer (current-buffer))
3847 (window-buffer (next-window (selected-window))))
3848 t))))
3849 (push-mark
3850 (save-excursion
3851 (insert-buffer-substring (get-buffer buffer))
3852 (point)))
3853 nil)
3855 (defun append-to-buffer (buffer start end)
3856 "Append to specified buffer the text of the region.
3857 It is inserted into that buffer before its point.
3859 When calling from a program, give three arguments:
3860 BUFFER (or buffer name), START and END.
3861 START and END specify the portion of the current buffer to be copied."
3862 (interactive
3863 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3864 (region-beginning) (region-end)))
3865 (let* ((oldbuf (current-buffer))
3866 (append-to (get-buffer-create buffer))
3867 (windows (get-buffer-window-list append-to t t))
3868 point)
3869 (save-excursion
3870 (with-current-buffer append-to
3871 (setq point (point))
3872 (barf-if-buffer-read-only)
3873 (insert-buffer-substring oldbuf start end)
3874 (dolist (window windows)
3875 (when (= (window-point window) point)
3876 (set-window-point window (point))))))))
3878 (defun prepend-to-buffer (buffer start end)
3879 "Prepend to specified buffer the text of the region.
3880 It is inserted into that buffer after its point.
3882 When calling from a program, give three arguments:
3883 BUFFER (or buffer name), START and END.
3884 START and END specify the portion of the current buffer to be copied."
3886 (let ((oldbuf (current-buffer)))
3887 (with-current-buffer (get-buffer-create buffer)
3888 (barf-if-buffer-read-only)
3889 (save-excursion
3890 (insert-buffer-substring oldbuf start end)))))
3892 (defun copy-to-buffer (buffer start end)
3893 "Copy to specified buffer the text of the region.
3894 It is inserted into that buffer, replacing existing text there.
3896 When calling from a program, give three arguments:
3897 BUFFER (or buffer name), START and END.
3898 START and END specify the portion of the current buffer to be copied."
3900 (let ((oldbuf (current-buffer)))
3901 (with-current-buffer (get-buffer-create buffer)
3902 (barf-if-buffer-read-only)
3903 (erase-buffer)
3904 (save-excursion
3905 (insert-buffer-substring oldbuf start end)))))
3906 \f
3907 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3908 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3910 (defvar activate-mark-hook nil
3911 "Hook run when the mark becomes active.
3912 It is also run at the end of a command, if the mark is active and
3913 it is possible that the region may have changed.")
3915 (defvar deactivate-mark-hook nil
3916 "Hook run when the mark becomes inactive.")
3918 (defun mark (&optional force)
3919 "Return this buffer's mark value as integer, or nil if never set.
3921 In Transient Mark mode, this function signals an error if
3922 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3923 or the argument FORCE is non-nil, it disregards whether the mark
3924 is active, and returns an integer or nil in the usual way.
3926 If you are using this in an editing command, you are most likely making
3927 a mistake; see the documentation of `set-mark'."
3928 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3929 (marker-position (mark-marker))
3930 (signal 'mark-inactive nil)))
3932 (defsubst deactivate-mark (&optional force)
3933 "Deactivate the mark.
3934 If Transient Mark mode is disabled, this function normally does
3935 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3937 Deactivating the mark sets `mark-active' to nil, updates the
3938 primary selection according to `select-active-regions', and runs
3939 `deactivate-mark-hook'.
3941 If Transient Mark mode was temporarily enabled, reset the value
3942 of the variable `transient-mark-mode'; if this causes Transient
3943 Mark mode to be disabled, don't change `mark-active' to nil or
3944 run `deactivate-mark-hook'."
3945 (when (or transient-mark-mode force)
3946 (when (and (if (eq select-active-regions 'only)
3947 (eq (car-safe transient-mark-mode) 'only)
3948 select-active-regions)
3949 (region-active-p)
3950 (display-selections-p))
3951 ;; The var `saved-region-selection', if non-nil, is the text in
3952 ;; the region prior to the last command modifying the buffer.
3953 ;; Set the selection to that, or to the current region.
3954 (cond (saved-region-selection
3955 (x-set-selection 'PRIMARY saved-region-selection)
3956 (setq saved-region-selection nil))
3957 ;; If another program has acquired the selection, region
3958 ;; deactivation should not clobber it (Bug#11772).
3959 ((and (/= (region-beginning) (region-end))
3960 (or (x-selection-owner-p 'PRIMARY)
3961 (null (x-selection-exists-p 'PRIMARY))))
3962 (x-set-selection 'PRIMARY
3963 (buffer-substring (region-beginning)
3964 (region-end))))))
3965 (if (and (null force)
3966 (or (eq transient-mark-mode 'lambda)
3967 (and (eq (car-safe transient-mark-mode) 'only)
3968 (null (cdr transient-mark-mode)))))
3969 ;; When deactivating a temporary region, don't change
3970 ;; `mark-active' or run `deactivate-mark-hook'.
3971 (setq transient-mark-mode nil)
3972 (if (eq (car-safe transient-mark-mode) 'only)
3973 (setq transient-mark-mode (cdr transient-mark-mode)))
3974 (setq mark-active nil)
3975 (run-hooks 'deactivate-mark-hook))))
3977 (defun activate-mark ()
3978 "Activate the mark."
3979 (when (mark t)
3980 (setq mark-active t)
3981 (unless transient-mark-mode
3982 (setq transient-mark-mode 'lambda))))
3984 (defun set-mark (pos)
3985 "Set this buffer's mark to POS. Don't use this function!
3986 That is to say, don't use this function unless you want
3987 the user to see that the mark has moved, and you want the previous
3988 mark position to be lost.
3990 Normally, when a new mark is set, the old one should go on the stack.
3991 This is why most applications should use `push-mark', not `set-mark'.
3993 Novice Emacs Lisp programmers often try to use the mark for the wrong
3994 purposes. The mark saves a location for the user's convenience.
3995 Most editing commands should not alter the mark.
3996 To remember a location for internal use in the Lisp program,
3997 store it in a Lisp variable. Example:
3999 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4001 (if pos
4002 (progn
4003 (setq mark-active t)
4004 (run-hooks 'activate-mark-hook)
4005 (set-marker (mark-marker) pos (current-buffer)))
4006 ;; Normally we never clear mark-active except in Transient Mark mode.
4007 ;; But when we actually clear out the mark value too, we must
4008 ;; clear mark-active in any mode.
4009 (deactivate-mark t)
4010 (set-marker (mark-marker) nil)))
4012 (defcustom use-empty-active-region nil
4014 If nil, region-aware commands treat empty regions as inactive.
4015 If non-nil, region-aware commands treat the region as active as
4016 long as the mark is active, even if the region is empty.
4018 Region-aware commands are those that act on the region if it is
4019 active and Transient Mark mode is enabled, and on the text near
4020 point otherwise."
4021 :type 'boolean
4022 :version "23.1"
4023 :group 'editing-basics)
4025 (defun use-region-p ()
4026 "Return t if the region is active and it is appropriate to act on it.
4027 This is used by commands that act specially on the region under
4028 Transient Mark mode.
4030 The return value is t if Transient Mark mode is enabled and the
4031 mark is active; furthermore, if `use-empty-active-region' is nil,
4032 the region must not be empty. Otherwise, the return value is nil.
4034 For some commands, it may be appropriate to ignore the value of
4035 `use-empty-active-region'; in that case, use `region-active-p'."
4036 (and (region-active-p)
4037 (or use-empty-active-region (> (region-end) (region-beginning)))))
4039 (defun region-active-p ()
4040 "Return t if Transient Mark mode is enabled and the mark is active.
4042 Some commands act specially on the region when Transient Mark
4043 mode is enabled. Usually, such commands should use
4044 `use-region-p' instead of this function, because `use-region-p'
4045 also checks the value of `use-empty-active-region'."
4046 (and transient-mark-mode mark-active))
4048 (defvar mark-ring nil
4049 "The list of former marks of the current buffer, most recent first.")
4050 (make-variable-buffer-local 'mark-ring)
4051 (put 'mark-ring 'permanent-local t)
4053 (defcustom mark-ring-max 16
4054 "Maximum size of mark ring. Start discarding off end if gets this big."
4055 :type 'integer
4056 :group 'editing-basics)
4058 (defvar global-mark-ring nil
4059 "The list of saved global marks, most recent first.")
4061 (defcustom global-mark-ring-max 16
4062 "Maximum size of global mark ring. \
4063 Start discarding off end if gets this big."
4064 :type 'integer
4065 :group 'editing-basics)
4067 (defun pop-to-mark-command ()
4068 "Jump to mark, and pop a new position for mark off the ring.
4069 \(Does not affect global mark ring\)."
4070 (interactive)
4071 (if (null (mark t))
4072 (error "No mark set in this buffer")
4073 (if (= (point) (mark t))
4074 (message "Mark popped"))
4075 (goto-char (mark t))
4076 (pop-mark)))
4078 (defun push-mark-command (arg &optional nomsg)
4079 "Set mark at where point is.
4080 If no prefix ARG and mark is already set there, just activate it.
4081 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4082 (interactive "P")
4083 (let ((mark (marker-position (mark-marker))))
4084 (if (or arg (null mark) (/= mark (point)))
4085 (push-mark nil nomsg t)
4086 (setq mark-active t)
4087 (run-hooks 'activate-mark-hook)
4088 (unless nomsg
4089 (message "Mark activated")))))
4091 (defcustom set-mark-command-repeat-pop nil
4094 will pop the mark twice, and
4096 will pop the mark three times.
4100 :type 'boolean
4101 :group 'editing-basics)
4103 (defcustom set-mark-default-inactive nil
4104 "If non-nil, setting the mark does not activate it.
4106 behave the same whether or not `transient-mark-mode' is enabled."
4107 :type 'boolean
4108 :group 'editing-basics
4109 :version "23.1")
4111 (defun set-mark-command (arg)
4112 "Set the mark where point is, or jump to the mark.
4113 Setting the mark also alters the region, which is the text
4114 between point and mark; this is the closest equivalent in
4117 With no prefix argument, set the mark at point, and push the
4118 old mark position on local mark ring. Also push the old mark on
4119 global mark ring, if the previous mark was set in another buffer.
4121 When Transient Mark Mode is off, immediately repeating this
4122 command activates `transient-mark-mode' temporarily.
4125 jump to the mark, and set the mark from
4126 position popped off the local mark ring \(this does not affect the global
4128 mark ring \(see `pop-global-mark'\).
4130 If `set-mark-command-repeat-pop' is non-nil, repeating
4132 off the local (or global) mark ring and jumps there.
4135 argument, unconditionally set mark where point is, even if
4136 `set-mark-command-repeat-pop' is non-nil.
4138 Novice Emacs Lisp programmers often try to use the mark for the wrong
4139 purposes. See the documentation of `set-mark' for more information."
4140 (interactive "P")
4141 (cond ((eq transient-mark-mode 'lambda)
4142 (setq transient-mark-mode nil))
4143 ((eq (car-safe transient-mark-mode) 'only)
4144 (deactivate-mark)))
4145 (cond
4146 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4147 (push-mark-command nil))
4148 ((not (eq this-command 'set-mark-command))
4149 (if arg
4150 (pop-to-mark-command)
4151 (push-mark-command t)))
4152 ((and set-mark-command-repeat-pop
4153 (eq last-command 'pop-to-mark-command))
4154 (setq this-command 'pop-to-mark-command)
4155 (pop-to-mark-command))
4156 ((and set-mark-command-repeat-pop
4157 (eq last-command 'pop-global-mark)
4158 (not arg))
4159 (setq this-command 'pop-global-mark)
4160 (pop-global-mark))
4161 (arg
4162 (setq this-command 'pop-to-mark-command)
4163 (pop-to-mark-command))
4164 ((eq last-command 'set-mark-command)
4165 (if (region-active-p)
4166 (progn
4167 (deactivate-mark)
4168 (message "Mark deactivated"))
4169 (activate-mark)
4170 (message "Mark activated")))
4171 (t
4172 (push-mark-command nil)
4173 (if set-mark-default-inactive (deactivate-mark)))))
4175 (defun push-mark (&optional location nomsg activate)
4176 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4177 If the last global mark pushed was not in the current buffer,
4178 also push LOCATION on the global mark ring.
4179 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4181 Novice Emacs Lisp programmers often try to use the mark for the wrong
4182 purposes. See the documentation of `set-mark' for more information.
4184 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4185 (unless (null (mark t))
4186 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4187 (when (> (length mark-ring) mark-ring-max)
4188 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4189 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4190 (set-marker (mark-marker) (or location (point)) (current-buffer))
4191 ;; Now push the mark on the global mark ring.
4192 (if (and global-mark-ring
4193 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4194 ;; The last global mark pushed was in this same buffer.
4195 ;; Don't push another one.
4196 nil
4197 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4198 (when (> (length global-mark-ring) global-mark-ring-max)
4199 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4200 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4201 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4202 (message "Mark set"))
4203 (if (or activate (not transient-mark-mode))
4204 (set-mark (mark t)))
4205 nil)
4207 (defun pop-mark ()
4208 "Pop off mark ring into the buffer's actual mark.
4209 Does not set point. Does nothing if mark ring is empty."
4210 (when mark-ring
4211 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4212 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4213 (move-marker (car mark-ring) nil)
4214 (if (null (mark t)) (ding))
4215 (setq mark-ring (cdr mark-ring)))
4216 (deactivate-mark))
4218 (define-obsolete-function-alias
4219 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4220 (defun exchange-point-and-mark (&optional arg)
4221 "Put the mark where point is now, and point where the mark is now.
4222 This command works even when the mark is not active,
4223 and it reactivates the mark.
4225 If Transient Mark mode is on, a prefix ARG deactivates the mark
4226 if it is active, and otherwise avoids reactivating it. If
4227 Transient Mark mode is off, a prefix ARG enables Transient Mark
4228 mode temporarily."
4229 (interactive "P")
4230 (let ((omark (mark t))
4231 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4232 (if (null omark)
4233 (error "No mark set in this buffer"))
4234 (deactivate-mark)
4235 (set-mark (point))
4236 (goto-char omark)
4237 (if set-mark-default-inactive (deactivate-mark))
4238 (cond (temp-highlight
4239 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4240 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4241 (not (or arg (region-active-p))))
4242 (deactivate-mark))
4243 (t (activate-mark)))
4244 nil))
4246 (defcustom shift-select-mode t
4247 "When non-nil, shifted motion keys activate the mark momentarily.
4249 While the mark is activated in this way, any shift-translated point
4250 motion key extends the region, and if Transient Mark mode was off, it
4251 is temporarily turned on. Furthermore, the mark will be deactivated
4252 by any subsequent point motion key that was not shift-translated, or
4253 by any action that normally deactivates the mark in Transient Mark mode.
4255 See `this-command-keys-shift-translated' for the meaning of
4256 shift-translation."
4257 :type 'boolean
4258 :group 'editing-basics)
4260 (defun handle-shift-selection ()
4261 "Activate/deactivate mark depending on invocation thru shift translation.
4262 This function is called by `call-interactively' when a command
4263 with a `^' character in its `interactive' spec is invoked, before
4264 running the command itself.
4266 If `shift-select-mode' is enabled and the command was invoked
4267 through shift translation, set the mark and activate the region
4268 temporarily, unless it was already set in this way. See
4269 `this-command-keys-shift-translated' for the meaning of shift
4270 translation.
4272 Otherwise, if the region has been activated temporarily,
4273 deactivate it, and restore the variable `transient-mark-mode' to
4274 its earlier value."
4275 (cond ((and shift-select-mode this-command-keys-shift-translated)
4276 (unless (and mark-active
4277 (eq (car-safe transient-mark-mode) 'only))
4278 (setq transient-mark-mode
4279 (cons 'only
4280 (unless (eq transient-mark-mode 'lambda)
4281 transient-mark-mode)))
4282 (push-mark nil nil t)))
4283 ((eq (car-safe transient-mark-mode) 'only)
4284 (setq transient-mark-mode (cdr transient-mark-mode))
4285 (deactivate-mark))))
4287 (define-minor-mode transient-mark-mode
4288 "Toggle Transient Mark mode.
4289 With a prefix argument ARG, enable Transient Mark mode if ARG is
4290 positive, and disable it otherwise. If called from Lisp, enable
4291 Transient Mark mode if ARG is omitted or nil.
4293 Transient Mark mode is a global minor mode. When enabled, the
4294 region is highlighted whenever the mark is active. The mark is
4296 operations that set the mark but whose main purpose is something
4302 Many commands change their behavior when Transient Mark mode is in effect
4303 and the mark is active, by acting on the region instead of their usual
4304 default part of the buffer's text. Examples of such commands include
4309 commands which are sensitive to the Transient Mark mode."
4310 :global t
4311 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4312 :variable transient-mark-mode)
4314 (defvar widen-automatically t
4315 "Non-nil means it is ok for commands to call `widen' when they want to.
4316 Some commands will do this in order to go to positions outside
4317 the current accessible part of the buffer.
4319 If `widen-automatically' is nil, these commands will do something else
4320 as a fallback, and won't change the buffer bounds.")
4322 (defvar non-essential nil
4323 "Whether the currently executing code is performing an essential task.
4324 This variable should be non-nil only when running code which should not
4325 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4326 user for a password when we are simply scanning a set of files in the
4327 background or displaying possible completions before the user even asked
4328 for it.")
4330 (defun pop-global-mark ()
4331 "Pop off global mark ring and jump to the top location."
4332 (interactive)
4333 ;; Pop entries which refer to non-existent buffers.
4334 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4335 (setq global-mark-ring (cdr global-mark-ring)))
4336 (or global-mark-ring
4337 (error "No global mark set"))
4338 (let* ((marker (car global-mark-ring))
4339 (buffer (marker-buffer marker))
4340 (position (marker-position marker)))
4341 (setq global-mark-ring (nconc (cdr global-mark-ring)
4342 (list (car global-mark-ring))))
4343 (set-buffer buffer)
4344 (or (and (>= position (point-min))
4345 (<= position (point-max)))
4346 (if widen-automatically
4347 (widen)
4348 (error "Global mark position is outside accessible part of buffer")))
4349 (goto-char position)
4350 (switch-to-buffer buffer)))
4351 \f
4352 (defcustom next-line-add-newlines nil
4353 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4354 :type 'boolean
4355 :version "21.1"
4356 :group 'editing-basics)
4358 (defun next-line (&optional arg try-vscroll)
4359 "Move cursor vertically down ARG lines.
4360 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4361 If there is no character in the target line exactly under the current column,
4362 the cursor is positioned after the character in that line which spans this
4363 column, or at the end of the line if it is not long enough.
4364 If there is no line in the buffer after this one, behavior depends on the
4365 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4366 to create a line, and moves the cursor to that line. Otherwise it moves the
4367 cursor to the end of the buffer.
4369 If the variable `line-move-visual' is non-nil, this command moves
4370 by display lines. Otherwise, it moves by buffer lines, without
4371 taking variable-width characters or continued lines into account.
4374 a semipermanent goal column for this command.
4375 Then instead of trying to move exactly vertically (or as close as possible),
4376 this command moves to the specified goal column (or as close as possible).
4377 The goal column is stored in the variable `goal-column', which is nil
4378 when there is no goal column. Note that setting `goal-column'
4379 overrides `line-move-visual' and causes this command to move by buffer
4380 lines rather than by display lines.
4382 If you are thinking of using this in a Lisp program, consider
4383 using `forward-line' instead. It is usually easier to use
4384 and more reliable (no dependence on goal column, etc.)."
4386 (or arg (setq arg 1))
4387 (if (and next-line-add-newlines (= arg 1))
4388 (if (save-excursion (end-of-line) (eobp))
4389 ;; When adding a newline, don't expand an abbrev.
4390 (let ((abbrev-mode nil))
4391 (end-of-line)
4393 (line-move arg nil nil try-vscroll))
4394 (if (called-interactively-p 'interactive)
4395 (condition-case err
4396 (line-move arg nil nil try-vscroll)
4397 ((beginning-of-buffer end-of-buffer)
4398 (signal (car err) (cdr err))))
4399 (line-move arg nil nil try-vscroll)))
4400 nil)
4402 (defun previous-line (&optional arg try-vscroll)
4403 "Move cursor vertically up ARG lines.
4404 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4405 If there is no character in the target line exactly over the current column,
4406 the cursor is positioned after the character in that line which spans this
4407 column, or at the end of the line if it is not long enough.
4409 If the variable `line-move-visual' is non-nil, this command moves
4410 by display lines. Otherwise, it moves by buffer lines, without
4411 taking variable-width characters or continued lines into account.
4414 a semipermanent goal column for this command.
4415 Then instead of trying to move exactly vertically (or as close as possible),
4416 this command moves to the specified goal column (or as close as possible).
4417 The goal column is stored in the variable `goal-column', which is nil
4418 when there is no goal column. Note that setting `goal-column'
4419 overrides `line-move-visual' and causes this command to move by buffer
4420 lines rather than by display lines.
4422 If you are thinking of using this in a Lisp program, consider using
4423 `forward-line' with a negative argument instead. It is usually easier
4424 to use and more reliable (no dependence on goal column, etc.)."
4426 (or arg (setq arg 1))
4427 (if (called-interactively-p 'interactive)
4428 (condition-case err
4429 (line-move (- arg) nil nil try-vscroll)
4430 ((beginning-of-buffer end-of-buffer)
4431 (signal (car err) (cdr err))))
4432 (line-move (- arg) nil nil try-vscroll))
4433 nil)
4435 (defcustom track-eol nil
4436 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4437 This means moving to the end of each line moved onto.
4438 The beginning of a blank line does not count as the end of a line.
4439 This has no effect when `line-move-visual' is non-nil."
4440 :type 'boolean
4441 :group 'editing-basics)
4443 (defcustom goal-column nil
4445 A non-nil setting overrides `line-move-visual', which see."
4446 :type '(choice integer
4447 (const :tag "None" nil))
4448 :group 'editing-basics)
4449 (make-variable-buffer-local 'goal-column)
4451 (defvar temporary-goal-column 0
4452 "Current goal column for vertical motion.
4453 It is the column where point was at the start of the current run
4454 of vertical motion commands.
4456 When moving by visual lines via `line-move-visual', it is a cons
4457 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4458 divided by the default column width, and HSCROLL is the number of
4459 columns by which window is scrolled from left margin.
4461 When the `track-eol' feature is doing its job, the value is
4462 `most-positive-fixnum'.")
4464 (defcustom line-move-ignore-invisible t
4466 Outline mode sets this."
4467 :type 'boolean
4468 :group 'editing-basics)
4470 (defcustom line-move-visual t
4471 "When non-nil, `line-move' moves point by visual lines.
4472 This movement is based on where the cursor is displayed on the
4473 screen, instead of relying on buffer contents alone. It takes
4474 into account variable-width characters and line continuation.
4475 If nil, `line-move' moves point by logical lines.
4476 A non-nil setting of `goal-column' overrides the value of this variable
4477 and forces movement by logical lines.
4478 A window that is horizontally scrolled also forces movement by logical
4479 lines."
4480 :type 'boolean
4481 :group 'editing-basics
4482 :version "23.1")
4484 ;; Returns non-nil if partial move was done.
4485 (defun line-move-partial (arg noerror to-end)
4486 (if (< arg 0)
4487 ;; Move backward (up).
4488 ;; If already vscrolled, reduce vscroll
4489 (let ((vs (window-vscroll nil t)))
4490 (when (> vs (frame-char-height))
4491 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4493 ;; Move forward (down).
4494 (let* ((lh (window-line-height -1))
4495 (vpos (nth 1 lh))
4496 (ypos (nth 2 lh))
4497 (rbot (nth 3 lh))
4498 py vs)
4499 (when (or (null lh)
4500 (>= rbot (frame-char-height))
4501 (<= ypos (- (frame-char-height))))
4502 (unless lh
4503 (let ((wend (pos-visible-in-window-p t nil t)))
4504 (setq rbot (nth 3 wend)
4505 vpos (nth 5 wend))))
4506 (cond
4507 ;; If last line of window is fully visible, move forward.
4508 ((or (null rbot) (= rbot 0))
4509 nil)
4510 ;; If cursor is not in the bottom scroll margin, move forward.
4511 ((and (> vpos 0)
4512 (< (setq py
4513 (or (nth 1 (window-line-height))
4514 (let ((ppos (posn-at-point)))
4515 (cdr (or (posn-actual-col-row ppos)
4516 (posn-col-row ppos))))))
4517 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4518 nil)
4519 ;; When already vscrolled, we vscroll some more if we can,
4520 ;; or clear vscroll and move forward at end of tall image.
4521 ((> (setq vs (window-vscroll nil t)) 0)
4522 (when (> rbot 0)
4523 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4524 ;; If cursor just entered the bottom scroll margin, move forward,
4525 ;; but also vscroll one line so redisplay won't recenter.
4526 ((and (> vpos 0)
4527 (= py (min (- (window-text-height) scroll-margin 1)
4528 (1- vpos))))
4529 (set-window-vscroll nil (frame-char-height) t)
4530 (line-move-1 arg noerror to-end)
4531 t)
4532 ;; If there are lines above the last line, scroll-up one line.
4533 ((> vpos 0)
4534 (scroll-up 1)
4535 t)
4536 ;; Finally, start vscroll.
4537 (t
4538 (set-window-vscroll nil (frame-char-height) t)))))))
4541 ;; This is like line-move-1 except that it also performs
4542 ;; vertical scrolling of tall images if appropriate.
4543 ;; That is not really a clean thing to do, since it mixes
4544 ;; scrolling with cursor motion. But so far we don't have
4545 ;; a cleaner solution to the problem of making C-n do something
4546 ;; useful given a tall image.
4547 (defun line-move (arg &optional noerror to-end try-vscroll)
4548 (if noninteractive
4549 (forward-line arg)
4550 (unless (and auto-window-vscroll try-vscroll
4551 ;; Only vscroll for single line moves
4552 (= (abs arg) 1)
4553 ;; But don't vscroll in a keyboard macro.
4554 (not defining-kbd-macro)
4555 (not executing-kbd-macro)
4556 (line-move-partial arg noerror to-end))
4557 (set-window-vscroll nil 0 t)
4558 (if (and line-move-visual
4559 ;; Display-based column are incompatible with goal-column.
4560 (not goal-column)
4561 ;; When the text in the window is scrolled to the left,
4562 ;; display-based motion doesn't make sense (because each
4563 ;; logical line occupies exactly one screen line).
4564 (not (> (window-hscroll) 0)))
4565 (line-move-visual arg noerror)
4566 (line-move-1 arg noerror to-end)))))
4568 ;; Display-based alternative to line-move-1.
4569 ;; Arg says how many lines to move. The value is t if we can move the
4570 ;; specified number of lines.
4571 (defun line-move-visual (arg &optional noerror)
4572 (let ((opoint (point))
4573 (hscroll (window-hscroll))
4574 target-hscroll)
4575 ;; Check if the previous command was a line-motion command, or if
4576 ;; we were called from some other command.
4577 (if (and (consp temporary-goal-column)
4578 (memq last-command `(next-line previous-line ,this-command)))
4579 ;; If so, there's no need to reset `temporary-goal-column',
4580 ;; but we may need to hscroll.
4581 (if (or (/= (cdr temporary-goal-column) hscroll)
4582 (> (cdr temporary-goal-column) 0))
4583 (setq target-hscroll (cdr temporary-goal-column)))
4584 ;; Otherwise, we should reset `temporary-goal-column'.
4585 (let ((posn (posn-at-point)))
4586 (cond
4587 ;; Handle the `overflow-newline-into-fringe' case:
4588 ((eq (nth 1 posn) 'right-fringe)
4589 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4590 ((car (posn-x-y posn))
4591 (setq temporary-goal-column
4592 (cons (/ (float (car (posn-x-y posn)))
4593 (frame-char-width)) hscroll))))))
4594 (if target-hscroll
4595 (set-window-hscroll (selected-window) target-hscroll))
4596 (or (and (= (vertical-motion
4597 (cons (or goal-column
4598 (if (consp temporary-goal-column)
4599 (car temporary-goal-column)
4600 temporary-goal-column))
4601 arg))
4602 arg)
4603 (or (>= arg 0)
4604 (/= (point) opoint)
4605 ;; If the goal column lies on a display string,
4606 ;; `vertical-motion' advances the cursor to the end
4607 ;; of the string. For arg < 0, this can cause the
4608 ;; cursor to get stuck. (Bug#3020).
4609 (= (vertical-motion arg) arg)))
4610 (unless noerror
4611 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4612 nil)))))
4614 ;; This is the guts of next-line and previous-line.
4615 ;; Arg says how many lines to move.
4616 ;; The value is t if we can move the specified number of lines.
4617 (defun line-move-1 (arg &optional noerror _to-end)
4618 ;; Don't run any point-motion hooks, and disregard intangibility,
4619 ;; for intermediate positions.
4620 (let ((inhibit-point-motion-hooks t)
4621 (opoint (point))
4622 (orig-arg arg))
4623 (if (consp temporary-goal-column)
4624 (setq temporary-goal-column (+ (car temporary-goal-column)
4625 (cdr temporary-goal-column))))
4626 (unwind-protect
4627 (progn
4628 (if (not (memq last-command '(next-line previous-line)))
4629 (setq temporary-goal-column
4630 (if (and track-eol (eolp)
4631 ;; Don't count beg of empty line as end of line
4632 ;; unless we just did explicit end-of-line.
4633 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4634 most-positive-fixnum
4635 (current-column))))
4637 (if (not (or (integerp selective-display)
4638 line-move-ignore-invisible))
4639 ;; Use just newline characters.
4640 ;; Set ARG to 0 if we move as many lines as requested.
4641 (or (if (> arg 0)
4642 (progn (if (> arg 1) (forward-line (1- arg)))
4643 ;; This way of moving forward ARG lines
4644 ;; verifies that we have a newline after the last one.
4645 ;; It doesn't get confused by intangible text.
4646 (end-of-line)
4647 (if (zerop (forward-line 1))
4648 (setq arg 0)))
4649 (and (zerop (forward-line arg))
4650 (bolp)
4651 (setq arg 0)))
4652 (unless noerror
4653 (signal (if (< arg 0)
4654 'beginning-of-buffer
4655 'end-of-buffer)
4656 nil)))
4657 ;; Move by arg lines, but ignore invisible ones.
4658 (let (done)
4659 (while (and (> arg 0) (not done))
4660 ;; If the following character is currently invisible,
4661 ;; skip all characters with that same `invisible' property value.
4662 (while (and (not (eobp)) (invisible-p (point)))
4663 (goto-char (next-char-property-change (point))))
4664 ;; Move a line.
4665 ;; We don't use `end-of-line', since we want to escape
4666 ;; from field boundaries occurring exactly at point.
4667 (goto-char (constrain-to-field
4668 (let ((inhibit-field-text-motion t))
4669 (line-end-position))
4670 (point) t t
4671 'inhibit-line-move-field-capture))
4672 ;; If there's no invisibility here, move over the newline.
4673 (cond
4674 ((eobp)
4675 (if (not noerror)
4676 (signal 'end-of-buffer nil)
4677 (setq done t)))
4678 ((and (> arg 1) ;; Use vertical-motion for last move
4679 (not (integerp selective-display))
4680 (not (invisible-p (point))))
4681 ;; We avoid vertical-motion when possible
4682 ;; because that has to fontify.
4683 (forward-line 1))
4684 ;; Otherwise move a more sophisticated way.
4685 ((zerop (vertical-motion 1))
4686 (if (not noerror)
4687 (signal 'end-of-buffer nil)
4688 (setq done t))))
4689 (unless done
4690 (setq arg (1- arg))))
4691 ;; The logic of this is the same as the loop above,
4692 ;; it just goes in the other direction.
4693 (while (and (< arg 0) (not done))
4694 ;; For completely consistency with the forward-motion
4695 ;; case, we should call beginning-of-line here.
4696 ;; However, if point is inside a field and on a
4697 ;; continued line, the call to (vertical-motion -1)
4698 ;; below won't move us back far enough; then we return
4699 ;; to the same column in line-move-finish, and point
4700 ;; gets stuck -- cyd
4701 (forward-line 0)
4702 (cond
4703 ((bobp)
4704 (if (not noerror)
4705 (signal 'beginning-of-buffer nil)
4706 (setq done t)))
4707 ((and (< arg -1) ;; Use vertical-motion for last move
4708 (not (integerp selective-display))
4709 (not (invisible-p (1- (point)))))
4710 (forward-line -1))
4711 ((zerop (vertical-motion -1))
4712 (if (not noerror)
4713 (signal 'beginning-of-buffer nil)
4714 (setq done t))))
4715 (unless done
4716 (setq arg (1+ arg))
4717 (while (and ;; Don't move over previous invis lines
4718 ;; if our target is the middle of this line.
4719 (or (zerop (or goal-column temporary-goal-column))
4720 (< arg 0))
4721 (not (bobp)) (invisible-p (1- (point))))
4722 (goto-char (previous-char-property-change (point))))))))
4723 ;; This is the value the function returns.
4724 (= arg 0))
4726 (cond ((> arg 0)
4727 ;; If we did not move down as far as desired, at least go
4728 ;; to end of line. Be sure to call point-entered and
4729 ;; point-left-hooks.
4730 (let* ((npoint (prog1 (line-end-position)
4731 (goto-char opoint)))
4732 (inhibit-point-motion-hooks nil))
4733 (goto-char npoint)))
4734 ((< arg 0)
4735 ;; If we did not move up as far as desired,
4736 ;; at least go to beginning of line.
4737 (let* ((npoint (prog1 (line-beginning-position)
4738 (goto-char opoint)))
4739 (inhibit-point-motion-hooks nil))
4740 (goto-char npoint)))
4741 (t
4742 (line-move-finish (or goal-column temporary-goal-column)
4743 opoint (> orig-arg 0)))))))
4745 (defun line-move-finish (column opoint forward)
4746 (let ((repeat t))
4747 (while repeat
4748 ;; Set REPEAT to t to repeat the whole thing.
4749 (setq repeat nil)
4751 (let (new
4752 (old (point))
4753 (line-beg (line-beginning-position))
4754 (line-end
4755 ;; Compute the end of the line
4756 ;; ignoring effectively invisible newlines.
4757 (save-excursion
4758 ;; Like end-of-line but ignores fields.
4760 (while (and (not (eobp)) (invisible-p (point)))
4761 (goto-char (next-char-property-change (point)))
4763 (point))))
4765 ;; Move to the desired column.
4766 (line-move-to-column (truncate column))
4768 ;; Corner case: suppose we start out in a field boundary in
4769 ;; the middle of a continued line. When we get to
4770 ;; line-move-finish, point is at the start of a new *screen*
4771 ;; line but the same text line; then line-move-to-column would
4772 ;; move us backwards. Test using C-n with point on the "x" in
4773 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4774 (and forward
4775 (< (point) old)
4776 (goto-char old))
4778 (setq new (point))
4780 ;; Process intangibility within a line.
4781 ;; With inhibit-point-motion-hooks bound to nil, a call to
4782 ;; goto-char moves point past intangible text.
4784 ;; However, inhibit-point-motion-hooks controls both the
4785 ;; intangibility and the point-entered/point-left hooks. The
4786 ;; following hack avoids calling the point-* hooks
4787 ;; unnecessarily. Note that we move *forward* past intangible
4788 ;; text when the initial and final points are the same.
4789 (goto-char new)
4790 (let ((inhibit-point-motion-hooks nil))
4791 (goto-char new)
4793 ;; If intangibility moves us to a different (later) place
4794 ;; in the same line, use that as the destination.
4795 (if (<= (point) line-end)
4796 (setq new (point))
4797 ;; If that position is "too late",
4798 ;; try the previous allowable position.
4799 ;; See if it is ok.
4800 (backward-char)
4801 (if (if forward
4802 ;; If going forward, don't accept the previous
4803 ;; allowable position if it is before the target line.
4804 (< line-beg (point))
4805 ;; If going backward, don't accept the previous
4806 ;; allowable position if it is still after the target line.
4807 (<= (point) line-end))
4808 (setq new (point))
4809 ;; As a last resort, use the end of the line.
4810 (setq new line-end))))
4812 ;; Now move to the updated destination, processing fields
4813 ;; as well as intangibility.
4814 (goto-char opoint)
4815 (let ((inhibit-point-motion-hooks nil))
4816 (goto-char
4817 ;; Ignore field boundaries if the initial and final
4818 ;; positions have the same `field' property, even if the
4819 ;; fields are non-contiguous. This seems to be "nicer"
4820 ;; behavior in many situations.
4821 (if (eq (get-char-property new 'field)
4822 (get-char-property opoint 'field))
4823 new
4824 (constrain-to-field new opoint t t
4825 'inhibit-line-move-field-capture))))
4827 ;; If all this moved us to a different line,
4828 ;; retry everything within that new line.
4829 (when (or (< (point) line-beg) (> (point) line-end))
4830 ;; Repeat the intangibility and field processing.
4831 (setq repeat t))))))
4833 (defun line-move-to-column (col)
4834 "Try to find column COL, considering invisibility.
4835 This function works only in certain cases,
4836 because what we really need is for `move-to-column'
4837 and `current-column' to be able to ignore invisible text."
4838 (if (zerop col)
4839 (beginning-of-line)
4840 (move-to-column col))
4842 (when (and line-move-ignore-invisible
4843 (not (bolp)) (invisible-p (1- (point))))
4844 (let ((normal-location (point))
4845 (normal-column (current-column)))
4846 ;; If the following character is currently invisible,
4847 ;; skip all characters with that same `invisible' property value.
4848 (while (and (not (eobp))
4849 (invisible-p (point)))
4850 (goto-char (next-char-property-change (point))))
4851 ;; Have we advanced to a larger column position?
4852 (if (> (current-column) normal-column)
4853 ;; We have made some progress towards the desired column.
4854 ;; See if we can make any further progress.
4855 (line-move-to-column (+ (current-column) (- col normal-column)))
4856 ;; Otherwise, go to the place we originally found
4857 ;; and move back over invisible text.
4858 ;; that will get us to the same place on the screen
4859 ;; but with a more reasonable buffer position.
4860 (goto-char normal-location)
4861 (let ((line-beg (line-beginning-position)))
4862 (while (and (not (bolp)) (invisible-p (1- (point))))
4863 (goto-char (previous-char-property-change (point) line-beg))))))))
4865 (defun move-end-of-line (arg)
4866 "Move point to end of current line as displayed.
4867 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4868 If point reaches the beginning or end of buffer, it stops there.
4870 To ignore the effects of the `intangible' text or overlay
4871 property, bind `inhibit-point-motion-hooks' to t.
4872 If there is an image in the current line, this function
4873 disregards newlines that are part of the text on which the image
4874 rests."
4875 (interactive "^p")
4876 (or arg (setq arg 1))
4877 (let (done)
4878 (while (not done)
4879 (let ((newpos
4880 (save-excursion
4881 (let ((goal-column 0)
4882 (line-move-visual nil))
4883 (and (line-move arg t)
4884 ;; With bidi reordering, we may not be at bol,
4885 ;; so make sure we are.
4887 (not (bobp))
4888 (progn
4889 (while (and (not (bobp)) (invisible-p (1- (point))))
4890 (goto-char (previous-single-char-property-change
4891 (point) 'invisible)))
4892 (backward-char 1)))
4893 (point)))))
4894 (goto-char newpos)
4895 (if (and (> (point) newpos)
4897 (backward-char 1)
4898 (if (and (> (point) newpos) (not (eobp))
4900 ;; If we skipped something intangible and now we're not
4901 ;; really at eol, keep going.
4902 (setq arg 1)
4903 (setq done t)))))))
4905 (defun move-beginning-of-line (arg)
4906 "Move point to beginning of current line as displayed.
4907 \(If there's an image in the line, this disregards newlines
4908 which are part of the text that the image rests on.)
4910 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4911 If point reaches the beginning or end of buffer, it stops there.
4912 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4913 (interactive "^p")
4914 (or arg (setq arg 1))
4916 (let ((orig (point))
4917 first-vis first-vis-field-value)
4919 ;; Move by lines, if ARG is not 1 (the default).
4920 (if (/= arg 1)
4921 (let ((line-move-visual nil))
4922 (line-move (1- arg) t)))
4924 ;; Move to beginning-of-line, ignoring fields and invisible text.
4926 (while (and (not (bobp)) (invisible-p (1- (point))))
4927 (goto-char (previous-char-property-change (point)))
4930 ;; Now find first visible char in the line
4931 (while (and (not (eobp)) (invisible-p (point)))
4932 (goto-char (next-char-property-change (point))))
4933 (setq first-vis (point))
4935 ;; See if fields would stop us from reaching FIRST-VIS.
4936 (setq first-vis-field-value
4937 (constrain-to-field first-vis orig (/= arg 1) t nil))
4939 (goto-char (if (/= first-vis-field-value first-vis)
4940 ;; If yes, obey them.
4941 first-vis-field-value
4942 ;; Otherwise, move to START with attention to fields.
4943 ;; (It is possible that fields never matter in this case.)
4944 (constrain-to-field (point) orig
4945 (/= arg 1) t nil)))))
4948 ;; Many people have said they rarely use this feature, and often type
4949 ;; it by accident. Maybe it shouldn't even be on a key.
4950 (put 'set-goal-column 'disabled t)
4952 (defun set-goal-column (arg)
4954 Those commands will move to this position in the line moved to
4955 rather than trying to keep the same horizontal position.
4956 With a non-nil argument ARG, clears out the goal column
4958 The goal column is stored in the variable `goal-column'."
4959 (interactive "P")
4960 (if arg
4961 (progn
4962 (setq goal-column nil)
4963 (message "No goal column"))
4964 (setq goal-column (current-column))
4965 ;; The older method below can be erroneous if `set-goal-column' is bound
4966 ;; to a sequence containing %
4967 ;;(message (substitute-command-keys
4969 ;;goal-column)
4970 (message "%s"
4971 (concat
4972 (format "Goal column %d " goal-column)
4973 (substitute-command-keys
4976 )
4977 nil)
4978 \f
4979 ;;; Editing based on visual lines, as opposed to logical lines.
4981 (defun end-of-visual-line (&optional n)
4982 "Move point to end of current visual line.
4983 With argument N not nil or 1, move forward N - 1 visual lines first.
4984 If point reaches the beginning or end of buffer, it stops there.
4985 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4986 (interactive "^p")
4987 (or n (setq n 1))
4988 (if (/= n 1)
4989 (let ((line-move-visual t))
4990 (line-move (1- n) t)))
4991 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4992 ;; constrain to field boundaries, so we don't either.
4993 (vertical-motion (cons (window-width) 0)))
4995 (defun beginning-of-visual-line (&optional n)
4996 "Move point to beginning of current visual line.
4997 With argument N not nil or 1, move forward N - 1 visual lines first.
4998 If point reaches the beginning or end of buffer, it stops there.
4999 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5000 (interactive "^p")
5001 (or n (setq n 1))
5002 (let ((opoint (point)))
5003 (if (/= n 1)
5004 (let ((line-move-visual t))
5005 (line-move (1- n) t)))
5006 (vertical-motion 0)
5007 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5008 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5010 (defun kill-visual-line (&optional arg)
5011 "Kill the rest of the visual line.
5012 With prefix argument ARG, kill that many visual lines from point.
5013 If ARG is negative, kill visual lines backward.
5014 If ARG is zero, kill the text before point on the current visual
5015 line.
5017 If you want to append the killed line to the last killed text,
5020 If the buffer is read-only, Emacs will beep and refrain from deleting
5021 the line, but put the line in the kill ring anyway. This means that
5022 you can use this command to copy text from a read-only buffer.
5023 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5024 even beep.)"
5025 (interactive "P")
5026 ;; Like in `kill-line', it's better to move point to the other end
5027 ;; of the kill before killing.
5028 (let ((opoint (point))
5029 (kill-whole-line (and kill-whole-line (bolp))))
5030 (if arg
5031 (vertical-motion (prefix-numeric-value arg))
5032 (end-of-visual-line 1)
5033 (if (= (point) opoint)
5034 (vertical-motion 1)
5035 ;; Skip any trailing whitespace at the end of the visual line.
5036 ;; We used to do this only if `show-trailing-whitespace' is
5037 ;; nil, but that's wrong; the correct thing would be to check
5038 ;; whether the trailing whitespace is highlighted. But, it's
5039 ;; OK to just do this unconditionally.
5042 (1+ (point))
5043 (point)))))
5045 (defun next-logical-line (&optional arg try-vscroll)
5046 "Move cursor vertically down ARG lines.
5047 This is identical to `next-line', except that it always moves
5048 by logical lines instead of visual lines, ignoring the value of
5049 the variable `line-move-visual'."
5051 (let ((line-move-visual nil))
5052 (with-no-warnings
5053 (next-line arg try-vscroll))))
5055 (defun previous-logical-line (&optional arg try-vscroll)
5056 "Move cursor vertically up ARG lines.
5057 This is identical to `previous-line', except that it always moves
5058 by logical lines instead of visual lines, ignoring the value of
5059 the variable `line-move-visual'."
5061 (let ((line-move-visual nil))
5062 (with-no-warnings
5063 (previous-line arg try-vscroll))))
5065 (defgroup visual-line nil
5066 "Editing based on visual lines."
5067 :group 'convenience
5068 :version "23.1")
5070 (defvar visual-line-mode-map
5071 (let ((map (make-sparse-keymap)))
5072 (define-key map [remap kill-line] 'kill-visual-line)
5073 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5074 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5075 ;; These keybindings interfere with xterm function keys. Are
5076 ;; there any other suitable bindings?
5077 ;; (define-key map "\M-[" 'previous-logical-line)
5078 ;; (define-key map "\M-]" 'next-logical-line)
5079 map))
5081 (defcustom visual-line-fringe-indicators '(nil nil)
5082 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5083 The value should be a list of the form (LEFT RIGHT), where LEFT
5084 and RIGHT are symbols representing the bitmaps to display, to
5085 indicate wrapped lines, in the left and right fringes respectively.
5086 See also `fringe-indicator-alist'.
5087 The default is not to display fringe indicators for wrapped lines.
5088 This variable does not affect fringe indicators displayed for
5089 other purposes."
5090 :type '(list (choice (const :tag "Hide left indicator" nil)
5091 (const :tag "Left curly arrow" left-curly-arrow)
5092 (symbol :tag "Other bitmap"))
5093 (choice (const :tag "Hide right indicator" nil)
5094 (const :tag "Right curly arrow" right-curly-arrow)
5095 (symbol :tag "Other bitmap")))
5096 :set (lambda (symbol value)
5097 (dolist (buf (buffer-list))
5098 (with-current-buffer buf
5099 (when (and (boundp 'visual-line-mode)
5100 (symbol-value 'visual-line-mode))
5101 (setq fringe-indicator-alist
5102 (cons (cons 'continuation value)
5103 (assq-delete-all
5104 'continuation
5105 (copy-tree fringe-indicator-alist)))))))
5106 (set-default symbol value)))
5108 (defvar visual-line--saved-state nil)
5110 (define-minor-mode visual-line-mode
5111 "Toggle visual line based editing (Visual Line mode).
5112 With a prefix argument ARG, enable Visual Line mode if ARG is
5113 positive, and disable it otherwise. If called from Lisp, enable
5114 the mode if ARG is omitted or nil.
5116 When Visual Line mode is enabled, `word-wrap' is turned on in
5117 this buffer, and simple editing commands are redefined to act on
5118 visual lines, not logical lines. See Info node `Visual Line
5119 Mode' for details."
5120 :keymap visual-line-mode-map
5121 :group 'visual-line
5122 :lighter " Wrap"
5123 (if visual-line-mode
5124 (progn
5125 (set (make-local-variable 'visual-line--saved-state) nil)
5126 ;; Save the local values of some variables, to be restored if
5127 ;; visual-line-mode is turned off.
5128 (dolist (var '(line-move-visual truncate-lines
5129 truncate-partial-width-windows
5130 word-wrap fringe-indicator-alist))
5131 (if (local-variable-p var)
5132 (push (cons var (symbol-value var))
5133 visual-line--saved-state)))
5134 (set (make-local-variable 'line-move-visual) t)
5135 (set (make-local-variable 'truncate-partial-width-windows) nil)
5136 (setq truncate-lines nil
5137 word-wrap t
5138 fringe-indicator-alist
5139 (cons (cons 'continuation visual-line-fringe-indicators)
5140 fringe-indicator-alist)))
5141 (kill-local-variable 'line-move-visual)
5142 (kill-local-variable 'word-wrap)
5143 (kill-local-variable 'truncate-lines)
5144 (kill-local-variable 'truncate-partial-width-windows)
5145 (kill-local-variable 'fringe-indicator-alist)
5146 (dolist (saved visual-line--saved-state)
5147 (set (make-local-variable (car saved)) (cdr saved)))
5148 (kill-local-variable 'visual-line--saved-state)))
5150 (defun turn-on-visual-line-mode ()
5151 (visual-line-mode 1))
5153 (define-globalized-minor-mode global-visual-line-mode
5154 visual-line-mode turn-on-visual-line-mode
5155 :lighter " vl")
5157 \f
5158 (defun transpose-chars (arg)
5159 "Interchange characters around point, moving forward one character.
5160 With prefix arg ARG, effect is to take character before point
5161 and drag it forward past ARG other characters (backward if ARG negative).
5162 If no argument and at end of line, the previous two chars are exchanged."
5163 (interactive "*P")
5164 (and (null arg) (eolp) (forward-char -1))
5165 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5167 (defun transpose-words (arg)
5168 "Interchange words around point, leaving point at end of them.
5169 With prefix arg ARG, effect is to take word before or around point
5170 and drag it forward past ARG other words (backward if ARG negative).
5171 If ARG is zero, the words around or after point and around or after mark
5172 are interchanged."
5173 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5174 (interactive "*p")
5175 (transpose-subr 'forward-word arg))
5177 (defun transpose-sexps (arg)
5179 Does not work on a sexp that point is in the middle of
5180 if it is a list or string."
5181 (interactive "*p")
5182 (transpose-subr
5183 (lambda (arg)
5184 ;; Here we should try to simulate the behavior of
5185 ;; (cons (progn (forward-sexp x) (point))
5186 ;; (progn (forward-sexp (- x)) (point)))
5187 ;; Except that we don't want to rely on the second forward-sexp
5188 ;; putting us back to where we want to be, since forward-sexp-function
5189 ;; might do funny things like infix-precedence.
5190 (if (if (> arg 0)
5192 (and (not (bobp))
5194 ;; Jumping over a symbol. We might be inside it, mind you.
5195 (progn (funcall (if (> arg 0)
5196 'skip-syntax-backward 'skip-syntax-forward)
5197 "w_")
5198 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5199 ;; Otherwise, we're between sexps. Take a step back before jumping
5200 ;; to make sure we'll obey the same precedence no matter which direction
5201 ;; we're going.
5202 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5203 (cons (save-excursion (forward-sexp arg) (point))
5204 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5205 (not (zerop (funcall (if (> arg 0)
5206 'skip-syntax-forward
5207 'skip-syntax-backward)
5208 ".")))))
5209 (point)))))
5210 arg 'special))
5212 (defun transpose-lines (arg)
5213 "Exchange current line and previous line, leaving point after both.
5214 With argument ARG, takes previous line and moves it past ARG lines.
5215 With argument 0, interchanges line point is in with line mark is in."
5216 (interactive "*p")
5217 (transpose-subr (function
5218 (lambda (arg)
5219 (if (> arg 0)
5220 (progn
5221 ;; Move forward over ARG lines,
5222 ;; but create newlines if necessary.
5223 (setq arg (forward-line arg))
5225 (setq arg (1+ arg)))
5226 (if (> arg 0)
5227 (newline arg)))
5228 (forward-line arg))))
5229 arg))
5231 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5232 ;; which seems inconsistent with the ARG /= 0 case.
5233 ;; FIXME document SPECIAL.
5234 (defun transpose-subr (mover arg &optional special)
5235 "Subroutine to do the work of transposing objects.
5236 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5237 moves forward by units of the given object (e.g. forward-sentence,
5238 forward-paragraph). If ARG is zero, exchanges the current object
5239 with the one containing mark. If ARG is an integer, moves the
5240 current object past ARG following (if ARG is positive) or
5241 preceding (if ARG is negative) objects, leaving point after the
5242 current object."
5243 (let ((aux (if special mover
5244 (lambda (x)
5245 (cons (progn (funcall mover x) (point))
5246 (progn (funcall mover (- x)) (point))))))
5247 pos1 pos2)
5248 (cond
5249 ((= arg 0)
5250 (save-excursion
5251 (setq pos1 (funcall aux 1))
5252 (goto-char (or (mark) (error "No mark set in this buffer")))
5253 (setq pos2 (funcall aux 1))
5254 (transpose-subr-1 pos1 pos2))
5255 (exchange-point-and-mark))
5256 ((> arg 0)
5257 (setq pos1 (funcall aux -1))
5258 (setq pos2 (funcall aux arg))
5259 (transpose-subr-1 pos1 pos2)
5260 (goto-char (car pos2)))
5261 (t
5262 (setq pos1 (funcall aux -1))
5263 (goto-char (car pos1))
5264 (setq pos2 (funcall aux arg))
5265 (transpose-subr-1 pos1 pos2)))))
5267 (defun transpose-subr-1 (pos1 pos2)
5268 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5269 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5270 (when (> (car pos1) (car pos2))
5271 (let ((swap pos1))
5272 (setq pos1 pos2 pos2 swap)))
5273 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5274 (atomic-change-group
5275 (let (word2)
5276 ;; FIXME: We first delete the two pieces of text, so markers that
5277 ;; used to point to after the text end up pointing to before it :-(
5278 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5279 (goto-char (car pos2))
5280 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5281 (goto-char (car pos1))
5282 (insert word2))))
5283 \f
5284 (defun backward-word (&optional arg)
5285 "Move backward until encountering the beginning of a word.
5286 With argument ARG, do this that many times."
5287 (interactive "^p")
5288 (forward-word (- (or arg 1))))
5290 (defun mark-word (&optional arg allow-extend)
5291 "Set mark ARG words away from point.
5293 move to with the same argument.
5294 Interactively, if this command is repeated
5295 or (in Transient Mark mode) if the mark is active,
5296 it marks the next ARG words after the ones already marked."
5298 (cond ((and allow-extend
5299 (or (and (eq last-command this-command) (mark t))
5300 (region-active-p)))
5301 (setq arg (if arg (prefix-numeric-value arg)
5302 (if (< (mark) (point)) -1 1)))
5303 (set-mark
5304 (save-excursion
5305 (goto-char (mark))
5306 (forward-word arg)
5307 (point))))
5308 (t
5309 (push-mark
5310 (save-excursion
5311 (forward-word (prefix-numeric-value arg))
5312 (point))
5313 nil t))))
5315 (defun kill-word (arg)
5316 "Kill characters forward until encountering the end of a word.
5317 With argument ARG, do this that many times."
5318 (interactive "p")
5319 (kill-region (point) (progn (forward-word arg) (point))))
5321 (defun backward-kill-word (arg)
5322 "Kill characters backward until encountering the beginning of a word.
5323 With argument ARG, do this that many times."
5324 (interactive "p")
5325 (kill-word (- arg)))
5327 (defun current-word (&optional strict really-word)
5328 "Return the symbol or word that point is on (or a nearby one) as a string.
5329 The return value includes no text properties.
5330 If optional arg STRICT is non-nil, return nil unless point is within
5331 or adjacent to a symbol or word. In all cases the value can be nil
5332 if there is no word nearby.
5333 The function, belying its name, normally finds a symbol.
5334 If optional arg REALLY-WORD is non-nil, it finds just a word."
5335 (save-excursion
5336 (let* ((oldpoint (point)) (start (point)) (end (point))
5337 (syntaxes (if really-word "w" "w_"))
5338 (not-syntaxes (concat "^" syntaxes)))
5339 (skip-syntax-backward syntaxes) (setq start (point))
5340 (goto-char oldpoint)
5341 (skip-syntax-forward syntaxes) (setq end (point))
5342 (when (and (eq start oldpoint) (eq end oldpoint)
5343 ;; Point is neither within nor adjacent to a word.
5344 (not strict))
5345 ;; Look for preceding word in same line.
5346 (skip-syntax-backward not-syntaxes (line-beginning-position))
5347 (if (bolp)
5348 ;; No preceding word in same line.
5349 ;; Look for following word in same line.
5350 (progn
5351 (skip-syntax-forward not-syntaxes (line-end-position))
5352 (setq start (point))
5353 (skip-syntax-forward syntaxes)
5354 (setq end (point)))
5355 (setq end (point))
5356 (skip-syntax-backward syntaxes)
5357 (setq start (point))))
5358 ;; If we found something nonempty, return it as a string.
5359 (unless (= start end)
5360 (buffer-substring-no-properties start end)))))
5361 \f
5362 (defcustom fill-prefix nil
5363 "String for filling to insert at front of new line, or nil for none."
5364 :type '(choice (const :tag "None" nil)
5365 string)
5366 :group 'fill)
5367 (make-variable-buffer-local 'fill-prefix)
5368 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5370 (defcustom auto-fill-inhibit-regexp nil
5371 "Regexp to match lines which should not be auto-filled."
5372 :type '(choice (const :tag "None" nil)
5373 regexp)
5374 :group 'fill)
5376 (defun do-auto-fill ()
5377 "The default value for `normal-auto-fill-function'.
5378 This is the default auto-fill function, some major modes use a different one.
5379 Returns t if it really did any work."
5380 (let (fc justify give-up
5381 (fill-prefix fill-prefix))
5382 (if (or (not (setq justify (current-justification)))
5383 (null (setq fc (current-fill-column)))
5384 (and (eq justify 'left)
5385 (<= (current-column) fc))
5386 (and auto-fill-inhibit-regexp
5387 (save-excursion (beginning-of-line)
5388 (looking-at auto-fill-inhibit-regexp))))
5389 nil ;; Auto-filling not required
5390 (if (memq justify '(full center right))
5391 (save-excursion (unjustify-current-line)))
5393 ;; Choose a fill-prefix automatically.
5394 (when (and adaptive-fill-mode
5395 (or (null fill-prefix) (string= fill-prefix "")))
5396 (let ((prefix
5397 (fill-context-prefix
5398 (save-excursion (fill-forward-paragraph -1) (point))
5399 (save-excursion (fill-forward-paragraph 1) (point)))))
5400 (and prefix (not (equal prefix ""))
5401 ;; Use auto-indentation rather than a guessed empty prefix.
5402 (not (and fill-indent-according-to-mode
5404 (setq fill-prefix prefix))))
5406 (while (and (not give-up) (> (current-column) fc))
5407 ;; Determine where to split the line.
5408 (let* (after-prefix
5409 (fill-point
5410 (save-excursion
5411 (beginning-of-line)
5412 (setq after-prefix (point))
5413 (and fill-prefix
5414 (looking-at (regexp-quote fill-prefix))
5415 (setq after-prefix (match-end 0)))
5416 (move-to-column (1+ fc))
5417 (fill-move-to-break-point after-prefix)
5418 (point))))
5420 ;; See whether the place we found is any good.
5421 (if (save-excursion
5422 (goto-char fill-point)
5423 (or (bolp)
5424 ;; There is no use breaking at end of line.
5425 (save-excursion (skip-chars-forward " ") (eolp))
5426 ;; It is futile to split at the end of the prefix
5427 ;; since we would just insert the prefix again.
5428 (and after-prefix (<= (point) after-prefix))
5429 ;; Don't split right after a comment starter
5430 ;; since we would just make another comment starter.
5431 (and comment-start-skip
5432 (let ((limit (point)))
5433 (beginning-of-line)
5434 (and (re-search-forward comment-start-skip
5435 limit t)
5436 (eq (point) limit))))))
5437 ;; No good place to break => stop trying.
5438 (setq give-up t)
5439 ;; Ok, we have a useful place to break the line. Do it.
5440 (let ((prev-column (current-column)))
5441 ;; If point is at the fill-point, do not `save-excursion'.
5442 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5443 ;; point will end up before it rather than after it.
5444 (if (save-excursion
5446 (= (point) fill-point))
5447 (default-indent-new-line t)
5448 (save-excursion
5449 (goto-char fill-point)
5450 (default-indent-new-line t)))
5451 ;; Now do justification, if required
5452 (if (not (eq justify 'left))
5453 (save-excursion
5454 (end-of-line 0)
5455 (justify-current-line justify nil t)))
5456 ;; If making the new line didn't reduce the hpos of
5457 ;; the end of the line, then give up now;
5458 ;; trying again will not help.
5459 (if (>= (current-column) prev-column)
5460 (setq give-up t))))))
5461 ;; Justify last line.
5462 (justify-current-line justify t t)
5463 t)))
5465 (defvar comment-line-break-function 'comment-indent-new-line
5466 "Mode-specific function which line breaks and continues a comment.
5467 This function is called during auto-filling when a comment syntax
5468 is defined.
5469 The function should take a single optional argument, which is a flag
5470 indicating whether it should use soft newlines.")
5472 (defun default-indent-new-line (&optional soft)
5473 "Break line at point and indent.
5474 If a comment syntax is defined, call `comment-indent-new-line'.
5476 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5477 unless optional argument SOFT is non-nil."
5478 (interactive)
5479 (if comment-start
5480 (funcall comment-line-break-function soft)
5481 ;; Insert the newline before removing empty space so that markers
5482 ;; get preserved better.
5484 (save-excursion (forward-char -1) (delete-horizontal-space))
5485 (delete-horizontal-space)
5487 (if (and fill-prefix (not adaptive-fill-mode))
5488 ;; Blindly trust a non-adaptive fill-prefix.
5489 (progn
5490 (indent-to-left-margin)
5491 (insert-before-markers-and-inherit fill-prefix))
5493 (cond
5494 ;; If there's an adaptive prefix, use it unless we're inside
5495 ;; a comment and the prefix is not a comment starter.
5496 (fill-prefix
5497 (indent-to-left-margin)
5498 (insert-and-inherit fill-prefix))
5499 ;; If we're not inside a comment, just try to indent.
5500 (t (indent-according-to-mode))))))
5502 (defvar normal-auto-fill-function 'do-auto-fill
5503 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5504 Some major modes set this.")
5506 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5507 ;; `functions' and `hooks' are usually unsafe to set, but setting
5508 ;; auto-fill-function to nil in a file-local setting is safe and
5509 ;; can be useful to prevent auto-filling.
5510 (put 'auto-fill-function 'safe-local-variable 'null)
5512 (define-minor-mode auto-fill-mode
5513 "Toggle automatic line breaking (Auto Fill mode).
5514 With a prefix argument ARG, enable Auto Fill mode if ARG is
5515 positive, and disable it otherwise. If called from Lisp, enable
5516 the mode if ARG is omitted or nil.
5518 When Auto Fill mode is enabled, inserting a space at a column
5519 beyond `current-fill-column' automatically breaks the line at a
5520 previous space.
5522 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5523 non-`nil'.
5525 The value of `normal-auto-fill-function' specifies the function to use
5526 for `auto-fill-function' when turning Auto Fill mode on."
5527 :variable (auto-fill-function
5528 . (lambda (v) (setq auto-fill-function
5529 (if v normal-auto-fill-function)))))
5531 ;; This holds a document string used to document auto-fill-mode.
5532 (defun auto-fill-function ()
5533 "Automatically break line at a previous space, in insertion of text."
5534 nil)
5536 (defun turn-on-auto-fill ()
5537 "Unconditionally turn on Auto Fill mode."
5538 (auto-fill-mode 1))
5540 (defun turn-off-auto-fill ()
5541 "Unconditionally turn off Auto Fill mode."
5542 (auto-fill-mode -1))
5544 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5546 (defun set-fill-column (arg)
5547 "Set `fill-column' to specified argument.
5550 (interactive
5551 (list (or current-prefix-arg
5552 ;; We used to use current-column silently, but C-x f is too easily
5553 ;; typed as a typo for C-x C-f, so we turned it into an error and
5554 ;; now an interactive prompt.
5555 (read-number "Set fill-column to: " (current-column)))))
5556 (if (consp arg)
5557 (setq arg (current-column)))
5558 (if (not (integerp arg))
5559 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5560 (error "set-fill-column requires an explicit argument")
5561 (message "Fill column set to %d (was %d)" arg fill-column)
5562 (setq fill-column arg)))
5563 \f
5564 (defun set-selective-display (arg)
5565 "Set `selective-display' to ARG; clear it if no arg.
5566 When the value of `selective-display' is a number > 0,
5567 lines whose indentation is >= that value are not displayed.
5568 The variable `selective-display' has a separate value for each buffer."
5569 (interactive "P")
5570 (if (eq selective-display t)
5571 (error "selective-display already in use for marked lines"))
5572 (let ((current-vpos
5573 (save-restriction
5574 (narrow-to-region (point-min) (point))
5575 (goto-char (window-start))
5576 (vertical-motion (window-height)))))
5577 (setq selective-display
5578 (and arg (prefix-numeric-value arg)))
5579 (recenter current-vpos))
5580 (set-window-start (selected-window) (window-start (selected-window)))
5581 (princ "selective-display set to " t)
5582 (prin1 selective-display t)
5583 (princ "." t))
5585 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5587 (defun toggle-truncate-lines (&optional arg)
5588 "Toggle truncating of long lines for the current buffer.
5589 When truncating is off, long lines are folded.
5590 With prefix argument ARG, truncate long lines if ARG is positive,
5591 otherwise fold them. Note that in side-by-side windows, this
5592 command has no effect if `truncate-partial-width-windows' is
5593 non-nil."
5594 (interactive "P")
5595 (setq truncate-lines
5596 (if (null arg)
5597 (not truncate-lines)
5598 (> (prefix-numeric-value arg) 0)))
5599 (force-mode-line-update)
5600 (unless truncate-lines
5601 (let ((buffer (current-buffer)))
5602 (walk-windows (lambda (window)
5603 (if (eq buffer (window-buffer window))
5604 (set-window-hscroll window 0)))
5605 nil t)))
5606 (message "Truncate long lines %s"
5607 (if truncate-lines "enabled" "disabled")))
5609 (defun toggle-word-wrap (&optional arg)
5610 "Toggle whether to use word-wrapping for continuation lines.
5611 With prefix argument ARG, wrap continuation lines at word boundaries
5612 if ARG is positive, otherwise wrap them at the right screen edge.
5613 This command toggles the value of `word-wrap'. It has no effect
5614 if long lines are truncated."
5615 (interactive "P")
5616 (setq word-wrap
5617 (if (null arg)
5618 (not word-wrap)
5619 (> (prefix-numeric-value arg) 0)))
5620 (force-mode-line-update)
5621 (message "Word wrapping %s"
5622 (if word-wrap "enabled" "disabled")))
5624 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5625 "The string displayed in the mode line when in overwrite mode.")
5626 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5627 "The string displayed in the mode line when in binary overwrite mode.")
5629 (define-minor-mode overwrite-mode
5630 "Toggle Overwrite mode.
5631 With a prefix argument ARG, enable Overwrite mode if ARG is
5632 positive, and disable it otherwise. If called from Lisp, enable
5633 the mode if ARG is omitted or nil.
5635 When Overwrite mode is enabled, printing characters typed in
5636 replace existing text on a one-for-one basis, rather than pushing
5637 it to the right. At the end of a line, such characters extend
5638 the line. Before a tab, such characters insert until the tab is
5640 overwrite mode; this is supposed to make it easier to insert
5641 characters when necessary."
5642 :variable (overwrite-mode
5643 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5645 (define-minor-mode binary-overwrite-mode
5646 "Toggle Binary Overwrite mode.
5647 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5648 is positive, and disable it otherwise. If called from Lisp,
5649 enable the mode if ARG is omitted or nil.
5651 When Binary Overwrite mode is enabled, printing characters typed
5652 in replace existing text. Newlines are not treated specially, so
5653 typing at the end of a line joins the line to the next, with the
5654 typed character between them. Typing before a tab character
5655 simply replaces the tab with the character typed.
5657 ordinary typing characters do.
5659 Note that Binary Overwrite mode is not its own minor mode; it is
5660 a specialization of overwrite mode, entered by setting the
5661 `overwrite-mode' variable to `overwrite-mode-binary'."
5662 :variable (overwrite-mode
5663 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5665 (define-minor-mode line-number-mode
5666 "Toggle line number display in the mode line (Line Number mode).
5667 With a prefix argument ARG, enable Line Number mode if ARG is
5668 positive, and disable it otherwise. If called from Lisp, enable
5669 the mode if ARG is omitted or nil.
5671 Line numbers do not appear for very large buffers and buffers
5672 with very long lines; see variables `line-number-display-limit'
5673 and `line-number-display-limit-width'."
5674 :init-value t :global t :group 'mode-line)
5676 (define-minor-mode column-number-mode
5677 "Toggle column number display in the mode line (Column Number mode).
5678 With a prefix argument ARG, enable Column Number mode if ARG is
5679 positive, and disable it otherwise.
5681 If called from Lisp, enable the mode if ARG is omitted or nil."
5682 :global t :group 'mode-line)
5684 (define-minor-mode size-indication-mode
5685 "Toggle buffer size display in the mode line (Size Indication mode).
5686 With a prefix argument ARG, enable Size Indication mode if ARG is
5687 positive, and disable it otherwise.
5689 If called from Lisp, enable the mode if ARG is omitted or nil."
5690 :global t :group 'mode-line)
5692 (define-minor-mode auto-save-mode
5693 "Toggle auto-saving in the current buffer (Auto Save mode).
5694 With a prefix argument ARG, enable Auto Save mode if ARG is
5695 positive, and disable it otherwise.
5697 If called from Lisp, enable the mode if ARG is omitted or nil."
5698 :variable ((and buffer-auto-save-file-name
5699 ;; If auto-save is off because buffer has shrunk,
5700 ;; then toggling should turn it on.
5701 (>= buffer-saved-size 0))
5702 . (lambda (val)
5703 (setq buffer-auto-save-file-name
5704 (cond
5705 ((null val) nil)
5706 ((and buffer-file-name auto-save-visited-file-name
5707 (not buffer-read-only))
5708 buffer-file-name)
5709 (t (make-auto-save-file-name))))))
5710 ;; If -1 was stored here, to temporarily turn off saving,
5711 ;; turn it back on.
5712 (and (< buffer-saved-size 0)
5713 (setq buffer-saved-size 0)))
5714 \f
5715 (defgroup paren-blinking nil
5716 "Blinking matching of parens and expressions."
5717 :prefix "blink-matching-"
5718 :group 'paren-matching)
5720 (defcustom blink-matching-paren t
5721 "Non-nil means show matching open-paren when close-paren is inserted."
5722 :type 'boolean
5723 :group 'paren-blinking)
5725 (defcustom blink-matching-paren-on-screen t
5726 "Non-nil means show matching open-paren when it is on screen.
5727 If nil, don't show it (but the open-paren can still be shown
5728 when it is off screen).
5730 This variable has no effect if `blink-matching-paren' is nil.
5731 \(In that case, the open-paren is never shown.)
5732 It is also ignored if `show-paren-mode' is enabled."
5733 :type 'boolean
5734 :group 'paren-blinking)
5736 (defcustom blink-matching-paren-distance (* 100 1024)
5737 "If non-nil, maximum distance to search backwards for matching open-paren.
5738 If nil, search stops at the beginning of the accessible portion of the buffer."
5739 :version "23.2" ; 25->100k
5740 :type '(choice (const nil) integer)
5741 :group 'paren-blinking)
5743 (defcustom blink-matching-delay 1
5744 "Time in seconds to delay after showing a matching paren."
5745 :type 'number
5746 :group 'paren-blinking)
5748 (defcustom blink-matching-paren-dont-ignore-comments nil
5749 "If nil, `blink-matching-paren' ignores comments.
5750 More precisely, when looking for the matching parenthesis,
5751 it skips the contents of comments that end before point."
5752 :type 'boolean
5753 :group 'paren-blinking)
5755 (defun blink-matching-check-mismatch (start end)
5756 "Return whether or not START...END are matching parens.
5757 END is the current point and START is the blink position.
5758 START might be nil if no matching starter was found.
5759 Returns non-nil if we find there is a mismatch."
5760 (let* ((end-syntax (syntax-after (1- end)))
5761 (matching-paren (and (consp end-syntax)
5762 (eq (syntax-class end-syntax) 5)
5763 (cdr end-syntax))))
5764 ;; For self-matched chars like " and $, we can't know when they're
5765 ;; mismatched or unmatched, so we can only do it for parens.
5766 (when matching-paren
5767 (not (and start
5768 (or
5769 (eq (char-after start) matching-paren)
5770 ;; The cdr might hold a new paren-class info rather than
5771 ;; a matching-char info, in which case the two CDRs
5772 ;; should match.
5773 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5775 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5776 "Function to check parentheses mismatches.
5777 The function takes two arguments (START and END) where START is the
5778 position just before the opening token and END is the position right after.
5779 START can be nil, if it was not found.
5780 The function should return non-nil if the two tokens do not match.")
5782 (defun blink-matching-open ()
5783 "Move cursor momentarily to the beginning of the sexp before point."
5784 (interactive)
5785 (when (and (not (bobp))
5786 blink-matching-paren)
5787 (let* ((oldpos (point))
5788 (message-log-max nil) ; Don't log messages about paren matching.
5789 (blinkpos
5790 (save-excursion
5791 (save-restriction
5792 (if blink-matching-paren-distance
5793 (narrow-to-region
5794 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5795 (- (point) blink-matching-paren-distance))
5796 oldpos))
5797 (let ((parse-sexp-ignore-comments
5798 (and parse-sexp-ignore-comments
5799 (not blink-matching-paren-dont-ignore-comments))))
5800 (condition-case ()
5801 (progn
5802 (forward-sexp -1)
5803 ;; backward-sexp skips backward over prefix chars,
5804 ;; so move back to the matching paren.
5805 (while (and (< (point) (1- oldpos))
5806 (let ((code (syntax-after (point))))
5807 (or (eq (syntax-class code) 6)
5808 (eq (logand 1048576 (car code))
5809 1048576))))
5810 (forward-char 1))
5811 (point))
5812 (error nil))))))
5813 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5814 (cond
5815 (mismatch
5816 (if blinkpos
5817 (if (minibufferp)
5818 (minibuffer-message "Mismatched parentheses")
5819 (message "Mismatched parentheses"))
5820 (if (minibufferp)
5821 (minibuffer-message "No matching parenthesis found")
5822 (message "No matching parenthesis found"))))
5823 ((not blinkpos) nil)
5824 ((pos-visible-in-window-p blinkpos)
5825 ;; Matching open within window, temporarily move to blinkpos but only
5826 ;; if `blink-matching-paren-on-screen' is non-nil.
5827 (and blink-matching-paren-on-screen
5828 (not show-paren-mode)
5829 (save-excursion
5830 (goto-char blinkpos)
5831 (sit-for blink-matching-delay))))
5832 (t
5833 (save-excursion
5834 (goto-char blinkpos)
5835 (let ((open-paren-line-string
5836 ;; Show what precedes the open in its line, if anything.
5837 (cond
5839 (buffer-substring (line-beginning-position)
5840 (1+ blinkpos)))
5841 ;; Show what follows the open in its line, if anything.
5842 ((save-excursion
5843 (forward-char 1)
5845 (not (eolp)))
5846 (buffer-substring blinkpos
5847 (line-end-position)))
5848 ;; Otherwise show the previous nonblank line,
5849 ;; if there is one.
5851 (concat
5852 (buffer-substring (progn
5854 (line-beginning-position))
5855 (progn (end-of-line)
5857 (point)))
5858 ;; Replace the newline and other whitespace with `...'.
5859 "..."
5860 (buffer-substring blinkpos (1+ blinkpos))))
5861 ;; There is nothing to show except the char itself.
5862 (t (buffer-substring blinkpos (1+ blinkpos))))))
5863 (message "Matches %s"
5864 (substring-no-properties open-paren-line-string)))))))))
5866 (defvar blink-paren-function 'blink-matching-open
5867 "Function called, if non-nil, whenever a close parenthesis is inserted.
5868 More precisely, a char with closeparen syntax is self-inserted.")
5870 (defun blink-paren-post-self-insert-function ()
5871 (when (and (eq (char-before) last-command-event) ; Sanity check.
5872 (memq (char-syntax last-command-event) '(?\) ?\$))
5873 blink-paren-function
5874 (not executing-kbd-macro)
5875 (not noninteractive)
5876 ;; Verify an even number of quoting characters precede the close.
5877 (= 1 (logand 1 (- (point)
5878 (save-excursion
5879 (forward-char -1)
5881 (point))))))
5882 (funcall blink-paren-function)))
5884 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5885 ;; Most likely, this hook is nil, so this arg doesn't matter,
5886 ;; but I use it as a reminder that this function usually
5887 ;; likes to be run after others since it does `sit-for'.
5888 'append)
5889 \f
5890 ;; This executes C-g typed while Emacs is waiting for a command.
5891 ;; Quitting out of a program does not go through here;
5892 ;; that happens in the QUIT macro at the C code level.
5893 (defun keyboard-quit ()
5894 "Signal a `quit' condition.
5895 During execution of Lisp code, this character causes a quit directly.
5896 At top-level, as an editor command, this simply beeps."
5897 (interactive)
5898 ;; Avoid adding the region to the window selection.
5899 (setq saved-region-selection nil)
5900 (let (select-active-regions)
5901 (deactivate-mark))
5902 (if (fboundp 'kmacro-keyboard-quit)
5903 (kmacro-keyboard-quit))
5904 (setq defining-kbd-macro nil)
5905 (let ((debug-on-quit nil))
5906 (signal 'quit nil)))
5908 (defvar buffer-quit-function nil
5911 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5913 (defun keyboard-escape-quit ()
5915 This command can exit an interactive command such as `query-replace',
5916 can clear out a prefix argument or a region,
5917 can get out of the minibuffer or other recursive edit,
5918 cancel the use of the current buffer (for special-purpose buffers),
5919 or go back to just one window (by deleting all but the selected window)."
5920 (interactive)
5921 (cond ((eq last-command 'mode-exited) nil)
5922 ((region-active-p)
5923 (deactivate-mark))
5924 ((> (minibuffer-depth) 0)
5925 (abort-recursive-edit))
5926 (current-prefix-arg
5927 nil)
5928 ((> (recursion-depth) 0)
5929 (exit-recursive-edit))
5930 (buffer-quit-function
5931 (funcall buffer-quit-function))
5932 ((not (one-window-p t))
5933 (delete-other-windows))
5935 (bury-buffer))))
5937 (defun play-sound-file (file &optional volume device)
5938 "Play sound stored in FILE.
5939 VOLUME and DEVICE correspond to the keywords of the sound
5940 specification for `play-sound'."
5941 (interactive "fPlay sound file: ")
5942 (let ((sound (list :file file)))
5943 (if volume
5944 (plist-put sound :volume volume))
5945 (if device
5946 (plist-put sound :device device))
5947 (push 'sound sound)
5948 (play-sound sound)))
5950 \f
5951 (defcustom read-mail-command 'rmail
5952 "Your preference for a mail reading package.
5953 This is used by some keybindings which support reading mail.
5954 See also `mail-user-agent' concerning sending mail."
5957 (function-item :tag "Emacs interface to MH"
5959 (function :tag "Other"))
5960 :version "21.1"
5961 :group 'mail)
5963 (defcustom mail-user-agent 'message-user-agent
5964 "Your preference for a mail composition package.
5965 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5966 outgoing email message. This variable lets you specify which
5967 mail-sending package you prefer.
5969 Valid values include:
5971 `message-user-agent' -- use the Message package.
5972 See Info node `(message)'.
5973 `sendmail-user-agent' -- use the Mail package.
5974 See Info node `(emacs)Sending Mail'.
5975 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5976 See Info node `(mh-e)'.
5977 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5978 paraphernalia if Gnus is running, particularly
5979 the Gcc: header for archiving.
5981 Additional valid symbols may be available; check with the author of
5982 your package for details. The function should return non-nil if it
5983 succeeds.
5985 See also `read-mail-command' concerning reading mail."
5986 :type '(radio (function-item :tag "Message package"
5988 message-user-agent)
5989 (function-item :tag "Mail package"
5991 sendmail-user-agent)
5992 (function-item :tag "Emacs interface to MH"
5994 mh-e-user-agent)
5995 (function-item :tag "Message with full Gnus features"
5997 gnus-user-agent)
5998 (function :tag "Other"))
5999 :version "23.2" ; sendmail->message
6000 :group 'mail)
6002 (defcustom compose-mail-user-agent-warnings t
6003 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6004 If the value of `mail-user-agent' is the default, and the user
6005 appears to have customizations applying to the old default,
6006 `compose-mail' issues a warning."
6007 :type 'boolean
6008 :version "23.2"
6009 :group 'mail)
6011 (defun rfc822-goto-eoh ()
6012 "If the buffer starts with a mail header, move point to the header's end.
6013 Otherwise, moves to `point-min'.
6014 The end of the header is the start of the next line, if there is one,
6015 else the end of the last line. This function obeys RFC822."
6016 (goto-char (point-min))
6017 (when (re-search-forward
6019 (goto-char (match-beginning 0))))
6021 ;; Used by Rmail (e.g., rmail-forward).
6022 (defvar mail-encode-mml nil
6023 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6024 the outgoing message before sending it.")
6026 (defun compose-mail (&optional to subject other-headers continue
6027 switch-function yank-action send-actions
6028 return-action)
6029 "Start composing a mail message to send.
6030 This uses the user's chosen mail composition package
6031 as selected with the variable `mail-user-agent'.
6032 The optional arguments TO and SUBJECT specify recipients
6033 and the initial Subject field, respectively.
6035 OTHER-HEADERS is an alist specifying additional
6036 header fields. Elements look like (HEADER . VALUE) where both
6037 HEADER and VALUE are strings.
6039 CONTINUE, if non-nil, says to continue editing a message already
6040 being composed. Interactively, CONTINUE is the prefix argument.
6042 SWITCH-FUNCTION, if non-nil, is a function to use to
6043 switch to and display the buffer used for mail composition.
6045 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6046 to insert the raw text of the message being replied to.
6047 It has the form (FUNCTION . ARGS). The user agent will apply
6048 FUNCTION to ARGS, to insert the raw text of the original message.
6049 \(The user agent will also run `mail-citation-hook', *after* the
6050 original text has been inserted in this way.)
6052 SEND-ACTIONS is a list of actions to call when the message is sent.
6053 Each action has the form (FUNCTION . ARGS).
6055 RETURN-ACTION, if non-nil, is an action for returning to the
6056 caller. It has the form (FUNCTION . ARGS). The function is
6057 called after the mail has been sent or put aside, and the mail
6058 buffer buried."
6059 (interactive
6060 (list nil nil nil current-prefix-arg))
6062 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6063 ;; from sendmail-user-agent to message-user-agent. Some users may
6064 ;; encounter incompatibilities. This hack tries to detect problems
6065 ;; and warn about them.
6066 (and compose-mail-user-agent-warnings
6067 (eq mail-user-agent 'message-user-agent)
6068 (let (warn-vars)
6069 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6070 mail-yank-hooks mail-archive-file-name
6071 mail-default-reply-to mail-mailing-lists
6072 mail-self-blind))
6073 (and (boundp var)
6074 (symbol-value var)
6075 (push var warn-vars)))
6076 (when warn-vars
6077 (display-warning 'mail
6078 (format "\
6079 The default mail mode is now Message mode.
6080 You have the following Mail mode variable%s customized:
6082 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6083 (if (> (length warn-vars) 1) "s" "")
6084 (mapconcat 'symbol-name
6085 warn-vars " "))))))
6087 (let ((function (get mail-user-agent 'composefunc)))
6088 (funcall function to subject other-headers continue switch-function
6089 yank-action send-actions return-action)))
6091 (defun compose-mail-other-window (&optional to subject other-headers continue
6092 yank-action send-actions
6093 return-action)
6095 (interactive (list nil nil nil current-prefix-arg))
6096 (compose-mail to subject other-headers continue
6097 'switch-to-buffer-other-window yank-action send-actions
6098 return-action))
6100 (defun compose-mail-other-frame (&optional to subject other-headers continue
6101 yank-action send-actions
6102 return-action)
6104 (interactive (list nil nil nil current-prefix-arg))
6105 (compose-mail to subject other-headers continue
6106 'switch-to-buffer-other-frame yank-action send-actions
6107 return-action))
6109 \f
6110 (defvar set-variable-value-history nil
6111 "History of values entered with `set-variable'.
6113 Maximum length of the history list is determined by the value
6114 of `history-length', which see.")
6116 (defun set-variable (variable value &optional make-local)
6117 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6118 VARIABLE should be a user option variable name, a Lisp variable
6119 meant to be customized by users. You should enter VALUE in Lisp syntax,
6120 so if you want VALUE to be a string, you must surround it with doublequotes.
6121 VALUE is used literally, not evaluated.
6123 If VARIABLE has a `variable-interactive' property, that is used as if
6124 it were the arg to `interactive' (which see) to interactively read VALUE.
6126 If VARIABLE has been defined with `defcustom', then the type information
6127 in the definition is used to check that VALUE is valid.
6129 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6130 (interactive
6131 (let* ((default-var (variable-at-point))
6132 (var (if (custom-variable-p default-var)
6133 (read-variable (format "Set variable (default %s): " default-var)
6134 default-var)
6135 (read-variable "Set variable: ")))
6136 (minibuffer-help-form '(describe-variable var))
6137 (prop (get var 'variable-interactive))
6138 (obsolete (car (get var 'byte-obsolete-variable)))
6139 (prompt (format "Set %s %s to value: " var
6140 (cond ((local-variable-p var)
6141 "(buffer-local)")
6142 ((or current-prefix-arg
6143 (local-variable-if-set-p var))
6144 "buffer-locally")
6145 (t "globally"))))
6146 (val (progn
6147 (when obsolete
6148 (message (concat "`%S' is obsolete; "
6149 (if (symbolp obsolete) "use `%S' instead" "%s"))
6150 var obsolete)
6151 (sit-for 3))
6152 (if prop
6153 ;; Use VAR's `variable-interactive' property
6154 ;; as an interactive spec for prompting.
6155 (call-interactively `(lambda (arg)
6156 (interactive ,prop)
6157 arg))
6158 (read
6159 (read-string prompt nil
6160 'set-variable-value-history
6161 (format "%S" (symbol-value var))))))))
6162 (list var val current-prefix-arg)))
6164 (and (custom-variable-p variable)
6165 (not (get variable 'custom-type))
6166 (custom-load-symbol variable))
6167 (let ((type (get variable 'custom-type)))
6168 (when type
6169 ;; Match with custom type.
6170 (require 'cus-edit)
6171 (setq type (widget-convert type))
6172 (unless (widget-apply type :match value)
6173 (error "Value `%S' does not match type %S of %S"
6174 value (car type) variable))))
6176 (if make-local
6177 (make-local-variable variable))
6179 (set variable value)
6181 ;; Force a thorough redisplay for the case that the variable
6182 ;; has an effect on the display, like `tab-width' has.
6183 (force-mode-line-update))
6184 \f
6185 ;; Define the major mode for lists of completions.
6187 (defvar completion-list-mode-map
6188 (let ((map (make-sparse-keymap)))
6189 (define-key map [mouse-2] 'mouse-choose-completion)
6190 (define-key map [follow-link] 'mouse-face)
6191 (define-key map [down-mouse-2] nil)
6192 (define-key map "\C-m" 'choose-completion)
6193 (define-key map "\e\e\e" 'delete-completion-window)
6194 (define-key map [left] 'previous-completion)
6195 (define-key map [right] 'next-completion)
6196 (define-key map "q" 'quit-window)
6197 (define-key map "z" 'kill-this-buffer)
6198 map)
6199 "Local map for completion list buffers.")
6201 ;; Completion mode is suitable only for specially formatted data.
6202 (put 'completion-list-mode 'mode-class 'special)
6204 (defvar completion-reference-buffer nil
6205 "Record the buffer that was current when the completion list was requested.
6206 This is a local variable in the completion list buffer.
6207 Initial value is nil to avoid some compiler warnings.")
6209 (defvar completion-no-auto-exit nil
6210 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6211 This also applies to other functions such as `choose-completion'.")
6213 (defvar completion-base-position nil
6214 "Position of the base of the text corresponding to the shown completions.
6215 This variable is used in the *Completions* buffers.
6216 Its value is a list of the form (START END) where START is the place
6217 where the completion should be inserted and END (if non-nil) is the end
6218 of the text to replace. If END is nil, point is used instead.")
6220 (defvar completion-list-insert-choice-function #'completion--replace
6221 "Function to use to insert the text chosen in *Completions*.
6222 Called with three arguments (BEG END TEXT), it should replace the text
6223 between BEG and END with TEXT. Expected to be set buffer-locally
6224 in the *Completions* buffer.")
6226 (defvar completion-base-size nil
6227 "Number of chars before point not involved in completion.
6228 This is a local variable in the completion list buffer.
6229 It refers to the chars in the minibuffer if completing in the
6230 minibuffer, or in `completion-reference-buffer' otherwise.
6231 Only characters in the field at point are included.
6233 If nil, Emacs determines which part of the tail end of the
6234 buffer's text is involved in completion by comparing the text
6235 directly.")
6236 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6238 (defun delete-completion-window ()
6239 "Delete the completion list window.
6240 Go to the window from which completion was requested."
6241 (interactive)
6242 (let ((buf completion-reference-buffer))
6243 (if (one-window-p t)
6244 (if (window-dedicated-p (selected-window))
6245 (delete-frame (selected-frame)))
6246 (delete-window (selected-window))
6247 (if (get-buffer-window buf)
6248 (select-window (get-buffer-window buf))))))
6250 (defun previous-completion (n)
6251 "Move to the previous item in the completion list."
6252 (interactive "p")
6253 (next-completion (- n)))
6255 (defun next-completion (n)
6256 "Move to the next item in the completion list.
6257 With prefix argument N, move N items (negative N means move backward)."
6258 (interactive "p")
6259 (let ((beg (point-min)) (end (point-max)))
6260 (while (and (> n 0) (not (eobp)))
6261 ;; If in a completion, move to the end of it.
6262 (when (get-text-property (point) 'mouse-face)
6263 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6264 ;; Move to start of next one.
6265 (unless (get-text-property (point) 'mouse-face)
6266 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6267 (setq n (1- n)))
6268 (while (and (< n 0) (not (bobp)))
6269 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6270 ;; If in a completion, move to the start of it.
6271 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6272 (goto-char (previous-single-property-change
6273 (point) 'mouse-face nil beg)))
6274 ;; Move to end of the previous completion.
6275 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6276 (goto-char (previous-single-property-change
6277 (point) 'mouse-face nil beg)))
6278 ;; Move to the start of that one.
6279 (goto-char (previous-single-property-change
6280 (point) 'mouse-face nil beg))
6281 (setq n (1+ n))))))
6283 (defun choose-completion (&optional event)
6284 "Choose the completion at point."
6285 (interactive (list last-nonmenu-event))
6286 ;; In case this is run via the mouse, give temporary modes such as
6287 ;; isearch a chance to turn off.
6288 (run-hooks 'mouse-leave-buffer-hook)
6289 (with-current-buffer (window-buffer (posn-window (event-start event)))
6290 (let ((buffer completion-reference-buffer)
6291 (base-size completion-base-size)
6292 (base-position completion-base-position)
6293 (insert-function completion-list-insert-choice-function)
6294 (choice
6295 (save-excursion
6296 (goto-char (posn-point (event-start event)))
6297 (let (beg end)
6298 (cond
6299 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6300 (setq end (point) beg (1+ (point))))
6301 ((and (not (bobp))
6302 (get-text-property (1- (point)) 'mouse-face))
6303 (setq end (1- (point)) beg (point)))
6304 (t (error "No completion here")))
6305 (setq beg (previous-single-property-change beg 'mouse-face))
6306 (setq end (or (next-single-property-change end 'mouse-face)
6307 (point-max)))
6308 (buffer-substring-no-properties beg end)))))
6310 (unless (buffer-live-p buffer)
6311 (error "Destination buffer is dead"))
6312 (quit-window nil (posn-window (event-start event)))
6314 (with-current-buffer buffer
6315 (choose-completion-string
6316 choice buffer
6317 (or base-position
6318 (when base-size
6319 ;; Someone's using old completion code that doesn't know
6320 ;; about base-position yet.
6321 (list (+ base-size (field-beginning))))
6322 ;; If all else fails, just guess.
6323 (list (choose-completion-guess-base-position choice)))
6324 insert-function)))))
6326 ;; Delete the longest partial match for STRING
6327 ;; that can be found before POINT.
6328 (defun choose-completion-guess-base-position (string)
6329 (save-excursion
6330 (let ((opoint (point))
6331 len)
6332 ;; Try moving back by the length of the string.
6333 (goto-char (max (- (point) (length string))
6334 (minibuffer-prompt-end)))
6335 ;; See how far back we were actually able to move. That is the
6336 ;; upper bound on how much we can match and delete.
6337 (setq len (- opoint (point)))
6338 (if completion-ignore-case
6339 (setq string (downcase string)))
6340 (while (and (> len 0)
6341 (let ((tail (buffer-substring (point) opoint)))
6342 (if completion-ignore-case
6343 (setq tail (downcase tail)))
6344 (not (string= tail (substring string 0 len)))))
6345 (setq len (1- len))
6346 (forward-char 1))
6347 (point))))
6349 (defun choose-completion-delete-max-match (string)
6350 (delete-region (choose-completion-guess-base-position string) (point)))
6351 (make-obsolete 'choose-completion-delete-max-match
6352 'choose-completion-guess-base-position "23.2")
6354 (defvar choose-completion-string-functions nil
6355 "Functions that may override the normal insertion of a completion choice.
6356 These functions are called in order with four arguments:
6357 CHOICE - the string to insert in the buffer,
6358 BUFFER - the buffer in which the choice should be inserted,
6359 MINI-P - non-nil if BUFFER is a minibuffer, and
6360 BASE-SIZE - the number of characters in BUFFER before
6361 the string being completed.
6363 If a function in the list returns non-nil, that function is supposed
6364 to have inserted the CHOICE in the BUFFER, and possibly exited
6365 the minibuffer; no further functions will be called.
6367 If all functions in the list return nil, that means to use
6368 the default method of inserting the completion in BUFFER.")
6370 (defun choose-completion-string (choice &optional
6371 buffer base-position insert-function)
6372 "Switch to BUFFER and insert the completion choice CHOICE.
6373 BASE-POSITION, says where to insert the completion."
6375 ;; If BUFFER is the minibuffer, exit the minibuffer
6376 ;; unless it is reading a file name and CHOICE is a directory,
6377 ;; or completion-no-auto-exit is non-nil.
6379 ;; Some older code may call us passing `base-size' instead of
6380 ;; `base-position'. It's difficult to make any use of `base-size',
6381 ;; so we just ignore it.
6382 (unless (consp base-position)
6383 (message "Obsolete `base-size' passed to choose-completion-string")
6384 (setq base-position nil))
6386 (let* ((buffer (or buffer completion-reference-buffer))
6387 (mini-p (minibufferp buffer)))
6388 ;; If BUFFER is a minibuffer, barf unless it's the currently
6389 ;; active minibuffer.
6390 (if (and mini-p
6391 (not (and (active-minibuffer-window)
6392 (equal buffer
6393 (window-buffer (active-minibuffer-window))))))
6394 (error "Minibuffer is not active for completion")
6395 ;; Set buffer so buffer-local choose-completion-string-functions works.
6396 (set-buffer buffer)
6397 (unless (run-hook-with-args-until-success
6398 'choose-completion-string-functions
6399 ;; The fourth arg used to be `mini-p' but was useless
6400 ;; (since minibufferp can be used on the `buffer' arg)
6401 ;; and indeed unused. The last used to be `base-size', so we
6402 ;; keep it to try and avoid breaking old code.
6403 choice buffer base-position nil)
6404 ;; This remove-text-properties should be unnecessary since `choice'
6405 ;; comes from buffer-substring-no-properties.
6406 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6407 ;; Insert the completion into the buffer where it was requested.
6408 (funcall (or insert-function completion-list-insert-choice-function)
6409 (or (car base-position) (point))
6410 (or (cadr base-position) (point))
6411 choice)
6412 ;; Update point in the window that BUFFER is showing in.
6413 (let ((window (get-buffer-window buffer t)))
6414 (set-window-point window (point)))
6415 ;; If completing for the minibuffer, exit it with this choice.
6416 (and (not completion-no-auto-exit)
6417 (minibufferp buffer)
6418 minibuffer-completion-table
6419 ;; If this is reading a file name, and the file name chosen
6420 ;; is a directory, don't exit the minibuffer.
6421 (let* ((result (buffer-substring (field-beginning) (point)))
6422 (bounds
6423 (completion-boundaries result minibuffer-completion-table
6424 minibuffer-completion-predicate
6425 "")))
6426 (if (eq (car bounds) (length result))
6427 ;; The completion chosen leads to a new set of completions
6428 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6429 (let ((mini (active-minibuffer-window)))
6430 (select-window mini)
6431 (when minibuffer-auto-raise
6432 (raise-frame (window-frame mini))))
6433 (exit-minibuffer))))))))
6435 (define-derived-mode completion-list-mode nil "Completion List"
6436 "Major mode for buffers showing lists of possible completions.
6438 to select the completion near point.
6440 with the mouse.
6443 (set (make-local-variable 'completion-base-size) nil))
6445 (defun completion-list-mode-finish ()
6446 "Finish setup of the completions buffer.
6447 Called from `temp-buffer-show-hook'."
6448 (when (eq major-mode 'completion-list-mode)
6449 (setq buffer-read-only t)))
6451 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6454 ;; Variables and faces used in `completion-setup-function'.
6456 (defcustom completion-show-help t
6457 "Non-nil means show help message in *Completions* buffer."
6458 :type 'boolean
6459 :version "22.1"
6460 :group 'completion)
6462 ;; This function goes in completion-setup-hook, so that it is called
6463 ;; after the text of the completion list buffer is written.
6464 (defun completion-setup-function ()
6465 (let* ((mainbuf (current-buffer))
6466 (base-dir
6467 ;; When reading a file name in the minibuffer,
6468 ;; try and find the right default-directory to set in the
6469 ;; completion list buffer.
6470 ;; FIXME: Why do we do that, actually? --Stef
6471 (if minibuffer-completing-file-name
6472 (file-name-as-directory
6473 (expand-file-name
6474 (substring (minibuffer-completion-contents)
6475 0 (or completion-base-size 0)))))))
6476 (with-current-buffer standard-output
6477 (let ((base-size completion-base-size) ;Read before killing localvars.
6478 (base-position completion-base-position)
6479 (insert-fun completion-list-insert-choice-function))
6480 (completion-list-mode)
6481 (set (make-local-variable 'completion-base-size) base-size)
6482 (set (make-local-variable 'completion-base-position) base-position)
6483 (set (make-local-variable 'completion-list-insert-choice-function)
6484 insert-fun))
6485 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6486 (if base-dir (setq default-directory base-dir))
6487 ;; Maybe insert help string.
6488 (when completion-show-help
6489 (goto-char (point-min))
6490 (if (display-mouse-p)
6491 (insert (substitute-command-keys
6493 (insert (substitute-command-keys
6497 (add-hook 'completion-setup-hook 'completion-setup-function)
6499 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6500 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6502 (defun switch-to-completions ()
6503 "Select the completion list window."
6504 (interactive)
6505 (let ((window (or (get-buffer-window "*Completions*" 0)
6506 ;; Make sure we have a completions window.
6507 (progn (minibuffer-completion-help)
6508 (get-buffer-window "*Completions*" 0)))))
6509 (when window
6510 (select-window window)
6511 ;; In the new buffer, go to the first completion.
6512 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6513 (when (bobp)
6514 (next-completion 1)))))
6515 \f
6516 ;;; Support keyboard commands to turn on various modifiers.
6518 ;; These functions -- which are not commands -- each add one modifier
6519 ;; to the following event.
6521 (defun event-apply-alt-modifier (_ignore-prompt)
6524 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6525 (defun event-apply-super-modifier (_ignore-prompt)
6528 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6529 (defun event-apply-hyper-modifier (_ignore-prompt)
6532 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6533 (defun event-apply-shift-modifier (_ignore-prompt)
6536 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6537 (defun event-apply-control-modifier (_ignore-prompt)
6540 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6541 (defun event-apply-meta-modifier (_ignore-prompt)
6544 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6546 (defun event-apply-modifier (event symbol lshiftby prefix)
6547 "Apply a modifier flag to event EVENT.
6548 SYMBOL is the name of this modifier, as a symbol.
6549 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6550 PREFIX is the string that represents this modifier in an event type symbol."
6551 (if (numberp event)
6552 (cond ((eq symbol 'control)
6553 (if (and (<= (downcase event) ?z)
6554 (>= (downcase event) ?a))
6555 (- (downcase event) ?a -1)
6556 (if (and (<= (downcase event) ?Z)
6557 (>= (downcase event) ?A))
6558 (- (downcase event) ?A -1)
6559 (logior (lsh 1 lshiftby) event))))
6560 ((eq symbol 'shift)
6561 (if (and (<= (downcase event) ?z)
6562 (>= (downcase event) ?a))
6563 (upcase event)
6564 (logior (lsh 1 lshiftby) event)))
6565 (t
6566 (logior (lsh 1 lshiftby) event)))
6567 (if (memq symbol (event-modifiers event))
6568 event
6569 (let ((event-type (if (symbolp event) event (car event))))
6570 (setq event-type (intern (concat prefix (symbol-name event-type))))
6571 (if (symbolp event)
6572 event-type
6573 (cons event-type (cdr event)))))))
6575 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6576 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6577 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6578 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6579 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6580 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6581 \f
6582 ;;;; Keypad support.
6584 ;; Make the keypad keys act like ordinary typing keys. If people add
6585 ;; bindings for the function key symbols, then those bindings will
6586 ;; override these, so this shouldn't interfere with any existing
6587 ;; bindings.
6589 ;; Also tell read-char how to handle these keys.
6590 (mapc
6591 (lambda (keypad-normal)
6592 (let ((keypad (nth 0 keypad-normal))
6593 (normal (nth 1 keypad-normal)))
6594 (put keypad 'ascii-character normal)
6595 (define-key function-key-map (vector keypad) (vector normal))))
6596 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6597 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6598 (kp-space ?\s)
6601 (kp-multiply ?*)
6602 (kp-add ?+)
6603 (kp-separator ?,)
6604 (kp-subtract ?-)
6605 (kp-decimal ?.)
6606 (kp-divide ?/)
6607 (kp-equal ?=)
6608 ;; Do the same for various keys that are represented as symbols under
6609 ;; GUIs but naturally correspond to characters.
6610 (backspace 127)
6611 (delete 127)
6614 (clear ?\C-l)
6615 (return ?\C-m)
6616 (escape ?\e)
6617 ))
6618 \f
6619 ;;;;
6620 ;;;; forking a twin copy of a buffer.
6621 ;;;;
6623 (defvar clone-buffer-hook nil
6624 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6626 (defvar clone-indirect-buffer-hook nil
6627 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6629 (defun clone-process (process &optional newname)
6630 "Create a twin copy of PROCESS.
6631 If NEWNAME is nil, it defaults to PROCESS' name;
6632 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6633 If PROCESS is associated with a buffer, the new process will be associated
6634 with the current buffer instead.
6635 Returns nil if PROCESS has already terminated."
6636 (setq newname (or newname (process-name process)))
6638 (setq newname (substring newname 0 (match-beginning 0))))
6639 (when (memq (process-status process) '(run stop open))
6640 (let* ((process-connection-type (process-tty-name process))
6641 (new-process
6642 (if (memq (process-status process) '(open))
6643 (let ((args (process-contact process t)))
6644 (setq args (plist-put args :name newname))
6645 (setq args (plist-put args :buffer
6646 (if (process-buffer process)
6647 (current-buffer))))
6648 (apply 'make-network-process args))
6649 (apply 'start-process newname
6650 (if (process-buffer process) (current-buffer))
6651 (process-command process)))))
6652 (set-process-query-on-exit-flag
6653 new-process (process-query-on-exit-flag process))
6654 (set-process-inherit-coding-system-flag
6655 new-process (process-inherit-coding-system-flag process))
6656 (set-process-filter new-process (process-filter process))
6657 (set-process-sentinel new-process (process-sentinel process))
6658 (set-process-plist new-process (copy-sequence (process-plist process)))
6659 new-process)))
6661 ;; things to maybe add (currently partly covered by `funcall mode'):
6662 ;; - syntax-table
6663 ;; - overlays
6664 (defun clone-buffer (&optional newname display-flag)
6665 "Create and return a twin copy of the current buffer.
6666 Unlike an indirect buffer, the new buffer can be edited
6667 independently of the old one (if it is not read-only).
6668 NEWNAME is the name of the new buffer. It may be modified by
6669 adding or incrementing <N> at the end as necessary to create a
6670 unique buffer name. If nil, it defaults to the name of the
6671 current buffer, with the proper suffix. If DISPLAY-FLAG is
6672 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6673 clone a file-visiting buffer, or a buffer whose major mode symbol
6674 has a non-nil `no-clone' property, results in an error.
6676 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6677 current buffer with appropriate suffix. However, if a prefix
6678 argument is given, then the command prompts for NEWNAME in the
6679 minibuffer.
6681 This runs the normal hook `clone-buffer-hook' in the new buffer
6682 after it has been set up properly in other respects."
6683 (interactive
6684 (progn
6685 (if buffer-file-name
6686 (error "Cannot clone a file-visiting buffer"))
6687 (if (get major-mode 'no-clone)
6688 (error "Cannot clone a buffer in %s mode" mode-name))
6689 (list (if current-prefix-arg
6690 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6691 t)))
6692 (if buffer-file-name
6693 (error "Cannot clone a file-visiting buffer"))
6694 (if (get major-mode 'no-clone)
6695 (error "Cannot clone a buffer in %s mode" mode-name))
6696 (setq newname (or newname (buffer-name)))
6698 (setq newname (substring newname 0 (match-beginning 0))))
6699 (let ((buf (current-buffer))
6700 (ptmin (point-min))
6701 (ptmax (point-max))
6702 (pt (point))
6703 (mk (if mark-active (mark t)))
6704 (modified (buffer-modified-p))
6705 (mode major-mode)
6706 (lvars (buffer-local-variables))
6707 (process (get-buffer-process (current-buffer)))
6708 (new (generate-new-buffer (or newname (buffer-name)))))
6709 (save-restriction
6710 (widen)
6711 (with-current-buffer new
6712 (insert-buffer-substring buf)))
6713 (with-current-buffer new
6714 (narrow-to-region ptmin ptmax)
6715 (goto-char pt)
6716 (if mk (set-mark mk))
6717 (set-buffer-modified-p modified)
6719 ;; Clone the old buffer's process, if any.
6720 (when process (clone-process process))
6722 ;; Now set up the major mode.
6723 (funcall mode)
6725 ;; Set up other local variables.
6726 (mapc (lambda (v)
6727 (condition-case () ;in case var is read-only
6728 (if (symbolp v)
6729 (makunbound v)
6730 (set (make-local-variable (car v)) (cdr v)))
6731 (error nil)))
6732 lvars)
6734 ;; Run any hooks (typically set up by the major mode
6735 ;; for cloning to work properly).
6736 (run-hooks 'clone-buffer-hook))
6737 (if display-flag
6738 ;; Presumably the current buffer is shown in the selected frame, so
6739 ;; we want to display the clone elsewhere.
6740 (let ((same-window-regexps nil)
6741 (same-window-buffer-names))
6742 (pop-to-buffer new)))
6743 new))
6746 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6747 "Create an indirect buffer that is a twin copy of the current buffer.
6749 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6750 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6751 or if not called with a prefix arg, NEWNAME defaults to the current
6752 buffer's name. The name is modified by adding a `<N>' suffix to it
6753 or by incrementing the N in an existing suffix. Trying to clone a
6754 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6755 property results in an error.
6757 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6758 This is always done when called interactively.
6760 Optional third arg NORECORD non-nil means do not put this buffer at the
6761 front of the list of recently selected ones."
6762 (interactive
6763 (progn
6764 (if (get major-mode 'no-clone-indirect)
6765 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6766 (list (if current-prefix-arg
6767 (read-buffer "Name of indirect buffer: " (current-buffer)))
6768 t)))
6769 (if (get major-mode 'no-clone-indirect)
6770 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6771 (setq newname (or newname (buffer-name)))
6773 (setq newname (substring newname 0 (match-beginning 0))))
6774 (let* ((name (generate-new-buffer-name newname))
6775 (buffer (make-indirect-buffer (current-buffer) name t)))
6776 (with-current-buffer buffer
6777 (run-hooks 'clone-indirect-buffer-hook))
6778 (when display-flag
6779 (pop-to-buffer buffer norecord))
6780 buffer))
6783 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6784 "Like `clone-indirect-buffer' but display in another window."
6785 (interactive
6786 (progn
6787 (if (get major-mode 'no-clone-indirect)
6788 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6789 (list (if current-prefix-arg
6790 (read-buffer "Name of indirect buffer: " (current-buffer)))
6791 t)))
6792 (let ((pop-up-windows t))
6793 (clone-indirect-buffer newname display-flag norecord)))
6795 \f
6796 ;;; Handling of Backspace and Delete keys.
6798 (defcustom normal-erase-is-backspace 'maybe
6799 "Set the default behavior of the Delete and Backspace keys.
6801 If set to t, Delete key deletes forward and Backspace key deletes
6802 backward.
6804 If set to nil, both Delete and Backspace keys delete backward.
6806 If set to 'maybe (which is the default), Emacs automatically
6807 selects a behavior. On window systems, the behavior depends on
6808 the keyboard used. If the keyboard has both a Backspace key and
6809 a Delete key, and both are mapped to their usual meanings, the
6810 option's default value is set to t, so that Backspace can be used
6811 to delete backward, and Delete can be used to delete forward.
6813 If not running under a window system, customizing this option
6814 accomplishes a similar effect by mapping C-h, which is usually
6815 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6816 via `keyboard-translate'. The former functionality of C-h is
6817 available on the F1 key. You should probably not use this
6818 setting if you don't have both Backspace, Delete and F1 keys.
6820 Setting this variable with setq doesn't take effect. Programmatically,
6821 call `normal-erase-is-backspace-mode' (which see) instead."
6822 :type '(choice (const :tag "Off" nil)
6823 (const :tag "Maybe" maybe)
6824 (other :tag "On" t))
6825 :group 'editing-basics
6826 :version "21.1"
6827 :set (lambda (symbol value)
6828 ;; The fboundp is because of a problem with :set when
6829 ;; dumping Emacs. It doesn't really matter.
6830 (if (fboundp 'normal-erase-is-backspace-mode)
6831 (normal-erase-is-backspace-mode (or value 0))
6832 (set-default symbol value))))
6834 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6835 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6836 (unless frame (setq frame (selected-frame)))
6837 (with-selected-frame frame
6838 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6839 (normal-erase-is-backspace-mode
6840 (if (if (eq normal-erase-is-backspace 'maybe)
6841 (and (not noninteractive)
6842 (or (memq system-type '(ms-dos windows-nt))
6843 (memq window-system '(ns))
6844 (and (memq window-system '(x))
6845 (fboundp 'x-backspace-delete-keys-p)
6846 (x-backspace-delete-keys-p))
6847 ;; If the terminal Emacs is running on has erase char
6848 ;; set to ^H, use the Backspace key for deleting
6849 ;; backward, and the Delete key for deleting forward.
6850 (and (null window-system)
6851 (eq tty-erase-char ?\^H))))
6852 normal-erase-is-backspace)
6853 1 0)))))
6855 (define-minor-mode normal-erase-is-backspace-mode
6856 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6857 With a prefix argument ARG, enable this feature if ARG is
6858 positive, and disable it otherwise. If called from Lisp, enable
6859 the mode if ARG is omitted or nil.
6861 On window systems, when this mode is on, Delete is mapped to C-d
6862 and Backspace is mapped to DEL; when this mode is off, both
6863 Delete and Backspace are mapped to DEL. (The remapping goes via
6864 `local-function-key-map', so binding Delete or Backspace in the
6865 global or local keymap will override that.)
6867 In addition, on window systems, the bindings of C-Delete, M-Delete,
6868 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6869 the global keymap in accordance with the functionality of Delete and
6870 Backspace. For example, if Delete is remapped to C-d, which deletes
6871 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6872 to DEL, which deletes backward, C-Delete is bound to
6873 `backward-kill-word'.
6875 If not running on a window system, a similar effect is accomplished by
6876 remapping C-h (normally produced by the Backspace key) and DEL via
6877 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6878 to C-d; if it's off, the keys are not remapped.
6880 When not running on a window system, and this mode is turned on, the
6881 former functionality of C-h is available on the F1 key. You should
6882 probably not turn on this mode on a text-only terminal if you don't
6883 have both Backspace, Delete and F1 keys.
6885 See also `normal-erase-is-backspace'."
6886 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
6887 . (lambda (v)
6888 (setf (terminal-parameter nil 'normal-erase-is-backspace)
6889 (if v 1 0))))
6890 (let ((enabled (eq 1 (terminal-parameter
6891 nil 'normal-erase-is-backspace))))
6893 (cond ((or (memq window-system '(x w32 ns pc))
6894 (memq system-type '(ms-dos windows-nt)))
6895 (let ((bindings
6896 `(([M-delete] [M-backspace])
6897 ([C-M-delete] [C-M-backspace])
6898 ([?\e C-delete] [?\e C-backspace]))))
6900 (if enabled
6901 (progn
6902 (define-key local-function-key-map [delete] [deletechar])
6903 (define-key local-function-key-map [kp-delete] [?\C-d])
6904 (define-key local-function-key-map [backspace] [?\C-?])
6905 (dolist (b bindings)
6906 ;; Not sure if input-decode-map is really right, but
6907 ;; keyboard-translate-table (used below) only works
6908 ;; for integer events, and key-translation-table is
6909 ;; global (like the global-map, used earlier).
6910 (define-key input-decode-map (car b) nil)
6911 (define-key input-decode-map (cadr b) nil)))
6912 (define-key local-function-key-map [delete] [?\C-?])
6913 (define-key local-function-key-map [kp-delete] [?\C-?])
6914 (define-key local-function-key-map [backspace] [?\C-?])
6915 (dolist (b bindings)
6916 (define-key input-decode-map (car b) (cadr b))
6917 (define-key input-decode-map (cadr b) (car b))))))
6918 (t
6919 (if enabled
6920 (progn
6921 (keyboard-translate ?\C-h ?\C-?)
6922 (keyboard-translate ?\C-? ?\C-d))
6923 (keyboard-translate ?\C-h ?\C-h)
6924 (keyboard-translate ?\C-? ?\C-?))))
6926 (if (called-interactively-p 'interactive)
6927 (message "Delete key deletes %s"
6928 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6929 "forward" "backward")))))
6930 \f
6931 (defvar vis-mode-saved-buffer-invisibility-spec nil
6932 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6934 (define-minor-mode visible-mode
6935 "Toggle making all invisible text temporarily visible (Visible mode).
6936 With a prefix argument ARG, enable Visible mode if ARG is
6937 positive, and disable it otherwise. If called from Lisp, enable
6938 the mode if ARG is omitted or nil.
6940 This mode works by saving the value of `buffer-invisibility-spec'
6941 and setting it to nil."
6942 :lighter " Vis"
6943 :group 'editing-basics
6944 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6945 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6946 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6947 (when visible-mode
6948 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6949 buffer-invisibility-spec)
6950 (setq buffer-invisibility-spec nil)))
6951 \f
6952 ;; Minibuffer prompt stuff.
6954 ;;(defun minibuffer-prompt-modification (start end)
6955 ;; (error "You cannot modify the prompt"))
6956 ;;
6957 ;;
6958 ;;(defun minibuffer-prompt-insertion (start end)
6959 ;; (let ((inhibit-modification-hooks t))
6960 ;; (delete-region start end)
6961 ;; ;; Discard undo information for the text insertion itself
6962 ;; ;; and for the text deletion.above.
6963 ;; (when (consp buffer-undo-list)
6964 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6965 ;; (message "You cannot modify the prompt")))
6966 ;;
6967 ;;
6968 ;;(setq minibuffer-prompt-properties
6969 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6970 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6972 \f
6973 ;;;; Problematic external packages.
6975 ;; rms says this should be done by specifying symbols that define
6976 ;; versions together with bad values. This is therefore not as
6977 ;; flexible as it could be. See the thread:
6978 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6979 (defconst bad-packages-alist
6980 ;; Not sure exactly which semantic versions have problems.
6981 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6983 "The version of `semantic' loaded does not work in Emacs 22.
6984 It can cause constant high CPU load.
6985 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6986 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6987 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6988 ;; provided the `CUA-mode' feature. Since this is no longer true,
6989 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6990 (CUA-mode t nil
6991 "CUA-mode is now part of the standard GNU Emacs distribution,
6992 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6994 You have loaded an older version of CUA-mode which does not work
6995 correctly with this version of Emacs. You should remove the old
6996 version and use the one distributed with Emacs."))
6997 "Alist of packages known to cause problems in this version of Emacs.
6998 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6999 PACKAGE is either a regular expression to match file names, or a
7000 symbol (a feature name); see the documentation of
7001 `after-load-alist', to which this variable adds functions.
7002 SYMBOL is either the name of a string variable, or `t'. Upon
7003 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7004 warning using STRING as the message.")
7006 (defun bad-package-check (package)
7007 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7008 (condition-case nil
7009 (let* ((list (assoc package bad-packages-alist))
7010 (symbol (nth 1 list)))
7011 (and list
7012 (boundp symbol)
7013 (or (eq symbol t)
7014 (and (stringp (setq symbol (eval symbol)))
7015 (string-match-p (nth 2 list) symbol)))
7016 (display-warning package (nth 3 list) :warning)))
7017 (error nil)))
7019 (mapc (lambda (elem)
7020 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7021 bad-packages-alist)
7024 (provide 'simple)
7026 ;;; simple.el ends here