| blob | 37e0b48d31de71e3527dcfb09a1ff57297826aa4 |
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.
568 "Delete all the trailing whitespace across the current buffer.
569 All whitespace after the last non-whitespace character in a line is deleted.
571 A formfeed is not considered whitespace by this function.
572 If END is nil, also delete all trailing lines at the end of the buffer.
573 If the region is active, only delete whitespace within the region."
586 ;; Don't delete formfeeds, even if they are considered whitespace.
590 ;; Delete trailing empty lines.
593 ;; Really the end of buffer.
598 ;; Return nil for the benefit of `write-file-functions'.
599 nil)
602 "Insert a newline, then indent according to major mode.
603 Indentation is done using the value of `indent-line-function'.
604 In programming language modes, this is the same as TAB.
605 In some text modes, where TAB inserts a tab, this command indents to the
606 column specified by the function `current-left-margin'."
613 "Reindent current line, insert newline, then indent the new line.
614 Indentation of both lines is done according to the current major mode,
615 which means calling the current value of `indent-line-function'.
616 In programming language modes, this is the same as TAB.
617 In some text modes, where TAB inserts a tab, this indents to the
618 column specified by the function `current-left-margin'."
621 ;; Be careful to insert the newline before indenting the line.
622 ;; Otherwise, the indentation might be wrong.
626 ;; We are at EOL before the call to indent-according-to-mode, and
627 ;; after it we usually are as well, but not always. We tried to
628 ;; address it with `save-excursion' but that uses a normal marker
629 ;; whereas we need `move after insertion', so we do the save/restore
630 ;; by hand.
634 ;; Remove the trailing white-space after indentation because
635 ;; indentation may introduce the whitespace.
640 "Read next input character and insert it.
641 This is useful for inserting control characters.
642 With argument, insert ARG copies of the character.
644 If the first character you type after this command is an octal digit,
645 you should type a sequence of octal digits which specify a character code.
646 Any nondigit terminates the sequence. If the terminator is a RET,
647 it is discarded; any other terminator is used itself as input.
648 The variable `read-quoted-char-radix' specifies the radix for this feature;
649 set it to 10 or 16 to use decimal or hex instead of octal.
651 In overwrite mode, this function inserts the character anyway, and
652 does not handle octal digits specially. This means that if you use
653 overwrite as your normal editing mode, you can use this function to
654 insert characters when necessary.
656 In binary overwrite mode, this function does overwrite, and octal
657 digits are interpreted as a character code. This is intended to be
658 useful for editing binary files."
661 ;; Avoid "obsolete" warnings for translation-table-for-input.
668 ;; This used to assume character codes 0240 - 0377 stand for
669 ;; characters in some single-byte character set, and converted them
670 ;; to Emacs characters. But in 23.1 this feature is deprecated
671 ;; in favor of inserting the corresponding Unicode characters.
672 ;; (if (and enable-multibyte-characters
673 ;; (>= char ?\240)
674 ;; (<= char ?\377))
675 ;; (setq char (unibyte-char-to-multibyte char)))
684 "Move forward ARG lines and position at first nonblank character."
690 "Move backward ARG lines and position at first nonblank character."
696 "Move point to the first non-whitespace character on this line."
700 ;; Move back over chars that have whitespace syntax but have the p flag.
704 "Fixup white space between objects around point.
705 Leave one space or none, according to the context."
712 nil
716 "Delete all spaces and tabs around point.
717 If BACKWARD-ONLY is non-nil, only delete them before point."
722 orig-pos
731 "Delete all spaces and tabs around point, leaving one space (or N spaces).
732 If N is negative, delete newlines as well."
749 \f
751 "Move point to the beginning of the buffer.
752 With numeric arg N, put point N/10 of the way from the beginning.
753 If the buffer is narrowed, this command uses the beginning of the
754 accessible part of the buffer.
756 If Transient Mark mode is disabled, leave mark at previous
759 Don't use this command in Lisp programs!
760 \(goto-char (point-min)) is faster."
769 ;; Avoid overflow for large buffer sizes!
777 "Move point to the end of the buffer.
778 With numeric arg N, put point N/10 of the way from the end.
779 If the buffer is narrowed, this command uses the end of the
780 accessible part of the buffer.
782 If Transient Mark mode is disabled, leave mark at previous
785 Don't use this command in Lisp programs!
786 \(goto-char (point-max)) is faster."
793 ;; Avoid overflow for large buffer sizes!
798 ;; If we went to a place in the middle of the buffer,
799 ;; adjust it to the beginning of a line.
802 ;; If the end of the buffer is not already on the screen,
803 ;; then scroll specially to put it near, but not at, the bottom.
808 "Whether single-char deletion commands delete an active region.
809 This has an effect only if Transient Mark mode is enabled, and
810 affects `delete-forward-char' and `delete-backward-char', though
811 not `delete-char'.
813 If the value is the symbol `kill', the active region is killed
814 instead of deleted."
822 "Delete the previous N characters (following if N is negative).
823 If Transient Mark mode is enabled, the mark is active, and N is 1,
824 delete the text in the region and deactivate the mark instead.
825 To disable this, set `delete-active-region' to nil.
827 Optional second arg KILLFLAG, if non-nil, means to kill (save in
828 kill ring) instead of delete. Interactively, N is the prefix
829 arg, and KILLFLAG is set if N is explicitly specified.
831 In Overwrite mode, single character backward deletion may replace
832 tabs with spaces so as to back over columns, unless point is at
833 the end of the line."
838 delete-active-region
840 ;; If a region is active, kill or delete it.
844 ;; In Overwrite mode, maybe untabify while deleting
854 ;; Otherwise, do simple deletion.
858 "Delete the following N characters (previous if N is negative).
859 If Transient Mark mode is enabled, the mark is active, and N is 1,
860 delete the text in the region and deactivate the mark instead.
861 To disable this, set `delete-active-region' to nil.
863 Optional second arg KILLFLAG non-nil means to kill (save in kill
864 ring) instead of delete. Interactively, N is the prefix arg, and
865 KILLFLAG is set if N was explicitly specified."
870 delete-active-region
872 ;; If a region is active, kill or delete it.
876 ;; Otherwise, do simple deletion.
880 "Put point at beginning and mark at end of buffer.
881 If narrowing is in effect, only uses the accessible part of the buffer.
882 You probably should not use this function in Lisp programs;
883 it is usually a mistake for a Lisp function to use any subroutine
884 that uses or sets the mark."
889 \f
891 ;; Counting lines, one way or another.
894 "Go to LINE, counting from line 1 at beginning of buffer.
895 If called interactively, a numeric prefix argument specifies
896 LINE; without a numeric prefix argument, read LINE from the
897 minibuffer.
899 If optional argument BUFFER is non-nil, switch to that buffer and
901 as argument, BUFFER is the most recently selected other buffer.
903 Prior to moving point, this function sets the mark (without
904 activating it), unless Transient Mark mode is enabled and the
905 mark is already active.
907 This function is usually the wrong thing to use in a Lisp program.
908 What you probably want instead is something like:
909 (goto-char (point-min))
910 (forward-line (1- N))
911 If at all possible, an even better solution is to use char counts
912 rather than line counts."
916 ;; Look for a default, a number in the buffer at point.
926 ;; Decide if we're switching buffers.
934 ;; Read the argument, offering that number (if any) as default.
937 buffer-prompt
938 default)
939 default)
940 buffer))))
941 ;; Switch to the desired buffer, one way or another.
946 ;; Leave mark at previous position
948 ;; Move to the specified line number in that buffer.
957 "Count the number of words in the region.
958 If called interactively, print a message reporting the number of
959 lines, words, and chars in the region.
960 If called from Lisp, return the number of words between positions
961 START and END."
968 "Count words between START and END.
969 If called interactively, START and END are normally the start and
970 end of the buffer; but if the region is active, START and END are
971 the start and end of the region. Print a message reporting the
972 number of lines, words, and chars.
974 If called from Lisp, return the number of words between START and
975 END, without printing any message."
985 words))
996 str
1004 "Print the current buffer line number and narrowed line number of point."
1017 "Return number of lines between START and END.
1018 This is usually the number of newlines between them,
1019 but can be one more if START is not equal to END
1020 and the greater of them is not at the start of a line."
1036 done)))
1040 "Return (narrowed) buffer line number at position POS.
1041 If POS is nil, use current buffer location.
1042 Counting starts at (point-min), so the value refers
1043 to the contents of the accessible portion of the buffer."
1053 "Print info on cursor position (on screen and within buffer).
1054 Also describe the character after point, and give its character code
1055 in octal, decimal and hex.
1057 For a non-ASCII multibyte character, also give its encoding in the
1058 buffer's selected coding system if the coding system encodes the
1059 character safely. If the character is encoded into one byte, that
1060 code is shown in hex. If the character is encoded into more than one
1063 In addition, with prefix argument, show details about that character
1064 in *Help* buffer. See also the command `describe-char'."
1069 ;; If the character is one of LRE, LRO, RLE, RLO, it
1070 ;; will start a directional embedding, which could
1071 ;; completely disrupt the rest of the line (e.g., RLO
1072 ;; will display the rest of the line right-to-left).
1073 ;; So we put an invisible PDF character after these
1074 ;; characters, to end the embedding, which eliminates
1075 ;; any effects on the rest of the line.
1077 ;; Strong right-to-left characters cause reordering of
1078 ;; the following numerical characters which show the
1079 ;; codepoint, so append LRM to countermand that.
1089 ;; Avoid overflow from multiplying by 100!
1093 ""
1099 pos total percent beg end col hscroll)
1101 pos total col hscroll))
1103 encoded encoding-msg display-prop under-display)
1110 ;; Check if the character is displayed with some `display'
1111 ;; text property. In that case, set under-display to the
1112 ;; buffer substring covered by that property.
1123 under-display)))
1129 char char char under-display)
1131 char char char under-display display-prop))
1134 char char char
1136 "..."
1140 ;; We show the detailed information about CHAR.
1147 bidi-fixer
1148 encoding-msg pos total percent beg end col hscroll)
1155 bidi-fixer encoding-msg pos total percent col hscroll))))))
1156 \f
1157 ;; Initialize read-expression-map. It is defined at C level.
1160 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1161 ;; too rarely useful.
1171 "The current default value or list of default values in the minibuffer.
1172 The functions `read-from-minibuffer' and `completing-read' bind
1176 "Value for `print-level' while printing value in `eval-expression'.
1177 A value of nil means no limit."
1183 "Value for `print-length' while printing value in `eval-expression'.
1184 A value of nil means no limit."
1190 "If non-nil set `debug-on-error' to t in `eval-expression'.
1191 If nil, don't change the value of `debug-on-error'."
1197 "Format VALUE as a result of evaluated expression.
1198 Return a formatted string which is displayed in the echo area
1199 in addition to the value printed by prin1 in functions which
1200 display the result of expression evaluation."
1213 ;; We define this, rather than making `eval' interactive,
1214 ;; for the sake of completion of names like eval-region, eval-buffer.
1217 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1218 When called interactively, read an Emacs Lisp expression and
1219 evaluate it.
1220 Value is also consed on to front of the variable `values'.
1221 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1222 with prefix argument) means insert the result into the current buffer
1223 instead of printing it in the echo area. Truncates long output
1224 according to the value of the variables `eval-expression-print-length'
1225 and `eval-expression-print-level'.
1227 If `eval-expression-debug-on-error' is non-nil, which is the default,
1228 this command arranges for all errors to enter the debugger."
1232 nil read-expression-map t
1234 current-prefix-arg))
1239 ;; Bind debug-on-error to something unique so that we can
1240 ;; detect when evalled code changes it.
1244 ;; If evalled code has changed the value of debug-on-error,
1245 ;; propagate that change to the global binding.
1261 "Prompting with PROMPT, let user edit COMMAND and eval result.
1262 COMMAND is a Lisp expression. Let user edit that expression in
1263 the minibuffer, then read and evaluate the result."
1270 read-expression-map t
1272 ;; If command was added to command-history as a string,
1273 ;; get rid of that. We want only evaluable expressions there.
1277 ;; If command to be redone does not match front of history,
1278 ;; add it to the history.
1284 "Edit and re-evaluate last complex command, or ARGth from last.
1285 A complex command is one which used the minibuffer.
1286 The command is placed in the minibuffer as a Lisp form for editing.
1287 The result is executed, repeating the command as changed.
1288 If the command has been changed or is not the most recent previous
1289 command it is added to the front of the command history.
1290 You can use the minibuffer history commands \
1292 to get different commands to edit and resubmit."
1295 newcmd)
1307 ;; If command was added to command-history as a
1308 ;; string, get rid of that. We want only
1309 ;; evaluable expressions there.
1313 ;; If command to be redone does not match front of history,
1314 ;; add it to the history.
1323 "Read command name to invoke in `execute-extended-command'."
1328 ;; Get a command name at point in the original buffer
1329 ;; to propose it after M-n.
1333 ;; Read a string, completing from and restricting to the set of
1334 ;; all defined commands. Don't provide any initial input.
1335 ;; Save the command read on the extended-command history list.
1346 ;; This isn't strictly correct if `execute-extended-command'
1347 ;; is bound to anything else (e.g. [menu]).
1348 ;; It could use (key-description (this-single-command-keys)),
1349 ;; but actually a prompt other than "M-x" would be confusing,
1350 ;; because "M-x" is a well-known prompt to read a command
1351 ;; and it serves as a shorthand for "Extended command: ".
1356 "Non-nil means show the equivalent key-binding when M-x command has one.
1357 The value can be a length of time to show the message for.
1358 If the value is non-nil and not a number, we wait 2 seconds."
1365 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1366 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1367 "Read function name, then read its arguments and call it.
1369 To pass a numeric argument to the command you are invoking with, specify
1370 the numeric argument to this command.
1372 Noninteractively, the argument PREFIXARG is the prefix argument to
1373 give to the command you invoke, if it asks for an argument."
1375 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1384 ;; Normally `real-this-command' should never be changed, but here we really
1385 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1386 ;; binding" for <cmd>, so the command the user really wanted to run is
1387 ;; `function' and not `execute-extended-command'. The difference is
1388 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1392 ;; If enabled, show which key runs this command.
1394 ;; But first wait, and skip the message if there is input.
1396 ;; If this command displayed something in the echo area;
1397 ;; wait a few seconds, then display our suggestion message.
1407 suggest-key-bindings
1409 \f
1411 "Default minibuffer history list.
1412 This is used for all minibuffer input
1413 except when an alternate history list is specified.
1415 Maximum length of the history list is determined by the value
1418 "Control whether history list elements are expressions or strings.
1419 If the value of this variable equals current minibuffer depth,
1420 they are expressions; otherwise they are strings.
1421 \(That convention is designed to do the right thing for
1428 "Text that was in this minibuffer before any history commands.
1429 This is nil if there have not yet been any history commands
1438 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1442 "Minibuffer history variables for which matching should ignore case.
1443 If a history variable is a member of this list, then the
1445 commands ignore case when searching it, regardless of `case-fold-search'."
1450 "Find the previous history element that matches REGEXP.
1451 \(Previous history elements refer to earlier actions.)
1452 With prefix argument N, search for Nth previous match.
1453 If N is negative, find the next or Nth next match.
1454 Normally, history elements are matched case-insensitively if
1455 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1456 makes the search case-sensitive.
1457 See also `minibuffer-history-case-insensitive-variables'."
1461 nil
1462 minibuffer-local-map
1463 nil
1464 'minibuffer-history-search-history
1466 ;; Use the last regexp specified, by default, if input is empty.
1471 regexp)
1481 ;; On some systems, ignore case for file names.
1483 minibuffer-history-case-insensitive-variables)
1484 t
1485 ;; Respect the user's setting for case-fold-search:
1486 case-fold-search)
1487 nil))
1488 prevpos
1489 match-string
1490 match-offset
1497 "No later matching history item"
1518 next-matching-history-element))
1522 "Find the next history element that matches REGEXP.
1523 \(The next history element refers to a more recent action.)
1524 With prefix argument N, search for Nth next match.
1525 If N is negative, find the previous or Nth previous match.
1526 Normally, history elements are matched case-insensitively if
1527 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1528 makes the search case-sensitive."
1532 nil
1533 minibuffer-local-map
1534 nil
1535 'minibuffer-history-search-history
1537 ;; Use the last regexp specified, by default, if input is empty.
1542 regexp)
1549 "Function run by `goto-history-element' before consuming default values.
1550 This is useful to dynamically add more elements to the list of default values
1551 when `goto-history-element' reaches the end of this list.
1552 Before calling this function `goto-history-element' sets the variable
1553 `minibuffer-default-add-done' to t, so it will call this function only
1554 once. In special cases, when this function needs to be called more
1555 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1559 "When nil, add more elements to the end of the list of default values.
1560 The value nil causes `goto-history-element' to add more elements to
1561 the list of defaults when it reaches the end of this list. It does
1567 "Return a list of all completions without the default value.
1568 This function is used to add all elements of the completion table to
1569 the end of the list of defaults just after the default value."
1572 minibuffer-completion-table
1573 minibuffer-completion-predicate)))
1579 "Puts element of the minibuffer history in the minibuffer.
1580 The argument NABS specifies the absolute history position."
1594 elt minibuffer-returned-to-present)
1601 "End of defaults; no next item"
1606 previous-history-element))
1618 minibuffer-default)))
1630 elt))
1634 "Puts next element of the minibuffer history in the minibuffer.
1635 With argument N, it uses the Nth following element."
1641 "Puts previous element of the minibuffer history in the minibuffer.
1642 With argument N, it uses the Nth previous element."
1648 "Get next history element which completes the minibuffer before the point.
1649 The contents of the minibuffer after the point are deleted, and replaced
1650 by the new completion."
1656 n)
1657 ;; next-matching-history-element always puts us at (point-min).
1658 ;; Move to the position we were at before changing the buffer contents.
1659 ;; This is still sensible, because the text before point has not changed.
1663 "\
1664 Get previous history element which completes the minibuffer before the point.
1665 The contents of the minibuffer after the point are deleted, and replaced
1666 by the new completion."
1670 ;; For compatibility with the old subr of the same name.
1672 "Return the display width of the minibuffer prompt.
1673 Return 0 if current buffer is not a minibuffer."
1674 ;; Return the width of everything before the field at the end of
1675 ;; the buffer; this should be 0 for normal buffers.
1677 \f
1678 ;; isearch minibuffer history
1685 "Set up a minibuffer for using isearch to search the minibuffer history.
1686 Intended to be added to `minibuffer-setup-hook'."
1698 "Clean up the minibuffer after terminating isearch in the minibuffer."
1703 "Return the proper search function, for isearch in minibuffer history."
1706 ;; Use standard functions to search within minibuffer text
1708 found)
1709 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1710 ;; searching forward. Lazy-highlight calls this lambda with the
1711 ;; bound arg, so skip the minibuffer prompt.
1715 ;; 1. First try searching in the initial minibuffer text
1718 noerror)
1719 ;; 2. If the above search fails, start putting next/prev history
1720 ;; elements in the minibuffer successively, and search the string
1721 ;; in them. Do this only when bound is nil (i.e. not while
1722 ;; lazy-highlighting search strings in the current minibuffer text).
1734 ;; After putting the next/prev history element, search
1735 ;; the string in them again, until next-history-element
1736 ;; or previous-history-element raises an error at the
1737 ;; beginning/end of history.
1740 ;; For backward search, don't search
1741 ;; in the minibuffer prompt
1743 noerror)))
1744 ;; Return point of the new search result
1746 ;; Return nil when next(prev)-history-element fails
1750 "Display the minibuffer history search prompt.
1751 If there are no search errors, this function displays an overlay with
1752 the isearch prompt which replaces the original minibuffer prompt.
1753 Otherwise, it displays the standard isearch message returned from
1754 `isearch-message'."
1756 ;; Use standard function `isearch-message' when not in the minibuffer,
1757 ;; or search fails, or has an error (like incomplete regexp).
1758 ;; This function overwrites minibuffer text with isearch message,
1759 ;; so it's possible to see what is wrong in the search string.
1761 ;; Otherwise, put the overlay with the standard isearch prompt over
1762 ;; the initial minibuffer prompt.
1771 ;; And clear any previous isearch message.
1775 "Wrap the minibuffer history search when search fails.
1776 Move point to the first history element for a forward search,
1777 or to the last history element for a backward search."
1778 ;; When `minibuffer-history-isearch-search' fails on reaching the
1779 ;; beginning/end of the history, wrap the search to the first/last
1780 ;; minibuffer history element.
1788 "Save a function restoring the state of minibuffer history search.
1789 Save `minibuffer-history-position' to the additional state parameter
1790 in the search status stack."
1795 "Restore the minibuffer history search state.
1796 Go to the history element by the absolute history position HIST-POS."
1799 \f
1800 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1804 "Table mapping redo records to the corresponding undo one.
1805 A redo record for undo-in-region maps to t.
1815 "Within a run of consecutive undo commands, list remaining to be undone.
1819 "Undo some previous changes.
1820 Repeat this command to undo more changes.
1821 A numeric ARG serves as a repeat count.
1823 In Transient Mark mode when the mark is active, only undo changes within
1825 as an argument limits undo to changes within the current region."
1827 ;; Make last-command indicate for the next command that this was an undo.
1828 ;; That way, another undo will undo more.
1829 ;; If we get to the end of the undo history and get an error,
1830 ;; another undo command will find the undo history empty
1831 ;; and will get another error. To begin undoing the undos,
1832 ;; you must type some other command.
1835 message)
1836 ;; If we get an error in undo-start,
1837 ;; the next command should not be a "consecutive undo".
1838 ;; So set `this-command' to something other than `undo'.
1843 ;; If something (a timer or filter?) changed the buffer
1844 ;; since the previous command, don't continue the undo seq.
1848 ;; If the last undo record made was made by undo
1849 ;; it shows nothing else happened in between.
1856 ;; get rid of initial undo boundary
1858 ;; If we got this far, the next command should be a consecutive undo.
1860 ;; Check to see whether we're hitting a redo record, and if
1861 ;; so, ask the user whether she wants to skip the redo/undo pair.
1868 ;; The equiv entry might point to another redo record if we have done
1869 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1877 ;; Record the fact that the just-generated undo records come from an
1878 ;; undo operation--that is, they are redo records.
1879 ;; In the ordinary case (not within a region), map the redo
1880 ;; record to the following undos.
1881 ;; I don't know how to do that in the undo-in-region case.
1883 ;; Strip any leading undo boundaries there might be, like we do
1884 ;; above when checking.
1888 undo-equiv-table))
1889 ;; Don't specify a position in the undo record for the undo command.
1890 ;; Instead, undoing this should move point to where the change is.
1909 ;; Record what the current undo list says,
1910 ;; so the next command can tell if the buffer was modified in between.
1913 ;; Display a message announcing success.
1918 "Make BUFFER stop keeping undo information.
1919 No argument or nil as argument means do this for the current buffer."
1925 "Undo some previous changes.
1926 Repeat this command to undo more changes.
1927 A numeric ARG serves as a repeat count.
1928 Contrary to `undo', this will not redo a previous undo."
1933 "Non-nil while performing an undo.
1937 "Undo back N undo-boundaries beyond what was already undone recently.
1938 Call `undo-start' to get ready to undo recent changes,
1939 then call `undo-more' one or more times to undo them."
1944 ;; Note: The following, while pulling elements off
1945 ;; `pending-undo-list' will call primitive change functions which
1946 ;; will push more elements onto `buffer-undo-list'.
1951 ;; Deep copy of a list
1953 "Make a copy of undo list LIST."
1959 elt))
1962 "Set `pending-undo-list' to the front of the undo list.
1963 The next call to `undo-more' will undo the most recently made change.
1964 If BEG and END are specified, then only undo elements
1965 that apply to text between BEG and END are used; other undo elements
1966 are ignored. If BEG and END are nil, all undo elements are used."
1972 buffer-undo-list)))
1977 "Return a list of undo elements for the region START to END.
1978 The elements come from `buffer-undo-list', but we keep only
1979 the elements inside this region, and discard those outside this region.
1980 If we find an element that crosses an edge of this region,
1981 we stop and ignore all further elements."
1984 undo-adjusted-markers
1985 some-rejected
1986 undo-elt temp-undo-list delta)
1991 ;; This is a "was unmodified" element.
1992 ;; Keep it if we have kept everything thus far.
1999 ;; Don't put two nils together in the list
2013 ;; Loop down the earlier events adjusting their buffer
2014 ;; positions to reflect the fact that a change to the buffer
2015 ;; isn't being undone. We only need to process those element
2016 ;; types which undo-elt-in-region will return as being in
2017 ;; the region since only those types can ever get into the
2018 ;; output
2027 ;; (TEXT . POSITION)
2034 ;; (BEGIN . END)
2039 ;; (nil PROPERTY VALUE BEG . END)
2049 "Determine whether UNDO-ELT falls inside the region START ... END.
2050 If it crosses the edge, we return nil."
2055 t)
2057 nil)
2059 ;; (TEXT . POSITION)
2063 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2064 ;; See if MARKER is inside the region.
2075 ;; (nil PROPERTY VALUE BEG . END)
2080 ;; (BEGIN . END)
2085 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2086 This assumes we have already decided that UNDO-ELT
2087 is not *inside* the region START...END."
2090 ;; (nil PROPERTY VALUE BEG . END)
2095 ;; (BEGIN . END)
2099 ;; Return the first affected buffer position and the delta for an undo element
2100 ;; delta is defined as the change in subsequent buffer positions if we *did*
2101 ;; the undo.
2105 ;; (TEXT . POSITION)
2108 ;; (BEGIN . END)
2115 "If non-nil ask about discarding undo info for the current command.
2116 Normally, Emacs discards the undo info for the current command if
2117 it exceeds `undo-outer-limit'. But if you set this option
2118 non-nil, it asks in the echo area whether to discard the info.
2119 If you answer no, there is a slight risk that Emacs might crash, so
2120 only do it if you really want to undo the command.
2122 This option is mainly intended for debugging. You have to be
2123 careful if you use it for other purposes. Garbage collection is
2124 inhibited while the question is asked, meaning that Emacs might
2125 leak memory. So you should make sure that you do not wait
2126 excessively long before answering the question."
2132 "If non-nil, an extra level of size that's ok in an undo item.
2133 We don't ask the user about truncating the undo list until the
2134 current item gets bigger than this amount.
2139 ;; When the first undo batch in an undo list is longer than
2140 ;; undo-outer-limit, this function gets called to warn the user that
2141 ;; the undo info for the current command was discarded. Garbage
2142 ;; collection is inhibited around the call, so it had better not do a
2143 ;; lot of consing.
2149 ;; Don't ask the question again unless it gets even bigger.
2150 ;; This applies, in particular, if the user quits from the question.
2151 ;; Such a quit quits out of GC, but something else will call GC
2152 ;; again momentarily. It will call this function again,
2153 ;; but we don't want to ask the question again.
2160 t)
2161 nil))
2166 "The undo info was discarded because it exceeded \
2167 `undo-outer-limit'.
2169 This is normal if you executed a command that made a huge change
2170 to the buffer. In that case, to prevent similar problems in the
2171 future, set `undo-outer-limit' to a value that is large enough to
2172 cover the maximum size of normal changes you expect a single
2173 command to make, but not so large that it might exceed the
2174 maximum memory allotted to Emacs.
2176 If you did not execute any such command, the situation is
2177 probably due to a bug and you should report it.
2179 You can disable the popping up of this buffer by adding the entry
2180 \(undo discard-info) to the user option `warning-suppress-types',
2184 t))
2185 \f
2187 "History list for some commands that read shell commands.
2189 Maximum length of the history list is determined by the value
2196 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2197 This buffer is used when `shell-command' or `shell-command-on-region'
2198 is run interactively. A value of nil means that output to stderr and
2205 "Return a list of all commands associated with the current file.
2206 This function is used to add all related commands retrieved by `mailcap'
2207 to the end of the list of defaults just after the default value."
2211 minibuffer-default))
2216 commands))
2227 map)
2231 "Read a shell command from the minibuffer.
2232 The arguments are the same as the ones of `read-from-minibuffer',
2233 except READ and KEYMAP are missing and HIST defaults
2234 to `shell-command-history'."
2242 minibuffer-local-shell-command-map
2243 nil
2245 args)))
2248 "Execute string COMMAND asynchronously in background.
2250 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2251 surrounded by whitespace and executes the command asynchronously.
2252 The output appears in the buffer `*Async Shell Command*'.
2254 In Elisp, you will often be better served by calling `start-process'
2255 directly, since it offers more control and does not impose the use of a
2256 shell (with its need to quote arguments)."
2262 current-prefix-arg
2263 shell-command-default-error-buffer))
2269 "Execute string COMMAND in inferior shell; display output, if any.
2270 With prefix argument, insert the COMMAND's output at point.
2272 If COMMAND ends in ampersand, execute it asynchronously.
2273 The output appears in the buffer `*Async Shell Command*'.
2274 That buffer is in shell mode.
2276 Otherwise, COMMAND is executed synchronously. The output appears in
2277 the buffer `*Shell Command Output*'. If the output is short enough to
2278 display in the echo area (which is determined by the variables
2279 `resize-mini-windows' and `max-mini-window-height'), it is shown
2280 there, but it is nonetheless available in buffer `*Shell Command
2281 Output*' even though that buffer is not automatically displayed.
2283 To specify a coding system for converting non-ASCII characters
2285 before this command.
2287 Noninteractive callers can specify coding systems by binding
2288 `coding-system-for-read' and `coding-system-for-write'.
2290 The optional second argument OUTPUT-BUFFER, if non-nil,
2291 says to put the output in some other buffer.
2292 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2293 If OUTPUT-BUFFER is not a buffer and not nil,
2294 insert output in current buffer. (This cannot be done asynchronously.)
2295 In either case, the buffer is first erased, and the output is
2296 inserted after point (leaving mark after it).
2298 If the command terminates without error, but generates output,
2300 the output can be displayed in the echo area or in its buffer.
2301 If the output is short enough to display in the echo area
2302 \(determined by the variable `max-mini-window-height' if
2303 `resize-mini-windows' is non-nil), it is shown there.
2304 Otherwise,the buffer containing the output is displayed.
2308 of the output.
2310 If there is no output, or if output is inserted in the current buffer,
2311 then `*Shell Command Output*' is deleted.
2313 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2314 or buffer name to which to direct the command's standard error output.
2315 If it is nil, error output is mingled with regular output.
2316 In an interactive call, the variable `shell-command-default-error-buffer'
2317 specifies the value of ERROR-BUFFER.
2319 In Elisp, you will often be better served by calling `call-process' or
2320 `start-process' directly, since it offers more control and does not impose
2321 the use of a shell (with its need to quote arguments)."
2332 current-prefix-arg
2333 shell-command-default-error-buffer))
2334 ;; Look for a handler in case default-directory is a remote file name.
2342 ;; Output goes in current buffer.
2348 temporary-file-directory)))
2349 nil)))
2352 ;; We do not use -f for csh; we will not support broken use of
2353 ;; .cshrcs. Even the BSD csh manual says to use
2354 ;; "if ($?prompt) exit" before things which are not useful
2355 ;; non-interactively. Besides, if someone wants their other
2356 ;; aliases for shell commands then they can still have them.
2360 t)
2361 nil shell-command-switch command)
2368 ;; Do no formatting while reading error file,
2369 ;; because that can run a shell command, and we
2370 ;; don't want that to cause an infinite recursion.
2372 ;; Put point after the inserted errors.
2376 ;; This is like exchange-point-and-mark, but doesn't
2377 ;; activate the mark. It is cleaner to avoid activation,
2378 ;; even though the command loop would deactivate the mark
2379 ;; because we inserted text.
2383 ;; Output goes in a separate buffer.
2384 ;; Preserve the match data in case called from a program.
2387 ;; Command ending with ampersand means asynchronous.
2391 proc)
2392 ;; Remove the ampersand.
2394 ;; If will kill a process, query first.
2402 ;; Setting buffer-read-only to nil doesn't suffice
2403 ;; if some text has a non-nil read-only property,
2404 ;; which comint sometimes adds for prompts.
2410 shell-command-switch command))
2414 ;; Use the comint filter for proper handling of carriage motion
2415 ;; (see `comint-inhibit-carriage-motion'),.
2417 ))
2418 ;; Otherwise, command is executed synchronously.
2420 output-buffer nil error-buffer)))))))
2424 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2425 MESSAGE may be either a string or a buffer.
2427 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2428 the maximum height of the echo area, as defined by `max-mini-window-height'
2429 if `resize-mini-windows' is non-nil.
2431 Returns either the string shown in the echo area, or when a pop-up
2432 buffer is used, the window used to display it.
2434 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2435 name of the buffer used to display it in the case where a pop-up buffer
2436 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2437 string and it is displayed in the echo area, it is not specified whether
2438 the contents are inserted into the buffer anyway.
2440 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2441 and only used if a buffer is displayed."
2443 ;; Trivial case where we can use the echo area
2447 ;; Trivial case where we can just remove single trailing newline
2450 ;; General case
2453 message
2462 0
2466 (<= lines
2470 max-mini-window-height))
2472 max-mini-window-height)
2476 ;; Don't use the echo area if the output buffer is
2477 ;; already displayed in the selected frame.
2479 ;; Echo area
2485 ;; Buffer
2488 not-this-window frame))))))))
2491 ;; We have a sentinel to prevent insertion of a termination message
2492 ;; in the buffer itself.
2500 &optional output-buffer replace
2501 error-buffer display-error-buffer)
2502 "Execute string COMMAND in inferior shell with region as input.
2503 Normally display output (if any) in temp buffer `*Shell Command Output*';
2504 Prefix arg means replace the region with it. Return the exit code of
2505 COMMAND.
2507 To specify a coding system for converting non-ASCII characters
2509 before this command. By default, the input (from the current buffer)
2510 is encoded using coding-system specified by `process-coding-system-alist',
2511 falling back to `default-process-coding-system' if no match for COMMAND
2512 is found in `process-coding-system-alist'.
2514 The noninteractive arguments are START, END, COMMAND,
2515 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2516 Noninteractive callers can specify coding systems by binding
2517 `coding-system-for-read' and `coding-system-for-write'.
2519 If the command generates output, the output may be displayed
2520 in the echo area or in a buffer.
2521 If the output is short enough to display in the echo area
2522 \(determined by the variable `max-mini-window-height' if
2523 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2524 it is displayed in the buffer `*Shell Command Output*'. The output
2525 is available in that buffer in both cases.
2527 If there is output and an error, a message about the error
2528 appears at the end of the output.
2530 If there is no output, or if output is inserted in the current buffer,
2531 then `*Shell Command Output*' is deleted.
2533 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2534 that says to put the output in some other buffer.
2535 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2536 If OUTPUT-BUFFER is not a buffer and not nil,
2537 insert output in the current buffer.
2538 In either case, the output is inserted after point (leaving mark after it).
2540 If REPLACE, the optional fifth argument, is non-nil, that means insert
2541 the output in place of text from START to END, putting point and mark
2542 around it.
2544 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2545 or buffer name to which to direct the command's standard error output.
2546 If it is nil, error output is mingled with regular output.
2547 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2548 were any errors. (This is always t, interactively.)
2549 In an interactive call, the variable `shell-command-default-error-buffer'
2550 specifies the value of ERROR-BUFFER."
2554 ;; Do this before calling region-beginning
2555 ;; and region-end, in case subprocess output
2556 ;; relocates them while we are in the minibuffer.
2558 ;; call-interactively recognizes region-beginning and
2559 ;; region-end specially, leaving them in the history.
2561 string
2562 current-prefix-arg
2563 current-prefix-arg
2564 shell-command-default-error-buffer
2565 t)))
2571 temporary-file-directory)))
2572 nil))
2573 exit-status)
2577 ;; Replace specified region with output from command.
2579 ;; Don't muck with mark unless REPLACE says we should.
2586 t)
2587 nil shell-command-switch command))
2588 ;; It is rude to delete a buffer which the command is not using.
2589 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2590 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2591 ;; (kill-buffer shell-buffer)))
2592 ;; Don't muck with mark unless REPLACE says we should.
2594 ;; No prefix argument: put the output in a temp buffer,
2595 ;; replacing its entire contents.
2600 ;; If the input is the same buffer as the output,
2601 ;; delete everything but the specified region,
2602 ;; then replace that region with the output.
2608 shell-file-name t
2611 t)
2612 nil shell-command-switch
2613 command)))
2614 ;; Clear the output buffer, then run the command with
2615 ;; output there.
2626 buffer)
2627 nil shell-command-switch command)))
2628 ;; Report the output.
2638 ;; There's some output, display it
2640 ;; No output; error?
2647 shell-command-default-error-buffer)
2654 output))
2657 exit-status))
2660 exit-status output))))
2661 ;; Don't kill: there might be useful info in the undo-log.
2662 ;; (kill-buffer buffer)
2663 ))))
2671 ;; Do no formatting while reading error file,
2672 ;; because that can run a shell command, and we
2673 ;; don't want that to cause an infinite recursion.
2675 ;; Put point after the inserted errors.
2680 exit-status))
2683 "Execute shell command COMMAND and return its output as a string."
2686 standard-output
2690 "Process files synchronously in a separate process.
2691 Similar to `call-process', but may invoke a file handler based on
2692 `default-directory'. The current working directory of the
2693 subprocess is `default-directory'.
2695 File names in INFILE and BUFFER are handled normally, but file
2696 names in ARGS should be relative to `default-directory', as they
2697 are passed to the process verbatim. \(This is a difference to
2698 `call-process' which does not support file handlers for INFILE
2699 and BUFFER.\)
2701 Some file handlers might not support all variants, for example
2702 they might behave as if DISPLAY was nil, regardless of the actual
2703 value passed."
2705 lc stderr-file)
2715 display args)
2721 "Whether a call of `process-file' changes remote files.
2723 By default, this variable is always set to `t', meaning that a
2724 call of `process-file' could potentially change any file on a
2725 remote host. When set to `nil', a file handler could optimize
2726 its behavior with respect to remote file attribute caching.
2728 You should only ever change this variable with a let-binding;
2732 "Start a program in a subprocess. Return the process object for it.
2734 Similar to `start-process', but may invoke a file handler based on
2735 `default-directory'. See Info node `(elisp)Magic File Names'.
2737 This handler ought to run PROGRAM, perhaps on the local host,
2738 perhaps on a remote host that corresponds to `default-directory'.
2739 In the latter case, the local part of `default-directory' becomes
2740 the working directory of the process.
2742 PROGRAM and PROGRAM-ARGS might be file names. They are not
2743 objects of file handler invocation. File handlers might not
2744 support pty association, if PROGRAM is nil."
2748 \f
2749 ;;;; Process menu
2761 "Major mode for listing the processes called by Emacs."
2773 "Recompute the list of processes for the Process List buffer.
2774 Also, delete any process that is exited or signaled."
2787 face link
2790 follow-link t
2791 process-buffer ,buf
2792 action process-menu-visit-buffer)
2801 "datagram"
2816 tabulated-list-entries))))))
2822 "Display a list of all processes.
2823 If optional argument QUERY-ONLY is non-nil, only processes with
2824 the query-on-exit flag set are listed.
2825 Any process listed as exited or signaled is actually eliminated
2826 after the listing is made.
2827 Optional argument BUFFER specifies a buffer to use, instead of
2829 The return value is always nil."
2841 nil)
2842 \f
2846 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2847 (define-key map [switch-frame] nil)
2848 (define-key map [?\C-u] 'universal-argument-more)
2849 (define-key map [?-] 'universal-argument-minus)
2850 (define-key map [?0] 'digit-argument)
2851 (define-key map [?1] 'digit-argument)
2852 (define-key map [?2] 'digit-argument)
2853 (define-key map [?3] 'digit-argument)
2854 (define-key map [?4] 'digit-argument)
2855 (define-key map [?5] 'digit-argument)
2856 (define-key map [?6] 'digit-argument)
2857 (define-key map [?7] 'digit-argument)
2858 (define-key map [?8] 'digit-argument)
2859 (define-key map [?9] 'digit-argument)
2860 (define-key map [kp-0] 'digit-argument)
2861 (define-key map [kp-1] 'digit-argument)
2862 (define-key map [kp-2] 'digit-argument)
2863 (define-key map [kp-3] 'digit-argument)
2864 (define-key map [kp-4] 'digit-argument)
2865 (define-key map [kp-5] 'digit-argument)
2866 (define-key map [kp-6] 'digit-argument)
2867 (define-key map [kp-7] 'digit-argument)
2868 (define-key map [kp-8] 'digit-argument)
2869 (define-key map [kp-9] 'digit-argument)
2870 (define-key map [kp-subtract] 'universal-argument-minus)
2871 map)
2874 (defvar universal-argument-num-events nil
2875 "Number of argument-specifying events read by `universal-argument'.
2876 `universal-argument-other-key' uses this to discard those events
2877 from (this-command-keys), and reread only the final command.")
2879 (defvar saved-overriding-map t
2880 "The saved value of `overriding-terminal-local-map'.
2884 (defun save&set-overriding-map (map)
2885 "Set `overriding-terminal-local-map' to MAP."
2886 (when (eq saved-overriding-map t)
2887 (setq saved-overriding-map overriding-terminal-local-map)
2888 (setq overriding-terminal-local-map map)))
2890 (defun restore-overriding-map ()
2891 "Restore `overriding-terminal-local-map' to its saved value."
2892 (setq overriding-terminal-local-map saved-overriding-map)
2893 (setq saved-overriding-map t))
2895 (defun universal-argument ()
2896 "Begin a numeric argument for the following command.
2901 multiplies the argument by 4 each time.
2903 which is different in effect from any particular numeric argument.
2905 (interactive)
2906 (setq prefix-arg (list 4))
2907 (setq universal-argument-num-events (length (this-command-keys)))
2908 (save&set-overriding-map universal-argument-map))
2910 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2911 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2912 (defun universal-argument-more (arg)
2913 (interactive "P")
2914 (if (consp arg)
2915 (setq prefix-arg (list (* 4 (car arg))))
2916 (if (eq arg '-)
2917 (setq prefix-arg (list -4))
2918 (setq prefix-arg arg)
2919 (restore-overriding-map)))
2920 (setq universal-argument-num-events (length (this-command-keys))))
2922 (defun negative-argument (arg)
2923 "Begin a negative numeric argument for the next command.
2925 (interactive "P")
2926 (cond ((integerp arg)
2927 (setq prefix-arg (- arg)))
2928 ((eq arg '-)
2929 (setq prefix-arg nil))
2930 (t
2931 (setq prefix-arg '-)))
2932 (setq universal-argument-num-events (length (this-command-keys)))
2933 (save&set-overriding-map universal-argument-map))
2935 (defun digit-argument (arg)
2936 "Part of the numeric argument for the next command.
2938 (interactive "P")
2939 (let* ((char (if (integerp last-command-event)
2940 last-command-event
2941 (get last-command-event 'ascii-character)))
2943 (cond ((integerp arg)
2944 (setq prefix-arg (+ (* arg 10)
2945 (if (< arg 0) (- digit) digit))))
2946 ((eq arg '-)
2947 ;; Treat -0 as just -, so that -01 will work.
2948 (setq prefix-arg (if (zerop digit) '- (- digit))))
2949 (t
2950 (setq prefix-arg digit))))
2951 (setq universal-argument-num-events (length (this-command-keys)))
2952 (save&set-overriding-map universal-argument-map))
2954 ;; For backward compatibility, minus with no modifiers is an ordinary
2955 ;; command if digits have already been entered.
2956 (defun universal-argument-minus (arg)
2957 (interactive "P")
2958 (if (integerp arg)
2959 (universal-argument-other-key arg)
2960 (negative-argument arg)))
2962 ;; Anything else terminates the argument and is left in the queue to be
2963 ;; executed as a command.
2964 (defun universal-argument-other-key (arg)
2965 (interactive "P")
2966 (setq prefix-arg arg)
2967 (let* ((key (this-command-keys))
2968 (keylist (listify-key-sequence key)))
2969 (setq unread-command-events
2970 (append (nthcdr universal-argument-num-events keylist)
2971 unread-command-events)))
2972 (reset-this-command-lengths)
2973 (restore-overriding-map))
2974 \f
2976 (defvar filter-buffer-substring-functions nil
2977 "This variable is a wrapper hook around `filter-buffer-substring'.
2978 Each member of the hook should be a function accepting four arguments:
2979 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
2980 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
2981 as those of `filter-buffer-substring' in each case.
2983 The first hook function to be called receives a FUN equivalent
2984 to the default operation of `filter-buffer-substring',
2985 i.e. one that returns the buffer-substring between BEG and
2986 END (processed by any `buffer-substring-filters'). Normally,
2987 the hook function will call FUN and then do its own processing
2988 of the result. The next hook function receives a FUN equivalent
2989 to the previous hook function, calls it, and does its own
2990 processing, and so on. The overall result is that of all hook
2991 functions acting in sequence.
2993 Any hook may choose not to call FUN though, in which case it
2994 effectively replaces the default behavior with whatever it chooses.
2995 Of course, a later hook function may do the same thing.")
2997 (defvar buffer-substring-filters nil
2998 "List of filter functions for `filter-buffer-substring'.
2999 Each function must accept a single argument, a string, and return
3000 a string. The buffer substring is passed to the first function
3001 in the list, and the return value of each function is passed to
3002 the next. The final result (if `buffer-substring-filters' is
3003 nil, this is the unfiltered buffer-substring) is passed to the
3004 first function on `filter-buffer-substring-functions'.
3006 As a special convention, point is set to the start of the buffer text
3007 being operated on (i.e., the first argument of `filter-buffer-substring')
3008 before these functions are called.")
3009 (make-obsolete-variable 'buffer-substring-filters
3010 'filter-buffer-substring-functions "24.1")
3012 (defun filter-buffer-substring (beg end &optional delete)
3013 "Return the buffer substring between BEG and END, after filtering.
3014 The wrapper hook `filter-buffer-substring-functions' performs
3015 the actual filtering. The obsolete variable `buffer-substring-filters'
3016 is also consulted. If both of these are nil, no filtering is done.
3018 If DELETE is non-nil, the text between BEG and END is deleted
3019 from the buffer.
3021 This function should be used instead of `buffer-substring',
3022 `buffer-substring-no-properties', or `delete-and-extract-region'
3023 when you want to allow filtering to take place. For example,
3024 major or minor modes can use `filter-buffer-substring-functions' to
3025 extract characters that are special to a buffer, and should not
3026 be copied into other buffers."
3027 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3028 (cond
3029 ((or delete buffer-substring-filters)
3030 (save-excursion
3031 (goto-char beg)
3032 (let ((string (if delete (delete-and-extract-region beg end)
3033 (buffer-substring beg end))))
3034 (dolist (filter buffer-substring-filters)
3035 (setq string (funcall filter string)))
3036 string)))
3037 (t
3038 (buffer-substring beg end)))))
3041 ;;;; Window system cut and paste hooks.
3043 (defvar interprogram-cut-function nil
3044 "Function to call to make a killed region available to other programs.
3045 Most window systems provide a facility for cutting and pasting
3046 text between different programs, such as the clipboard on X and
3047 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3049 This variable holds a function that Emacs calls whenever text is
3050 put in the kill ring, to make the new kill available to other
3051 programs. The function takes one argument, TEXT, which is a
3052 string containing the text which should be made available.")
3054 (defvar interprogram-paste-function nil
3055 "Function to call to get text cut from other programs.
3056 Most window systems provide a facility for cutting and pasting
3057 text between different programs, such as the clipboard on X and
3058 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3060 This variable holds a function that Emacs calls to obtain text
3061 that other programs have provided for pasting. The function is
3062 called with no arguments. If no other program has provided text
3063 to paste, the function should return nil (in which case the
3064 caller, usually `current-kill', should use the top of the Emacs
3065 kill ring). If another program has provided text to paste, the
3066 function should return that text as a string (in which case the
3067 caller should put this string in the kill ring as the latest
3068 kill).
3070 The function may also return a list of strings if the window
3071 system supports multiple selections. The first string will be
3072 used as the pasted text, but the other will be placed in the kill
3073 ring for easy access via `yank-pop'.
3075 Note that the function should return a string only if a program
3076 other than Emacs has provided a string for pasting; if Emacs
3077 provided the most recent string, the function should return nil.
3078 If it is difficult to tell whether Emacs or some other program
3079 provided the current string, it is probably good enough to return
3080 nil if the string is equal (according to `string=') to the last
3081 text Emacs provided.")
3082 \f
3085 ;;;; The kill ring data structure.
3087 (defvar kill-ring nil
3088 "List of killed text sequences.
3089 Since the kill ring is supposed to interact nicely with cut-and-paste
3090 facilities offered by window systems, use of this variable should
3091 interact nicely with `interprogram-cut-function' and
3092 `interprogram-paste-function'. The functions `kill-new',
3093 `kill-append', and `current-kill' are supposed to implement this
3094 interaction; you may want to use them instead of manipulating the kill
3095 ring directly.")
3097 (defcustom kill-ring-max 60
3098 "Maximum length of kill ring before oldest elements are thrown away."
3099 :type 'integer
3100 :group 'killing)
3102 (defvar kill-ring-yank-pointer nil
3103 "The tail of the kill ring whose car is the last thing yanked.")
3105 (defcustom save-interprogram-paste-before-kill nil
3106 "Save clipboard strings into kill ring before replacing them.
3107 When one selects something in another program to paste it into Emacs,
3108 but kills something in Emacs before actually pasting it,
3109 this selection is gone unless this variable is non-nil,
3110 in which case the other program's selection is saved in the `kill-ring'
3112 :type 'boolean
3113 :group 'killing
3114 :version "23.2")
3116 (defcustom kill-do-not-save-duplicates nil
3117 "Do not add a new string to `kill-ring' if it duplicates the last one.
3118 The comparison is done using `equal-including-properties'."
3119 :type 'boolean
3120 :group 'killing
3121 :version "23.2")
3123 (defun kill-new (string &optional replace yank-handler)
3124 "Make STRING the latest kill in the kill ring.
3125 Set `kill-ring-yank-pointer' to point to it.
3126 If `interprogram-cut-function' is non-nil, apply it to STRING.
3127 Optional second argument REPLACE non-nil means that STRING will replace
3128 the front of the kill ring, rather than being added to the list.
3130 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3131 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3132 STRING.
3134 When the yank handler has a non-nil PARAM element, the original STRING
3135 argument is not used by `insert-for-yank'. However, since Lisp code
3136 may access and use elements from the kill ring directly, the STRING
3138 (if (> (length string) 0)
3139 (if yank-handler
3140 (put-text-property 0 (length string)
3141 'yank-handler yank-handler string))
3142 (if yank-handler
3143 (signal 'args-out-of-range
3144 (list string "yank-handler specified for empty string"))))
3145 (unless (and kill-do-not-save-duplicates
3146 ;; Due to text properties such as 'yank-handler that
3147 ;; can alter the contents to yank, comparison using
3148 ;; `equal' is unsafe.
3149 (equal-including-properties string (car kill-ring)))
3150 (if (fboundp 'menu-bar-update-yank-menu)
3151 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3152 (when save-interprogram-paste-before-kill
3153 (let ((interprogram-paste (and interprogram-paste-function
3154 (funcall interprogram-paste-function))))
3155 (when interprogram-paste
3156 (dolist (s (if (listp interprogram-paste)
3157 (nreverse interprogram-paste)
3158 (list interprogram-paste)))
3159 (unless (and kill-do-not-save-duplicates
3160 (equal-including-properties s (car kill-ring)))
3161 (push s kill-ring))))))
3162 (unless (and kill-do-not-save-duplicates
3163 (equal-including-properties string (car kill-ring)))
3164 (if (and replace kill-ring)
3165 (setcar kill-ring string)
3166 (push string kill-ring)
3167 (if (> (length kill-ring) kill-ring-max)
3168 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3169 (setq kill-ring-yank-pointer kill-ring)
3170 (if interprogram-cut-function
3171 (funcall interprogram-cut-function string)))
3172 (set-advertised-calling-convention
3173 'kill-new '(string &optional replace) "23.3")
3175 (defun kill-append (string before-p &optional yank-handler)
3176 "Append STRING to the end of the latest kill in the kill ring.
3177 If BEFORE-P is non-nil, prepend STRING to the kill.
3178 If `interprogram-cut-function' is set, pass the resulting kill to it."
3179 (let* ((cur (car kill-ring)))
3180 (kill-new (if before-p (concat string cur) (concat cur string))
3181 (or (= (length cur) 0)
3182 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3183 yank-handler)))
3184 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3186 (defcustom yank-pop-change-selection nil
3187 "Whether rotating the kill ring changes the window system selection.
3188 If non-nil, whenever the kill ring is rotated (usually via the
3189 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3190 to copy the new kill to the window system selection."
3191 :type 'boolean
3192 :group 'killing
3193 :version "23.1")
3195 (defun current-kill (n &optional do-not-move)
3196 "Rotate the yanking point by N places, and then return that kill.
3197 If N is zero and `interprogram-paste-function' is set to a
3198 function that returns a string or a list of strings, and if that
3199 function doesn't return nil, then that string (or list) is added
3200 to the front of the kill ring and the string (or first string in
3201 the list) is returned as the latest kill.
3203 If N is not zero, and if `yank-pop-change-selection' is
3204 non-nil, use `interprogram-cut-function' to transfer the
3205 kill at the new yank point into the window system selection.
3207 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3208 move the yanking point; just return the Nth kill forward."
3210 (let ((interprogram-paste (and (= n 0)
3211 interprogram-paste-function
3212 (funcall interprogram-paste-function))))
3213 (if interprogram-paste
3214 (progn
3215 ;; Disable the interprogram cut function when we add the new
3216 ;; text to the kill ring, so Emacs doesn't try to own the
3217 ;; selection, with identical text.
3218 (let ((interprogram-cut-function nil))
3219 (if (listp interprogram-paste)
3220 (mapc 'kill-new (nreverse interprogram-paste))
3221 (kill-new interprogram-paste)))
3222 (car kill-ring))
3223 (or kill-ring (error "Kill ring is empty"))
3224 (let ((ARGth-kill-element
3225 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3226 (length kill-ring))
3227 kill-ring)))
3228 (unless do-not-move
3229 (setq kill-ring-yank-pointer ARGth-kill-element)
3230 (when (and yank-pop-change-selection
3231 (> n 0)
3232 interprogram-cut-function)
3233 (funcall interprogram-cut-function (car ARGth-kill-element))))
3234 (car ARGth-kill-element)))))
3238 ;;;; Commands for manipulating the kill ring.
3240 (defcustom kill-read-only-ok nil
3241 "Non-nil means don't signal an error for killing read-only text."
3242 :type 'boolean
3243 :group 'killing)
3245 (defun kill-region (beg end &optional yank-handler)
3247 This deletes the text from the buffer and saves it in the kill ring.
3251 If you want to append the killed region to the last killed text,
3254 If the buffer is read-only, Emacs will beep and refrain from deleting
3255 the text, but put the text in the kill ring anyway. This means that
3256 you can use the killing commands to copy text from a read-only buffer.
3258 Lisp programs should use this function for killing text.
3259 (To delete text, use `delete-region'.)
3260 Supply two arguments, character positions indicating the stretch of text
3261 to be killed.
3263 If the previous command was also a kill command,
3264 the text killed this time appends to the text killed last time
3265 to make one entry in the kill ring."
3266 ;; Pass point first, then mark, because the order matters
3267 ;; when calling kill-append.
3268 (interactive (list (point) (mark)))
3269 (unless (and beg end)
3270 (error "The mark is not set now, so there is no region"))
3271 (condition-case nil
3272 (let ((string (filter-buffer-substring beg end t)))
3273 (when string ;STRING is nil if BEG = END
3274 ;; Add that string to the kill ring, one way or another.
3275 (if (eq last-command 'kill-region)
3276 (kill-append string (< end beg) yank-handler)
3277 (kill-new string nil yank-handler)))
3278 (when (or string (eq last-command 'kill-region))
3279 (setq this-command 'kill-region))
3280 nil)
3281 ((buffer-read-only text-read-only)
3282 ;; The code above failed because the buffer, or some of the characters
3283 ;; in the region, are read-only.
3284 ;; We should beep, in case the user just isn't aware of this.
3285 ;; However, there's no harm in putting
3286 ;; the region's text in the kill ring, anyway.
3287 (copy-region-as-kill beg end)
3288 ;; Set this-command now, so it will be set even if we get an error.
3289 (setq this-command 'kill-region)
3290 ;; This should barf, if appropriate, and give us the correct error.
3291 (if kill-read-only-ok
3292 (progn (message "Read only text copied to kill ring") nil)
3293 ;; Signal an error if the buffer is read-only.
3294 (barf-if-buffer-read-only)
3295 ;; If the buffer isn't read-only, the text is.
3296 (signal 'text-read-only (list (current-buffer)))))))
3297 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3299 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3300 ;; to get two copies of the text when the user accidentally types M-w and
3301 ;; then corrects it with the intended C-w.
3302 (defun copy-region-as-kill (beg end)
3303 "Save the region as if killed, but don't kill it.
3304 In Transient Mark mode, deactivate the mark.
3305 If `interprogram-cut-function' is non-nil, also save the text for a window
3306 system cut and paste.
3308 This command's old key binding has been given to `kill-ring-save'."
3309 (interactive "r")
3310 (if (eq last-command 'kill-region)
3311 (kill-append (filter-buffer-substring beg end) (< end beg))
3312 (kill-new (filter-buffer-substring beg end)))
3313 (setq deactivate-mark t)
3314 nil)
3316 (defun kill-ring-save (beg end)
3317 "Save the region as if killed, but don't kill it.
3318 In Transient Mark mode, deactivate the mark.
3319 If `interprogram-cut-function' is non-nil, also save the text for a window
3320 system cut and paste.
3322 If you want to append the killed line to the last killed text,
3325 This command is similar to `copy-region-as-kill', except that it gives
3326 visual feedback indicating the extent of the region being copied."
3327 (interactive "r")
3328 (copy-region-as-kill beg end)
3329 ;; This use of called-interactively-p is correct
3330 ;; because the code it controls just gives the user visual feedback.
3331 (if (called-interactively-p 'interactive)
3332 (let ((other-end (if (= (point) beg) end beg))
3333 (opoint (point))
3334 ;; Inhibit quitting so we can make a quit here
3335 ;; look like a C-g typed as a command.
3336 (inhibit-quit t))
3337 (if (pos-visible-in-window-p other-end (selected-window))
3338 ;; Swap point-and-mark quickly so as to show the region that
3339 ;; was selected. Don't do it if the region is highlighted.
3340 (unless (and (region-active-p)
3341 (face-background 'region))
3342 ;; Swap point and mark.
3343 (set-marker (mark-marker) (point) (current-buffer))
3344 (goto-char other-end)
3345 (sit-for blink-matching-delay)
3346 ;; Swap back.
3347 (set-marker (mark-marker) other-end (current-buffer))
3348 (goto-char opoint)
3349 ;; If user quit, deactivate the mark
3350 ;; as C-g would as a command.
3351 (and quit-flag mark-active
3352 (deactivate-mark)))
3353 (let* ((killed-text (current-kill 0))
3354 (message-len (min (length killed-text) 40)))
3355 (if (= (point) beg)
3356 ;; Don't say "killed"; that is misleading.
3358 (substring killed-text (- message-len)))
3360 (substring killed-text 0 message-len))))))))
3362 (defun append-next-kill (&optional interactive)
3363 "Cause following command, if it kills, to append to previous kill.
3364 The argument is used for internal purposes; do not supply one."
3365 (interactive "p")
3366 ;; We don't use (interactive-p), since that breaks kbd macros.
3367 (if interactive
3368 (progn
3369 (setq this-command 'kill-region)
3370 (message "If the next command is a kill, it will append"))
3371 (setq last-command 'kill-region)))
3372 \f
3373 ;; Yanking.
3375 ;; This is actually used in subr.el but defcustom does not work there.
3376 (defcustom yank-excluded-properties
3377 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3378 yank-handler follow-link fontified)
3379 "Text properties to discard when yanking.
3380 The value should be a list of text properties to discard or t,
3381 which means to discard all text properties."
3382 :type '(choice (const :tag "All" t) (repeat symbol))
3383 :group 'killing
3384 :version "22.1")
3386 (defvar yank-window-start nil)
3387 (defvar yank-undo-function nil
3388 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3389 Function is called with two parameters, START and END corresponding to
3390 the value of the mark and point; it is guaranteed that START <= END.
3391 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3393 (defun yank-pop (&optional arg)
3394 "Replace just-yanked stretch of killed text with a different stretch.
3395 This command is allowed only immediately after a `yank' or a `yank-pop'.
3396 At such a time, the region contains a stretch of reinserted
3397 previously-killed text. `yank-pop' deletes that text and inserts in its
3398 place a different stretch of killed text.
3400 With no argument, the previous kill is inserted.
3401 With argument N, insert the Nth previous kill.
3402 If N is negative, this is a more recent kill.
3404 The sequence of kills wraps around, so that after the oldest one
3405 comes the newest one.
3407 When this command inserts killed text into the buffer, it honors
3408 `yank-excluded-properties' and `yank-handler' as described in the
3409 doc string for `insert-for-yank-1', which see."
3410 (interactive "*p")
3411 (if (not (eq last-command 'yank))
3412 (error "Previous command was not a yank"))
3413 (setq this-command 'yank)
3414 (unless arg (setq arg 1))
3415 (let ((inhibit-read-only t)
3416 (before (< (point) (mark t))))
3417 (if before
3418 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3419 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3420 (setq yank-undo-function nil)
3421 (set-marker (mark-marker) (point) (current-buffer))
3422 (insert-for-yank (current-kill arg))
3423 ;; Set the window start back where it was in the yank command,
3424 ;; if possible.
3425 (set-window-start (selected-window) yank-window-start t)
3426 (if before
3427 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3428 ;; It is cleaner to avoid activation, even though the command
3429 ;; loop would deactivate the mark because we inserted text.
3430 (goto-char (prog1 (mark t)
3431 (set-marker (mark-marker) (point) (current-buffer))))))
3432 nil)
3434 (defun yank (&optional arg)
3436 More precisely, reinsert the stretch of killed text most recently
3437 killed OR yanked. Put point at end, and set mark at beginning.
3438 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3439 With argument N, reinsert the Nth most recently killed stretch of killed
3440 text.
3442 When this command inserts killed text into the buffer, it honors
3443 `yank-excluded-properties' and `yank-handler' as described in the
3444 doc string for `insert-for-yank-1', which see.
3447 (interactive "*P")
3448 (setq yank-window-start (window-start))
3449 ;; If we don't get all the way thru, make last-command indicate that
3450 ;; for the following command.
3451 (setq this-command t)
3452 (push-mark (point))
3453 (insert-for-yank (current-kill (cond
3454 ((listp arg) 0)
3455 ((eq arg '-) -2)
3456 (t (1- arg)))))
3457 (if (consp arg)
3458 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3459 ;; It is cleaner to avoid activation, even though the command
3460 ;; loop would deactivate the mark because we inserted text.
3461 (goto-char (prog1 (mark t)
3462 (set-marker (mark-marker) (point) (current-buffer)))))
3463 ;; If we do get all the way thru, make this-command indicate that.
3464 (if (eq this-command t)
3465 (setq this-command 'yank))
3466 nil)
3468 (defun rotate-yank-pointer (arg)
3469 "Rotate the yanking point in the kill ring.
3470 With ARG, rotate that many kills forward (or backward, if negative)."
3471 (interactive "p")
3472 (current-kill arg))
3473 \f
3474 ;; Some kill commands.
3476 ;; Internal subroutine of delete-char
3477 (defun kill-forward-chars (arg)
3478 (if (listp arg) (setq arg (car arg)))
3479 (if (eq arg '-) (setq arg -1))
3480 (kill-region (point) (+ (point) arg)))
3482 ;; Internal subroutine of backward-delete-char
3483 (defun kill-backward-chars (arg)
3484 (if (listp arg) (setq arg (car arg)))
3485 (if (eq arg '-) (setq arg -1))
3486 (kill-region (point) (- (point) arg)))
3488 (defcustom backward-delete-char-untabify-method 'untabify
3489 "The method for untabifying when deleting backward.
3490 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3491 `hungry' -- delete all whitespace, both tabs and spaces;
3492 `all' -- delete all whitespace, including tabs, spaces and newlines;
3493 nil -- just delete one character."
3494 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3495 :version "20.3"
3496 :group 'killing)
3498 (defun backward-delete-char-untabify (arg &optional killp)
3499 "Delete characters backward, changing tabs into spaces.
3500 The exact behavior depends on `backward-delete-char-untabify-method'.
3501 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3502 Interactively, ARG is the prefix arg (default 1)
3503 and KILLP is t if a prefix arg was specified."
3505 (when (eq backward-delete-char-untabify-method 'untabify)
3506 (let ((count arg))
3507 (save-excursion
3508 (while (and (> count 0) (not (bobp)))
3510 (let ((col (current-column)))
3511 (forward-char -1)
3512 (setq col (- col (current-column)))
3513 (insert-char ?\s col)
3514 (delete-char 1)))
3515 (forward-char -1)
3516 (setq count (1- count))))))
3518 ((eq backward-delete-char-untabify-method 'all)
3520 (n (if skip
3521 (let* ((oldpt (point))
3522 (wh (- oldpt (save-excursion
3523 (skip-chars-backward skip)
3524 (constrain-to-field nil oldpt)))))
3525 (+ arg (if (zerop wh) 0 (1- wh))))
3526 arg)))
3527 ;; Avoid warning about delete-backward-char
3528 (with-no-warnings (delete-backward-char n killp))))
3530 (defun zap-to-char (arg char)
3531 "Kill up to and including ARGth occurrence of CHAR.
3532 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3533 Goes backward if ARG is negative; error if CHAR not found."
3534 (interactive (list (prefix-numeric-value current-prefix-arg)
3535 (read-char "Zap to char: " t)))
3536 ;; Avoid "obsolete" warnings for translation-table-for-input.
3537 (with-no-warnings
3538 (if (char-table-p translation-table-for-input)
3539 (setq char (or (aref translation-table-for-input char) char))))
3540 (kill-region (point) (progn
3541 (search-forward (char-to-string char) nil nil arg)
3542 (point))))
3544 ;; kill-line and its subroutines.
3546 (defcustom kill-whole-line nil
3547 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3548 :type 'boolean
3549 :group 'killing)
3551 (defun kill-line (&optional arg)
3552 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3553 With prefix argument ARG, kill that many lines from point.
3554 Negative arguments kill lines backward.
3555 With zero argument, kills the text before point on the current line.
3558 a number counts as a prefix arg.
3560 To kill a whole line, when point is not at the beginning, type \
3563 If `show-trailing-whitespace' is non-nil, this command will just
3564 kill the rest of the current line, even if there are only
3565 nonblanks there.
3567 If `kill-whole-line' is non-nil, then this command kills the whole line
3568 including its terminating newline, when used at the beginning of a line
3569 with no argument. As a consequence, you can always kill a whole line
3572 If you want to append the killed line to the last killed text,
3575 If the buffer is read-only, Emacs will beep and refrain from deleting
3576 the line, but put the line in the kill ring anyway. This means that
3577 you can use this command to copy text from a read-only buffer.
3578 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3579 even beep.)"
3580 (interactive "P")
3581 (kill-region (point)
3582 ;; It is better to move point to the other end of the kill
3583 ;; before killing. That way, in a read-only buffer, point
3584 ;; moves across the text that is copied to the kill ring.
3585 ;; The choice has no effect on undo now that undo records
3586 ;; the value of point from before the command was run.
3587 (progn
3588 (if arg
3589 (forward-visible-line (prefix-numeric-value arg))
3590 (if (eobp)
3591 (signal 'end-of-buffer nil))
3592 (let ((end
3593 (save-excursion
3594 (end-of-visible-line) (point))))
3595 (if (or (save-excursion
3596 ;; If trailing whitespace is visible,
3597 ;; don't treat it as nothing.
3598 (unless show-trailing-whitespace
3600 (= (point) end))
3601 (and kill-whole-line (bolp)))
3602 (forward-visible-line 1)
3603 (goto-char end))))
3604 (point))))
3606 (defun kill-whole-line (&optional arg)
3607 "Kill current line.
3608 With prefix ARG, kill that many lines starting from the current line.
3609 If ARG is negative, kill backward. Also kill the preceding newline.
3611 If ARG is zero, kill current line but exclude the trailing newline."
3612 (interactive "p")
3613 (or arg (setq arg 1))
3614 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3615 (signal 'end-of-buffer nil))
3616 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3617 (signal 'beginning-of-buffer nil))
3618 (unless (eq last-command 'kill-region)
3619 (kill-new "")
3620 (setq last-command 'kill-region))
3621 (cond ((zerop arg)
3622 ;; We need to kill in two steps, because the previous command
3623 ;; could have been a kill command, in which case the text
3624 ;; before point needs to be prepended to the current kill
3625 ;; ring entry and the text after point appended. Also, we
3626 ;; need to use save-excursion to avoid copying the same text
3627 ;; twice to the kill ring in read-only buffers.
3628 (save-excursion
3629 (kill-region (point) (progn (forward-visible-line 0) (point))))
3630 (kill-region (point) (progn (end-of-visible-line) (point))))
3631 ((< arg 0)
3632 (save-excursion
3633 (kill-region (point) (progn (end-of-visible-line) (point))))
3634 (kill-region (point)
3635 (progn (forward-visible-line (1+ arg))
3636 (unless (bobp) (backward-char))
3637 (point))))
3638 (t
3639 (save-excursion
3640 (kill-region (point) (progn (forward-visible-line 0) (point))))
3641 (kill-region (point)
3642 (progn (forward-visible-line arg) (point))))))
3644 (defun forward-visible-line (arg)
3645 "Move forward by ARG lines, ignoring currently invisible newlines only.
3646 If ARG is negative, move backward -ARG lines.
3647 If ARG is zero, move to the beginning of the current line."
3648 (condition-case nil
3649 (if (> arg 0)
3650 (progn
3651 (while (> arg 0)
3652 (or (zerop (forward-line 1))
3653 (signal 'end-of-buffer nil))
3654 ;; If the newline we just skipped is invisible,
3655 ;; don't count it.
3656 (let ((prop
3657 (get-char-property (1- (point)) 'invisible)))
3658 (if (if (eq buffer-invisibility-spec t)
3659 prop
3660 (or (memq prop buffer-invisibility-spec)
3661 (assq prop buffer-invisibility-spec)))
3662 (setq arg (1+ arg))))
3663 (setq arg (1- arg)))
3664 ;; If invisible text follows, and it is a number of complete lines,
3665 ;; skip it.
3666 (let ((opoint (point)))
3667 (while (and (not (eobp))
3668 (let ((prop
3669 (get-char-property (point) 'invisible)))
3670 (if (eq buffer-invisibility-spec t)
3671 prop
3672 (or (memq prop buffer-invisibility-spec)
3673 (assq prop buffer-invisibility-spec)))))
3674 (goto-char
3675 (if (get-text-property (point) 'invisible)
3676 (or (next-single-property-change (point) 'invisible)
3677 (point-max))
3678 (next-overlay-change (point)))))
3679 (unless (bolp)
3680 (goto-char opoint))))
3681 (let ((first t))
3682 (while (or first (<= arg 0))
3683 (if first
3684 (beginning-of-line)
3685 (or (zerop (forward-line -1))
3686 (signal 'beginning-of-buffer nil)))
3687 ;; If the newline we just moved to is invisible,
3688 ;; don't count it.
3689 (unless (bobp)
3690 (let ((prop
3691 (get-char-property (1- (point)) 'invisible)))
3692 (unless (if (eq buffer-invisibility-spec t)
3693 prop
3694 (or (memq prop buffer-invisibility-spec)
3695 (assq prop buffer-invisibility-spec)))
3696 (setq arg (1+ arg)))))
3697 (setq first nil))
3698 ;; If invisible text follows, and it is a number of complete lines,
3699 ;; skip it.
3700 (let ((opoint (point)))
3701 (while (and (not (bobp))
3702 (let ((prop
3703 (get-char-property (1- (point)) 'invisible)))
3704 (if (eq buffer-invisibility-spec t)
3705 prop
3706 (or (memq prop buffer-invisibility-spec)
3707 (assq prop buffer-invisibility-spec)))))
3708 (goto-char
3709 (if (get-text-property (1- (point)) 'invisible)
3710 (or (previous-single-property-change (point) 'invisible)
3711 (point-min))
3712 (previous-overlay-change (point)))))
3713 (unless (bolp)
3714 (goto-char opoint)))))
3715 ((beginning-of-buffer end-of-buffer)
3716 nil)))
3718 (defun end-of-visible-line ()
3719 "Move to end of current visible line."
3720 (end-of-line)
3721 ;; If the following character is currently invisible,
3722 ;; skip all characters with that same `invisible' property value,
3723 ;; then find the next newline.
3724 (while (and (not (eobp))
3725 (save-excursion
3727 (let ((prop
3728 (get-char-property (point) 'invisible)))
3729 (if (eq buffer-invisibility-spec t)
3730 prop
3731 (or (memq prop buffer-invisibility-spec)
3732 (assq prop buffer-invisibility-spec))))))
3734 (if (get-text-property (point) 'invisible)
3735 (goto-char (or (next-single-property-change (point) 'invisible)
3736 (point-max)))
3737 (goto-char (next-overlay-change (point))))
3738 (end-of-line)))
3739 \f
3740 (defun insert-buffer (buffer)
3741 "Insert after point the contents of BUFFER.
3742 Puts mark after the inserted text.
3743 BUFFER may be a buffer or a buffer name.
3745 This function is meant for the user to run interactively.
3746 Don't call it from programs: use `insert-buffer-substring' instead!"
3747 (interactive
3748 (list
3749 (progn
3750 (barf-if-buffer-read-only)
3751 (read-buffer "Insert buffer: "
3752 (if (eq (selected-window) (next-window (selected-window)))
3753 (other-buffer (current-buffer))
3754 (window-buffer (next-window (selected-window))))
3755 t))))
3756 (push-mark
3757 (save-excursion
3758 (insert-buffer-substring (get-buffer buffer))
3759 (point)))
3760 nil)
3762 (defun append-to-buffer (buffer start end)
3763 "Append to specified buffer the text of the region.
3764 It is inserted into that buffer before its point.
3766 When calling from a program, give three arguments:
3767 BUFFER (or buffer name), START and END.
3768 START and END specify the portion of the current buffer to be copied."
3769 (interactive
3770 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3771 (region-beginning) (region-end)))
3772 (let* ((oldbuf (current-buffer))
3773 (append-to (get-buffer-create buffer))
3774 (windows (get-buffer-window-list append-to t t))
3775 point)
3776 (save-excursion
3777 (with-current-buffer append-to
3778 (setq point (point))
3779 (barf-if-buffer-read-only)
3780 (insert-buffer-substring oldbuf start end)
3781 (dolist (window windows)
3782 (when (= (window-point window) point)
3783 (set-window-point window (point))))))))
3785 (defun prepend-to-buffer (buffer start end)
3786 "Prepend to specified buffer the text of the region.
3787 It is inserted into that buffer after its point.
3789 When calling from a program, give three arguments:
3790 BUFFER (or buffer name), START and END.
3791 START and END specify the portion of the current buffer to be copied."
3793 (let ((oldbuf (current-buffer)))
3794 (with-current-buffer (get-buffer-create buffer)
3795 (barf-if-buffer-read-only)
3796 (save-excursion
3797 (insert-buffer-substring oldbuf start end)))))
3799 (defun copy-to-buffer (buffer start end)
3800 "Copy to specified buffer the text of the region.
3801 It is inserted into that buffer, replacing existing text there.
3803 When calling from a program, give three arguments:
3804 BUFFER (or buffer name), START and END.
3805 START and END specify the portion of the current buffer to be copied."
3807 (let ((oldbuf (current-buffer)))
3808 (with-current-buffer (get-buffer-create buffer)
3809 (barf-if-buffer-read-only)
3810 (erase-buffer)
3811 (save-excursion
3812 (insert-buffer-substring oldbuf start end)))))
3813 \f
3814 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3815 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3817 (defvar activate-mark-hook nil
3818 "Hook run when the mark becomes active.
3819 It is also run at the end of a command, if the mark is active and
3820 it is possible that the region may have changed.")
3822 (defvar deactivate-mark-hook nil
3823 "Hook run when the mark becomes inactive.")
3825 (defun mark (&optional force)
3826 "Return this buffer's mark value as integer, or nil if never set.
3828 In Transient Mark mode, this function signals an error if
3829 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3830 or the argument FORCE is non-nil, it disregards whether the mark
3831 is active, and returns an integer or nil in the usual way.
3833 If you are using this in an editing command, you are most likely making
3834 a mistake; see the documentation of `set-mark'."
3835 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3836 (marker-position (mark-marker))
3837 (signal 'mark-inactive nil)))
3839 (defsubst deactivate-mark (&optional force)
3840 "Deactivate the mark.
3841 If Transient Mark mode is disabled, this function normally does
3842 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3844 Deactivating the mark sets `mark-active' to nil, updates the
3845 primary selection according to `select-active-regions', and runs
3846 `deactivate-mark-hook'.
3848 If Transient Mark mode was temporarily enabled, reset the value
3849 of the variable `transient-mark-mode'; if this causes Transient
3850 Mark mode to be disabled, don't change `mark-active' to nil or
3851 run `deactivate-mark-hook'."
3852 (when (or transient-mark-mode force)
3853 (when (and (if (eq select-active-regions 'only)
3854 (eq (car-safe transient-mark-mode) 'only)
3855 select-active-regions)
3856 (region-active-p)
3857 (display-selections-p))
3858 ;; The var `saved-region-selection', if non-nil, is the text in
3859 ;; the region prior to the last command modifying the buffer.
3860 ;; Set the selection to that, or to the current region.
3861 (cond (saved-region-selection
3862 (x-set-selection 'PRIMARY saved-region-selection)
3863 (setq saved-region-selection nil))
3864 ;; If another program has acquired the selection, region
3865 ;; deactivation should not clobber it (Bug#11772).
3866 ((and (/= (region-beginning) (region-end))
3867 (or (x-selection-owner-p 'PRIMARY)
3868 (null (x-selection-exists-p 'PRIMARY))))
3869 (x-set-selection 'PRIMARY
3870 (buffer-substring-no-properties
3871 (region-beginning)
3872 (region-end))))))
3873 (if (and (null force)
3874 (or (eq transient-mark-mode 'lambda)
3875 (and (eq (car-safe transient-mark-mode) 'only)
3876 (null (cdr transient-mark-mode)))))
3877 ;; When deactivating a temporary region, don't change
3878 ;; `mark-active' or run `deactivate-mark-hook'.
3879 (setq transient-mark-mode nil)
3880 (if (eq (car-safe transient-mark-mode) 'only)
3881 (setq transient-mark-mode (cdr transient-mark-mode)))
3882 (setq mark-active nil)
3883 (run-hooks 'deactivate-mark-hook))))
3885 (defun activate-mark ()
3886 "Activate the mark."
3887 (when (mark t)
3888 (setq mark-active t)
3889 (unless transient-mark-mode
3890 (setq transient-mark-mode 'lambda))))
3892 (defun set-mark (pos)
3893 "Set this buffer's mark to POS. Don't use this function!
3894 That is to say, don't use this function unless you want
3895 the user to see that the mark has moved, and you want the previous
3896 mark position to be lost.
3898 Normally, when a new mark is set, the old one should go on the stack.
3899 This is why most applications should use `push-mark', not `set-mark'.
3901 Novice Emacs Lisp programmers often try to use the mark for the wrong
3902 purposes. The mark saves a location for the user's convenience.
3903 Most editing commands should not alter the mark.
3904 To remember a location for internal use in the Lisp program,
3905 store it in a Lisp variable. Example:
3907 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3909 (if pos
3910 (progn
3911 (setq mark-active t)
3912 (run-hooks 'activate-mark-hook)
3913 (set-marker (mark-marker) pos (current-buffer)))
3914 ;; Normally we never clear mark-active except in Transient Mark mode.
3915 ;; But when we actually clear out the mark value too, we must
3916 ;; clear mark-active in any mode.
3917 (deactivate-mark t)
3918 (set-marker (mark-marker) nil)))
3920 (defcustom use-empty-active-region nil
3922 If nil, region-aware commands treat empty regions as inactive.
3923 If non-nil, region-aware commands treat the region as active as
3924 long as the mark is active, even if the region is empty.
3926 Region-aware commands are those that act on the region if it is
3927 active and Transient Mark mode is enabled, and on the text near
3928 point otherwise."
3929 :type 'boolean
3930 :version "23.1"
3931 :group 'editing-basics)
3933 (defun use-region-p ()
3934 "Return t if the region is active and it is appropriate to act on it.
3935 This is used by commands that act specially on the region under
3936 Transient Mark mode.
3938 The return value is t if Transient Mark mode is enabled and the
3939 mark is active; furthermore, if `use-empty-active-region' is nil,
3940 the region must not be empty. Otherwise, the return value is nil.
3942 For some commands, it may be appropriate to ignore the value of
3943 `use-empty-active-region'; in that case, use `region-active-p'."
3944 (and (region-active-p)
3945 (or use-empty-active-region (> (region-end) (region-beginning)))))
3947 (defun region-active-p ()
3948 "Return t if Transient Mark mode is enabled and the mark is active.
3950 Some commands act specially on the region when Transient Mark
3951 mode is enabled. Usually, such commands should use
3952 `use-region-p' instead of this function, because `use-region-p'
3953 also checks the value of `use-empty-active-region'."
3954 (and transient-mark-mode mark-active))
3956 (defvar mark-ring nil
3957 "The list of former marks of the current buffer, most recent first.")
3958 (make-variable-buffer-local 'mark-ring)
3959 (put 'mark-ring 'permanent-local t)
3961 (defcustom mark-ring-max 16
3962 "Maximum size of mark ring. Start discarding off end if gets this big."
3963 :type 'integer
3964 :group 'editing-basics)
3966 (defvar global-mark-ring nil
3967 "The list of saved global marks, most recent first.")
3969 (defcustom global-mark-ring-max 16
3970 "Maximum size of global mark ring. \
3971 Start discarding off end if gets this big."
3972 :type 'integer
3973 :group 'editing-basics)
3975 (defun pop-to-mark-command ()
3976 "Jump to mark, and pop a new position for mark off the ring.
3977 \(Does not affect global mark ring\)."
3978 (interactive)
3979 (if (null (mark t))
3980 (error "No mark set in this buffer")
3981 (if (= (point) (mark t))
3982 (message "Mark popped"))
3983 (goto-char (mark t))
3984 (pop-mark)))
3986 (defun push-mark-command (arg &optional nomsg)
3987 "Set mark at where point is.
3988 If no prefix ARG and mark is already set there, just activate it.
3989 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3990 (interactive "P")
3991 (let ((mark (marker-position (mark-marker))))
3992 (if (or arg (null mark) (/= mark (point)))
3993 (push-mark nil nomsg t)
3994 (setq mark-active t)
3995 (run-hooks 'activate-mark-hook)
3996 (unless nomsg
3997 (message "Mark activated")))))
3999 (defcustom set-mark-command-repeat-pop nil
4002 will pop the mark twice, and
4004 will pop the mark three times.
4008 :type 'boolean
4009 :group 'editing-basics)
4011 (defcustom set-mark-default-inactive nil
4012 "If non-nil, setting the mark does not activate it.
4014 behave the same whether or not `transient-mark-mode' is enabled."
4015 :type 'boolean
4016 :group 'editing-basics
4017 :version "23.1")
4019 (defun set-mark-command (arg)
4020 "Set the mark where point is, or jump to the mark.
4021 Setting the mark also alters the region, which is the text
4022 between point and mark; this is the closest equivalent in
4025 With no prefix argument, set the mark at point, and push the
4026 old mark position on local mark ring. Also push the old mark on
4027 global mark ring, if the previous mark was set in another buffer.
4029 When Transient Mark Mode is off, immediately repeating this
4030 command activates `transient-mark-mode' temporarily.
4033 jump to the mark, and set the mark from
4034 position popped off the local mark ring \(this does not affect the global
4036 mark ring \(see `pop-global-mark'\).
4038 If `set-mark-command-repeat-pop' is non-nil, repeating
4040 off the local (or global) mark ring and jumps there.
4043 argument, unconditionally set mark where point is, even if
4044 `set-mark-command-repeat-pop' is non-nil.
4046 Novice Emacs Lisp programmers often try to use the mark for the wrong
4047 purposes. See the documentation of `set-mark' for more information."
4048 (interactive "P")
4049 (cond ((eq transient-mark-mode 'lambda)
4050 (setq transient-mark-mode nil))
4051 ((eq (car-safe transient-mark-mode) 'only)
4052 (deactivate-mark)))
4053 (cond
4054 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4055 (push-mark-command nil))
4056 ((not (eq this-command 'set-mark-command))
4057 (if arg
4058 (pop-to-mark-command)
4059 (push-mark-command t)))
4060 ((and set-mark-command-repeat-pop
4061 (eq last-command 'pop-to-mark-command))
4062 (setq this-command 'pop-to-mark-command)
4063 (pop-to-mark-command))
4064 ((and set-mark-command-repeat-pop
4065 (eq last-command 'pop-global-mark)
4066 (not arg))
4067 (setq this-command 'pop-global-mark)
4068 (pop-global-mark))
4069 (arg
4070 (setq this-command 'pop-to-mark-command)
4071 (pop-to-mark-command))
4072 ((eq last-command 'set-mark-command)
4073 (if (region-active-p)
4074 (progn
4075 (deactivate-mark)
4076 (message "Mark deactivated"))
4077 (activate-mark)
4078 (message "Mark activated")))
4079 (t
4080 (push-mark-command nil)
4081 (if set-mark-default-inactive (deactivate-mark)))))
4083 (defun push-mark (&optional location nomsg activate)
4084 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4085 If the last global mark pushed was not in the current buffer,
4086 also push LOCATION on the global mark ring.
4087 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4089 Novice Emacs Lisp programmers often try to use the mark for the wrong
4090 purposes. See the documentation of `set-mark' for more information.
4092 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4093 (unless (null (mark t))
4094 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4095 (when (> (length mark-ring) mark-ring-max)
4096 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4097 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4098 (set-marker (mark-marker) (or location (point)) (current-buffer))
4099 ;; Now push the mark on the global mark ring.
4100 (if (and global-mark-ring
4101 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4102 ;; The last global mark pushed was in this same buffer.
4103 ;; Don't push another one.
4104 nil
4105 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4106 (when (> (length global-mark-ring) global-mark-ring-max)
4107 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4108 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4109 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4110 (message "Mark set"))
4111 (if (or activate (not transient-mark-mode))
4112 (set-mark (mark t)))
4113 nil)
4115 (defun pop-mark ()
4116 "Pop off mark ring into the buffer's actual mark.
4117 Does not set point. Does nothing if mark ring is empty."
4118 (when mark-ring
4119 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4120 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4121 (move-marker (car mark-ring) nil)
4122 (if (null (mark t)) (ding))
4123 (setq mark-ring (cdr mark-ring)))
4124 (deactivate-mark))
4126 (define-obsolete-function-alias
4127 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4128 (defun exchange-point-and-mark (&optional arg)
4129 "Put the mark where point is now, and point where the mark is now.
4130 This command works even when the mark is not active,
4131 and it reactivates the mark.
4133 If Transient Mark mode is on, a prefix ARG deactivates the mark
4134 if it is active, and otherwise avoids reactivating it. If
4135 Transient Mark mode is off, a prefix ARG enables Transient Mark
4136 mode temporarily."
4137 (interactive "P")
4138 (let ((omark (mark t))
4139 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4140 (if (null omark)
4141 (error "No mark set in this buffer"))
4142 (deactivate-mark)
4143 (set-mark (point))
4144 (goto-char omark)
4145 (if set-mark-default-inactive (deactivate-mark))
4146 (cond (temp-highlight
4147 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4148 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4149 (not (or arg (region-active-p))))
4150 (deactivate-mark))
4151 (t (activate-mark)))
4152 nil))
4154 (defcustom shift-select-mode t
4155 "When non-nil, shifted motion keys activate the mark momentarily.
4157 While the mark is activated in this way, any shift-translated point
4158 motion key extends the region, and if Transient Mark mode was off, it
4159 is temporarily turned on. Furthermore, the mark will be deactivated
4160 by any subsequent point motion key that was not shift-translated, or
4161 by any action that normally deactivates the mark in Transient Mark mode.
4163 See `this-command-keys-shift-translated' for the meaning of
4164 shift-translation."
4165 :type 'boolean
4166 :group 'editing-basics)
4168 (defun handle-shift-selection ()
4169 "Activate/deactivate mark depending on invocation thru shift translation.
4170 This function is called by `call-interactively' when a command
4171 with a `^' character in its `interactive' spec is invoked, before
4172 running the command itself.
4174 If `shift-select-mode' is enabled and the command was invoked
4175 through shift translation, set the mark and activate the region
4176 temporarily, unless it was already set in this way. See
4177 `this-command-keys-shift-translated' for the meaning of shift
4178 translation.
4180 Otherwise, if the region has been activated temporarily,
4181 deactivate it, and restore the variable `transient-mark-mode' to
4182 its earlier value."
4183 (cond ((and shift-select-mode this-command-keys-shift-translated)
4184 (unless (and mark-active
4185 (eq (car-safe transient-mark-mode) 'only))
4186 (setq transient-mark-mode
4187 (cons 'only
4188 (unless (eq transient-mark-mode 'lambda)
4189 transient-mark-mode)))
4190 (push-mark nil nil t)))
4191 ((eq (car-safe transient-mark-mode) 'only)
4192 (setq transient-mark-mode (cdr transient-mark-mode))
4193 (deactivate-mark))))
4195 (define-minor-mode transient-mark-mode
4196 "Toggle Transient Mark mode.
4197 With a prefix argument ARG, enable Transient Mark mode if ARG is
4198 positive, and disable it otherwise. If called from Lisp, enable
4199 Transient Mark mode if ARG is omitted or nil.
4201 Transient Mark mode is a global minor mode. When enabled, the
4202 region is highlighted whenever the mark is active. The mark is
4204 operations that set the mark but whose main purpose is something
4210 Many commands change their behavior when Transient Mark mode is in effect
4211 and the mark is active, by acting on the region instead of their usual
4212 default part of the buffer's text. Examples of such commands include
4217 commands which are sensitive to the Transient Mark mode."
4218 :global t
4219 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4220 :variable transient-mark-mode)
4222 (defvar widen-automatically t
4223 "Non-nil means it is ok for commands to call `widen' when they want to.
4224 Some commands will do this in order to go to positions outside
4225 the current accessible part of the buffer.
4227 If `widen-automatically' is nil, these commands will do something else
4228 as a fallback, and won't change the buffer bounds.")
4230 (defvar non-essential nil
4231 "Whether the currently executing code is performing an essential task.
4232 This variable should be non-nil only when running code which should not
4233 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4234 user for a password when we are simply scanning a set of files in the
4235 background or displaying possible completions before the user even asked
4236 for it.")
4238 (defun pop-global-mark ()
4239 "Pop off global mark ring and jump to the top location."
4240 (interactive)
4241 ;; Pop entries which refer to non-existent buffers.
4242 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4243 (setq global-mark-ring (cdr global-mark-ring)))
4244 (or global-mark-ring
4245 (error "No global mark set"))
4246 (let* ((marker (car global-mark-ring))
4247 (buffer (marker-buffer marker))
4248 (position (marker-position marker)))
4249 (setq global-mark-ring (nconc (cdr global-mark-ring)
4250 (list (car global-mark-ring))))
4251 (set-buffer buffer)
4252 (or (and (>= position (point-min))
4253 (<= position (point-max)))
4254 (if widen-automatically
4255 (widen)
4256 (error "Global mark position is outside accessible part of buffer")))
4257 (goto-char position)
4258 (switch-to-buffer buffer)))
4259 \f
4260 (defcustom next-line-add-newlines nil
4261 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4262 :type 'boolean
4263 :version "21.1"
4264 :group 'editing-basics)
4266 (defun next-line (&optional arg try-vscroll)
4267 "Move cursor vertically down ARG lines.
4268 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4269 If there is no character in the target line exactly under the current column,
4270 the cursor is positioned after the character in that line which spans this
4271 column, or at the end of the line if it is not long enough.
4272 If there is no line in the buffer after this one, behavior depends on the
4273 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4274 to create a line, and moves the cursor to that line. Otherwise it moves the
4275 cursor to the end of the buffer.
4277 If the variable `line-move-visual' is non-nil, this command moves
4278 by display lines. Otherwise, it moves by buffer lines, without
4279 taking variable-width characters or continued lines into account.
4282 a semipermanent goal column for this command.
4283 Then instead of trying to move exactly vertically (or as close as possible),
4284 this command moves to the specified goal column (or as close as possible).
4285 The goal column is stored in the variable `goal-column', which is nil
4286 when there is no goal column. Note that setting `goal-column'
4287 overrides `line-move-visual' and causes this command to move by buffer
4288 lines rather than by display lines.
4290 If you are thinking of using this in a Lisp program, consider
4291 using `forward-line' instead. It is usually easier to use
4292 and more reliable (no dependence on goal column, etc.)."
4294 (or arg (setq arg 1))
4295 (if (and next-line-add-newlines (= arg 1))
4296 (if (save-excursion (end-of-line) (eobp))
4297 ;; When adding a newline, don't expand an abbrev.
4298 (let ((abbrev-mode nil))
4299 (end-of-line)
4301 (line-move arg nil nil try-vscroll))
4302 (if (called-interactively-p 'interactive)
4303 (condition-case err
4304 (line-move arg nil nil try-vscroll)
4305 ((beginning-of-buffer end-of-buffer)
4306 (signal (car err) (cdr err))))
4307 (line-move arg nil nil try-vscroll)))
4308 nil)
4310 (defun previous-line (&optional arg try-vscroll)
4311 "Move cursor vertically up ARG lines.
4312 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4313 If there is no character in the target line exactly over the current column,
4314 the cursor is positioned after the character in that line which spans this
4315 column, or at the end of the line if it is not long enough.
4317 If the variable `line-move-visual' is non-nil, this command moves
4318 by display lines. Otherwise, it moves by buffer lines, without
4319 taking variable-width characters or continued lines into account.
4322 a semipermanent goal column for this command.
4323 Then instead of trying to move exactly vertically (or as close as possible),
4324 this command moves to the specified goal column (or as close as possible).
4325 The goal column is stored in the variable `goal-column', which is nil
4326 when there is no goal column. Note that setting `goal-column'
4327 overrides `line-move-visual' and causes this command to move by buffer
4328 lines rather than by display lines.
4330 If you are thinking of using this in a Lisp program, consider using
4331 `forward-line' with a negative argument instead. It is usually easier
4332 to use and more reliable (no dependence on goal column, etc.)."
4334 (or arg (setq arg 1))
4335 (if (called-interactively-p 'interactive)
4336 (condition-case err
4337 (line-move (- arg) nil nil try-vscroll)
4338 ((beginning-of-buffer end-of-buffer)
4339 (signal (car err) (cdr err))))
4340 (line-move (- arg) nil nil try-vscroll))
4341 nil)
4343 (defcustom track-eol nil
4344 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4345 This means moving to the end of each line moved onto.
4346 The beginning of a blank line does not count as the end of a line.
4347 This has no effect when `line-move-visual' is non-nil."
4348 :type 'boolean
4349 :group 'editing-basics)
4351 (defcustom goal-column nil
4353 A non-nil setting overrides `line-move-visual', which see."
4354 :type '(choice integer
4355 (const :tag "None" nil))
4356 :group 'editing-basics)
4357 (make-variable-buffer-local 'goal-column)
4359 (defvar temporary-goal-column 0
4360 "Current goal column for vertical motion.
4361 It is the column where point was at the start of the current run
4362 of vertical motion commands.
4364 When moving by visual lines via `line-move-visual', it is a cons
4365 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4366 divided by the default column width, and HSCROLL is the number of
4367 columns by which window is scrolled from left margin.
4369 When the `track-eol' feature is doing its job, the value is
4370 `most-positive-fixnum'.")
4372 (defcustom line-move-ignore-invisible t
4374 Outline mode sets this."
4375 :type 'boolean
4376 :group 'editing-basics)
4378 (defcustom line-move-visual t
4379 "When non-nil, `line-move' moves point by visual lines.
4380 This movement is based on where the cursor is displayed on the
4381 screen, instead of relying on buffer contents alone. It takes
4382 into account variable-width characters and line continuation.
4383 If nil, `line-move' moves point by logical lines.
4384 A non-nil setting of `goal-column' overrides the value of this variable
4385 and forces movement by logical lines.
4386 A window that is horizontally scrolled also forces movement by logical
4387 lines."
4388 :type 'boolean
4389 :group 'editing-basics
4390 :version "23.1")
4392 ;; Returns non-nil if partial move was done.
4393 (defun line-move-partial (arg noerror to-end)
4394 (if (< arg 0)
4395 ;; Move backward (up).
4396 ;; If already vscrolled, reduce vscroll
4397 (let ((vs (window-vscroll nil t)))
4398 (when (> vs (frame-char-height))
4399 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4401 ;; Move forward (down).
4402 (let* ((lh (window-line-height -1))
4403 (vpos (nth 1 lh))
4404 (ypos (nth 2 lh))
4405 (rbot (nth 3 lh))
4406 py vs)
4407 (when (or (null lh)
4408 (>= rbot (frame-char-height))
4409 (<= ypos (- (frame-char-height))))
4410 (unless lh
4411 (let ((wend (pos-visible-in-window-p t nil t)))
4412 (setq rbot (nth 3 wend)
4413 vpos (nth 5 wend))))
4414 (cond
4415 ;; If last line of window is fully visible, move forward.
4416 ((or (null rbot) (= rbot 0))
4417 nil)
4418 ;; If cursor is not in the bottom scroll margin, move forward.
4419 ((and (> vpos 0)
4420 (< (setq py
4421 (or (nth 1 (window-line-height))
4422 (let ((ppos (posn-at-point)))
4423 (cdr (or (posn-actual-col-row ppos)
4424 (posn-col-row ppos))))))
4425 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4426 nil)
4427 ;; When already vscrolled, we vscroll some more if we can,
4428 ;; or clear vscroll and move forward at end of tall image.
4429 ((> (setq vs (window-vscroll nil t)) 0)
4430 (when (> rbot 0)
4431 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4432 ;; If cursor just entered the bottom scroll margin, move forward,
4433 ;; but also vscroll one line so redisplay won't recenter.
4434 ((and (> vpos 0)
4435 (= py (min (- (window-text-height) scroll-margin 1)
4436 (1- vpos))))
4437 (set-window-vscroll nil (frame-char-height) t)
4438 (line-move-1 arg noerror to-end)
4439 t)
4440 ;; If there are lines above the last line, scroll-up one line.
4441 ((> vpos 0)
4442 (scroll-up 1)
4443 t)
4444 ;; Finally, start vscroll.
4445 (t
4446 (set-window-vscroll nil (frame-char-height) t)))))))
4449 ;; This is like line-move-1 except that it also performs
4450 ;; vertical scrolling of tall images if appropriate.
4451 ;; That is not really a clean thing to do, since it mixes
4452 ;; scrolling with cursor motion. But so far we don't have
4453 ;; a cleaner solution to the problem of making C-n do something
4454 ;; useful given a tall image.
4455 (defun line-move (arg &optional noerror to-end try-vscroll)
4456 (if noninteractive
4457 (forward-line arg)
4458 (unless (and auto-window-vscroll try-vscroll
4459 ;; Only vscroll for single line moves
4460 (= (abs arg) 1)
4461 ;; But don't vscroll in a keyboard macro.
4462 (not defining-kbd-macro)
4463 (not executing-kbd-macro)
4464 (line-move-partial arg noerror to-end))
4465 (set-window-vscroll nil 0 t)
4466 (if (and line-move-visual
4467 ;; Display-based column are incompatible with goal-column.
4468 (not goal-column)
4469 ;; When the text in the window is scrolled to the left,
4470 ;; display-based motion doesn't make sense (because each
4471 ;; logical line occupies exactly one screen line).
4472 (not (> (window-hscroll) 0)))
4473 (line-move-visual arg noerror)
4474 (line-move-1 arg noerror to-end)))))
4476 ;; Display-based alternative to line-move-1.
4477 ;; Arg says how many lines to move. The value is t if we can move the
4478 ;; specified number of lines.
4479 (defun line-move-visual (arg &optional noerror)
4480 (let ((opoint (point))
4481 (hscroll (window-hscroll))
4482 target-hscroll)
4483 ;; Check if the previous command was a line-motion command, or if
4484 ;; we were called from some other command.
4485 (if (and (consp temporary-goal-column)
4486 (memq last-command `(next-line previous-line ,this-command)))
4487 ;; If so, there's no need to reset `temporary-goal-column',
4488 ;; but we may need to hscroll.
4489 (if (or (/= (cdr temporary-goal-column) hscroll)
4490 (> (cdr temporary-goal-column) 0))
4491 (setq target-hscroll (cdr temporary-goal-column)))
4492 ;; Otherwise, we should reset `temporary-goal-column'.
4493 (let ((posn (posn-at-point)))
4494 (cond
4495 ;; Handle the `overflow-newline-into-fringe' case:
4496 ((eq (nth 1 posn) 'right-fringe)
4497 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4498 ((car (posn-x-y posn))
4499 (setq temporary-goal-column
4500 (cons (/ (float (car (posn-x-y posn)))
4501 (frame-char-width)) hscroll))))))
4502 (if target-hscroll
4503 (set-window-hscroll (selected-window) target-hscroll))
4504 (or (and (= (vertical-motion
4505 (cons (or goal-column
4506 (if (consp temporary-goal-column)
4507 (car temporary-goal-column)
4508 temporary-goal-column))
4509 arg))
4510 arg)
4511 (or (>= arg 0)
4512 (/= (point) opoint)
4513 ;; If the goal column lies on a display string,
4514 ;; `vertical-motion' advances the cursor to the end
4515 ;; of the string. For arg < 0, this can cause the
4516 ;; cursor to get stuck. (Bug#3020).
4517 (= (vertical-motion arg) arg)))
4518 (unless noerror
4519 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4520 nil)))))
4522 ;; This is the guts of next-line and previous-line.
4523 ;; Arg says how many lines to move.
4524 ;; The value is t if we can move the specified number of lines.
4525 (defun line-move-1 (arg &optional noerror _to-end)
4526 ;; Don't run any point-motion hooks, and disregard intangibility,
4527 ;; for intermediate positions.
4528 (let ((inhibit-point-motion-hooks t)
4529 (opoint (point))
4530 (orig-arg arg))
4531 (if (consp temporary-goal-column)
4532 (setq temporary-goal-column (+ (car temporary-goal-column)
4533 (cdr temporary-goal-column))))
4534 (unwind-protect
4535 (progn
4536 (if (not (memq last-command '(next-line previous-line)))
4537 (setq temporary-goal-column
4538 (if (and track-eol (eolp)
4539 ;; Don't count beg of empty line as end of line
4540 ;; unless we just did explicit end-of-line.
4541 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4542 most-positive-fixnum
4543 (current-column))))
4545 (if (not (or (integerp selective-display)
4546 line-move-ignore-invisible))
4547 ;; Use just newline characters.
4548 ;; Set ARG to 0 if we move as many lines as requested.
4549 (or (if (> arg 0)
4550 (progn (if (> arg 1) (forward-line (1- arg)))
4551 ;; This way of moving forward ARG lines
4552 ;; verifies that we have a newline after the last one.
4553 ;; It doesn't get confused by intangible text.
4554 (end-of-line)
4555 (if (zerop (forward-line 1))
4556 (setq arg 0)))
4557 (and (zerop (forward-line arg))
4558 (bolp)
4559 (setq arg 0)))
4560 (unless noerror
4561 (signal (if (< arg 0)
4562 'beginning-of-buffer
4563 'end-of-buffer)
4564 nil)))
4565 ;; Move by arg lines, but ignore invisible ones.
4566 (let (done)
4567 (while (and (> arg 0) (not done))
4568 ;; If the following character is currently invisible,
4569 ;; skip all characters with that same `invisible' property value.
4570 (while (and (not (eobp)) (invisible-p (point)))
4571 (goto-char (next-char-property-change (point))))
4572 ;; Move a line.
4573 ;; We don't use `end-of-line', since we want to escape
4574 ;; from field boundaries occurring exactly at point.
4575 (goto-char (constrain-to-field
4576 (let ((inhibit-field-text-motion t))
4577 (line-end-position))
4578 (point) t t
4579 'inhibit-line-move-field-capture))
4580 ;; If there's no invisibility here, move over the newline.
4581 (cond
4582 ((eobp)
4583 (if (not noerror)
4584 (signal 'end-of-buffer nil)
4585 (setq done t)))
4586 ((and (> arg 1) ;; Use vertical-motion for last move
4587 (not (integerp selective-display))
4588 (not (invisible-p (point))))
4589 ;; We avoid vertical-motion when possible
4590 ;; because that has to fontify.
4591 (forward-line 1))
4592 ;; Otherwise move a more sophisticated way.
4593 ((zerop (vertical-motion 1))
4594 (if (not noerror)
4595 (signal 'end-of-buffer nil)
4596 (setq done t))))
4597 (unless done
4598 (setq arg (1- arg))))
4599 ;; The logic of this is the same as the loop above,
4600 ;; it just goes in the other direction.
4601 (while (and (< arg 0) (not done))
4602 ;; For completely consistency with the forward-motion
4603 ;; case, we should call beginning-of-line here.
4604 ;; However, if point is inside a field and on a
4605 ;; continued line, the call to (vertical-motion -1)
4606 ;; below won't move us back far enough; then we return
4607 ;; to the same column in line-move-finish, and point
4608 ;; gets stuck -- cyd
4609 (forward-line 0)
4610 (cond
4611 ((bobp)
4612 (if (not noerror)
4613 (signal 'beginning-of-buffer nil)
4614 (setq done t)))
4615 ((and (< arg -1) ;; Use vertical-motion for last move
4616 (not (integerp selective-display))
4617 (not (invisible-p (1- (point)))))
4618 (forward-line -1))
4619 ((zerop (vertical-motion -1))
4620 (if (not noerror)
4621 (signal 'beginning-of-buffer nil)
4622 (setq done t))))
4623 (unless done
4624 (setq arg (1+ arg))
4625 (while (and ;; Don't move over previous invis lines
4626 ;; if our target is the middle of this line.
4627 (or (zerop (or goal-column temporary-goal-column))
4628 (< arg 0))
4629 (not (bobp)) (invisible-p (1- (point))))
4630 (goto-char (previous-char-property-change (point))))))))
4631 ;; This is the value the function returns.
4632 (= arg 0))
4634 (cond ((> arg 0)
4635 ;; If we did not move down as far as desired, at least go
4636 ;; to end of line. Be sure to call point-entered and
4637 ;; point-left-hooks.
4638 (let* ((npoint (prog1 (line-end-position)
4639 (goto-char opoint)))
4640 (inhibit-point-motion-hooks nil))
4641 (goto-char npoint)))
4642 ((< arg 0)
4643 ;; If we did not move up as far as desired,
4644 ;; at least go to beginning of line.
4645 (let* ((npoint (prog1 (line-beginning-position)
4646 (goto-char opoint)))
4647 (inhibit-point-motion-hooks nil))
4648 (goto-char npoint)))
4649 (t
4650 (line-move-finish (or goal-column temporary-goal-column)
4651 opoint (> orig-arg 0)))))))
4653 (defun line-move-finish (column opoint forward)
4654 (let ((repeat t))
4655 (while repeat
4656 ;; Set REPEAT to t to repeat the whole thing.
4657 (setq repeat nil)
4659 (let (new
4660 (old (point))
4661 (line-beg (line-beginning-position))
4662 (line-end
4663 ;; Compute the end of the line
4664 ;; ignoring effectively invisible newlines.
4665 (save-excursion
4666 ;; Like end-of-line but ignores fields.
4668 (while (and (not (eobp)) (invisible-p (point)))
4669 (goto-char (next-char-property-change (point)))
4671 (point))))
4673 ;; Move to the desired column.
4674 (line-move-to-column (truncate column))
4676 ;; Corner case: suppose we start out in a field boundary in
4677 ;; the middle of a continued line. When we get to
4678 ;; line-move-finish, point is at the start of a new *screen*
4679 ;; line but the same text line; then line-move-to-column would
4680 ;; move us backwards. Test using C-n with point on the "x" in
4681 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4682 (and forward
4683 (< (point) old)
4684 (goto-char old))
4686 (setq new (point))
4688 ;; Process intangibility within a line.
4689 ;; With inhibit-point-motion-hooks bound to nil, a call to
4690 ;; goto-char moves point past intangible text.
4692 ;; However, inhibit-point-motion-hooks controls both the
4693 ;; intangibility and the point-entered/point-left hooks. The
4694 ;; following hack avoids calling the point-* hooks
4695 ;; unnecessarily. Note that we move *forward* past intangible
4696 ;; text when the initial and final points are the same.
4697 (goto-char new)
4698 (let ((inhibit-point-motion-hooks nil))
4699 (goto-char new)
4701 ;; If intangibility moves us to a different (later) place
4702 ;; in the same line, use that as the destination.
4703 (if (<= (point) line-end)
4704 (setq new (point))
4705 ;; If that position is "too late",
4706 ;; try the previous allowable position.
4707 ;; See if it is ok.
4708 (backward-char)
4709 (if (if forward
4710 ;; If going forward, don't accept the previous
4711 ;; allowable position if it is before the target line.
4712 (< line-beg (point))
4713 ;; If going backward, don't accept the previous
4714 ;; allowable position if it is still after the target line.
4715 (<= (point) line-end))
4716 (setq new (point))
4717 ;; As a last resort, use the end of the line.
4718 (setq new line-end))))
4720 ;; Now move to the updated destination, processing fields
4721 ;; as well as intangibility.
4722 (goto-char opoint)
4723 (let ((inhibit-point-motion-hooks nil))
4724 (goto-char
4725 ;; Ignore field boundaries if the initial and final
4726 ;; positions have the same `field' property, even if the
4727 ;; fields are non-contiguous. This seems to be "nicer"
4728 ;; behavior in many situations.
4729 (if (eq (get-char-property new 'field)
4730 (get-char-property opoint 'field))
4731 new
4732 (constrain-to-field new opoint t t
4733 'inhibit-line-move-field-capture))))
4735 ;; If all this moved us to a different line,
4736 ;; retry everything within that new line.
4737 (when (or (< (point) line-beg) (> (point) line-end))
4738 ;; Repeat the intangibility and field processing.
4739 (setq repeat t))))))
4741 (defun line-move-to-column (col)
4742 "Try to find column COL, considering invisibility.
4743 This function works only in certain cases,
4744 because what we really need is for `move-to-column'
4745 and `current-column' to be able to ignore invisible text."
4746 (if (zerop col)
4747 (beginning-of-line)
4748 (move-to-column col))
4750 (when (and line-move-ignore-invisible
4751 (not (bolp)) (invisible-p (1- (point))))
4752 (let ((normal-location (point))
4753 (normal-column (current-column)))
4754 ;; If the following character is currently invisible,
4755 ;; skip all characters with that same `invisible' property value.
4756 (while (and (not (eobp))
4757 (invisible-p (point)))
4758 (goto-char (next-char-property-change (point))))
4759 ;; Have we advanced to a larger column position?
4760 (if (> (current-column) normal-column)
4761 ;; We have made some progress towards the desired column.
4762 ;; See if we can make any further progress.
4763 (line-move-to-column (+ (current-column) (- col normal-column)))
4764 ;; Otherwise, go to the place we originally found
4765 ;; and move back over invisible text.
4766 ;; that will get us to the same place on the screen
4767 ;; but with a more reasonable buffer position.
4768 (goto-char normal-location)
4769 (let ((line-beg (line-beginning-position)))
4770 (while (and (not (bolp)) (invisible-p (1- (point))))
4771 (goto-char (previous-char-property-change (point) line-beg))))))))
4773 (defun move-end-of-line (arg)
4774 "Move point to end of current line as displayed.
4775 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4776 If point reaches the beginning or end of buffer, it stops there.
4778 To ignore the effects of the `intangible' text or overlay
4779 property, bind `inhibit-point-motion-hooks' to t.
4780 If there is an image in the current line, this function
4781 disregards newlines that are part of the text on which the image
4782 rests."
4783 (interactive "^p")
4784 (or arg (setq arg 1))
4785 (let (done)
4786 (while (not done)
4787 (let ((newpos
4788 (save-excursion
4789 (let ((goal-column 0)
4790 (line-move-visual nil))
4791 (and (line-move arg t)
4792 ;; With bidi reordering, we may not be at bol,
4793 ;; so make sure we are.
4795 (not (bobp))
4796 (progn
4797 (while (and (not (bobp)) (invisible-p (1- (point))))
4798 (goto-char (previous-single-char-property-change
4799 (point) 'invisible)))
4800 (backward-char 1)))
4801 (point)))))
4802 (goto-char newpos)
4803 (if (and (> (point) newpos)
4805 (backward-char 1)
4806 (if (and (> (point) newpos) (not (eobp))
4808 ;; If we skipped something intangible and now we're not
4809 ;; really at eol, keep going.
4810 (setq arg 1)
4811 (setq done t)))))))
4813 (defun move-beginning-of-line (arg)
4814 "Move point to beginning of current line as displayed.
4815 \(If there's an image in the line, this disregards newlines
4816 which are part of the text that the image rests on.)
4818 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4819 If point reaches the beginning or end of buffer, it stops there.
4820 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4821 (interactive "^p")
4822 (or arg (setq arg 1))
4824 (let ((orig (point))
4825 first-vis first-vis-field-value)
4827 ;; Move by lines, if ARG is not 1 (the default).
4828 (if (/= arg 1)
4829 (let ((line-move-visual nil))
4830 (line-move (1- arg) t)))
4832 ;; Move to beginning-of-line, ignoring fields and invisible text.
4834 (while (and (not (bobp)) (invisible-p (1- (point))))
4835 (goto-char (previous-char-property-change (point)))
4838 ;; Now find first visible char in the line
4839 (while (and (not (eobp)) (invisible-p (point)))
4840 (goto-char (next-char-property-change (point))))
4841 (setq first-vis (point))
4843 ;; See if fields would stop us from reaching FIRST-VIS.
4844 (setq first-vis-field-value
4845 (constrain-to-field first-vis orig (/= arg 1) t nil))
4847 (goto-char (if (/= first-vis-field-value first-vis)
4848 ;; If yes, obey them.
4849 first-vis-field-value
4850 ;; Otherwise, move to START with attention to fields.
4851 ;; (It is possible that fields never matter in this case.)
4852 (constrain-to-field (point) orig
4853 (/= arg 1) t nil)))))
4856 ;; Many people have said they rarely use this feature, and often type
4857 ;; it by accident. Maybe it shouldn't even be on a key.
4858 (put 'set-goal-column 'disabled t)
4860 (defun set-goal-column (arg)
4862 Those commands will move to this position in the line moved to
4863 rather than trying to keep the same horizontal position.
4864 With a non-nil argument ARG, clears out the goal column
4866 The goal column is stored in the variable `goal-column'."
4867 (interactive "P")
4868 (if arg
4869 (progn
4870 (setq goal-column nil)
4871 (message "No goal column"))
4872 (setq goal-column (current-column))
4873 ;; The older method below can be erroneous if `set-goal-column' is bound
4874 ;; to a sequence containing %
4875 ;;(message (substitute-command-keys
4877 ;;goal-column)
4878 (message "%s"
4879 (concat
4880 (format "Goal column %d " goal-column)
4881 (substitute-command-keys
4884 )
4885 nil)
4886 \f
4887 ;;; Editing based on visual lines, as opposed to logical lines.
4889 (defun end-of-visual-line (&optional n)
4890 "Move point to end of current visual line.
4891 With argument N not nil or 1, move forward N - 1 visual lines first.
4892 If point reaches the beginning or end of buffer, it stops there.
4893 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4894 (interactive "^p")
4895 (or n (setq n 1))
4896 (if (/= n 1)
4897 (let ((line-move-visual t))
4898 (line-move (1- n) t)))
4899 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4900 ;; constrain to field boundaries, so we don't either.
4901 (vertical-motion (cons (window-width) 0)))
4903 (defun beginning-of-visual-line (&optional n)
4904 "Move point to beginning of current visual line.
4905 With argument N not nil or 1, move forward N - 1 visual lines first.
4906 If point reaches the beginning or end of buffer, it stops there.
4907 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4908 (interactive "^p")
4909 (or n (setq n 1))
4910 (let ((opoint (point)))
4911 (if (/= n 1)
4912 (let ((line-move-visual t))
4913 (line-move (1- n) t)))
4914 (vertical-motion 0)
4915 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4916 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4918 (defun kill-visual-line (&optional arg)
4919 "Kill the rest of the visual line.
4920 With prefix argument ARG, kill that many visual lines from point.
4921 If ARG is negative, kill visual lines backward.
4922 If ARG is zero, kill the text before point on the current visual
4923 line.
4925 If you want to append the killed line to the last killed text,
4928 If the buffer is read-only, Emacs will beep and refrain from deleting
4929 the line, but put the line in the kill ring anyway. This means that
4930 you can use this command to copy text from a read-only buffer.
4931 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4932 even beep.)"
4933 (interactive "P")
4934 ;; Like in `kill-line', it's better to move point to the other end
4935 ;; of the kill before killing.
4936 (let ((opoint (point))
4937 (kill-whole-line (and kill-whole-line (bolp))))
4938 (if arg
4939 (vertical-motion (prefix-numeric-value arg))
4940 (end-of-visual-line 1)
4941 (if (= (point) opoint)
4942 (vertical-motion 1)
4943 ;; Skip any trailing whitespace at the end of the visual line.
4944 ;; We used to do this only if `show-trailing-whitespace' is
4945 ;; nil, but that's wrong; the correct thing would be to check
4946 ;; whether the trailing whitespace is highlighted. But, it's
4947 ;; OK to just do this unconditionally.
4950 (1+ (point))
4951 (point)))))
4953 (defun next-logical-line (&optional arg try-vscroll)
4954 "Move cursor vertically down ARG lines.
4955 This is identical to `next-line', except that it always moves
4956 by logical lines instead of visual lines, ignoring the value of
4957 the variable `line-move-visual'."
4959 (let ((line-move-visual nil))
4960 (with-no-warnings
4961 (next-line arg try-vscroll))))
4963 (defun previous-logical-line (&optional arg try-vscroll)
4964 "Move cursor vertically up ARG lines.
4965 This is identical to `previous-line', except that it always moves
4966 by logical lines instead of visual lines, ignoring the value of
4967 the variable `line-move-visual'."
4969 (let ((line-move-visual nil))
4970 (with-no-warnings
4971 (previous-line arg try-vscroll))))
4973 (defgroup visual-line nil
4974 "Editing based on visual lines."
4975 :group 'convenience
4976 :version "23.1")
4978 (defvar visual-line-mode-map
4979 (let ((map (make-sparse-keymap)))
4980 (define-key map [remap kill-line] 'kill-visual-line)
4981 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4982 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4983 ;; These keybindings interfere with xterm function keys. Are
4984 ;; there any other suitable bindings?
4985 ;; (define-key map "\M-[" 'previous-logical-line)
4986 ;; (define-key map "\M-]" 'next-logical-line)
4987 map))
4989 (defcustom visual-line-fringe-indicators '(nil nil)
4990 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4991 The value should be a list of the form (LEFT RIGHT), where LEFT
4992 and RIGHT are symbols representing the bitmaps to display, to
4993 indicate wrapped lines, in the left and right fringes respectively.
4994 See also `fringe-indicator-alist'.
4995 The default is not to display fringe indicators for wrapped lines.
4996 This variable does not affect fringe indicators displayed for
4997 other purposes."
4998 :type '(list (choice (const :tag "Hide left indicator" nil)
4999 (const :tag "Left curly arrow" left-curly-arrow)
5000 (symbol :tag "Other bitmap"))
5001 (choice (const :tag "Hide right indicator" nil)
5002 (const :tag "Right curly arrow" right-curly-arrow)
5003 (symbol :tag "Other bitmap")))
5004 :set (lambda (symbol value)
5005 (dolist (buf (buffer-list))
5006 (with-current-buffer buf
5007 (when (and (boundp 'visual-line-mode)
5008 (symbol-value 'visual-line-mode))
5009 (setq fringe-indicator-alist
5010 (cons (cons 'continuation value)
5011 (assq-delete-all
5012 'continuation
5013 (copy-tree fringe-indicator-alist)))))))
5014 (set-default symbol value)))
5016 (defvar visual-line--saved-state nil)
5018 (define-minor-mode visual-line-mode
5019 "Toggle visual line based editing (Visual Line mode).
5020 With a prefix argument ARG, enable Visual Line mode if ARG is
5021 positive, and disable it otherwise. If called from Lisp, enable
5022 the mode if ARG is omitted or nil.
5024 When Visual Line mode is enabled, `word-wrap' is turned on in
5025 this buffer, and simple editing commands are redefined to act on
5026 visual lines, not logical lines. See Info node `Visual Line
5027 Mode' for details."
5028 :keymap visual-line-mode-map
5029 :group 'visual-line
5030 :lighter " Wrap"
5031 (if visual-line-mode
5032 (progn
5033 (set (make-local-variable 'visual-line--saved-state) nil)
5034 ;; Save the local values of some variables, to be restored if
5035 ;; visual-line-mode is turned off.
5036 (dolist (var '(line-move-visual truncate-lines
5037 truncate-partial-width-windows
5038 word-wrap fringe-indicator-alist))
5039 (if (local-variable-p var)
5040 (push (cons var (symbol-value var))
5041 visual-line--saved-state)))
5042 (set (make-local-variable 'line-move-visual) t)
5043 (set (make-local-variable 'truncate-partial-width-windows) nil)
5044 (setq truncate-lines nil
5045 word-wrap t
5046 fringe-indicator-alist
5047 (cons (cons 'continuation visual-line-fringe-indicators)
5048 fringe-indicator-alist)))
5049 (kill-local-variable 'line-move-visual)
5050 (kill-local-variable 'word-wrap)
5051 (kill-local-variable 'truncate-lines)
5052 (kill-local-variable 'truncate-partial-width-windows)
5053 (kill-local-variable 'fringe-indicator-alist)
5054 (dolist (saved visual-line--saved-state)
5055 (set (make-local-variable (car saved)) (cdr saved)))
5056 (kill-local-variable 'visual-line--saved-state)))
5058 (defun turn-on-visual-line-mode ()
5059 (visual-line-mode 1))
5061 (define-globalized-minor-mode global-visual-line-mode
5062 visual-line-mode turn-on-visual-line-mode
5063 :lighter " vl")
5065 \f
5066 (defun transpose-chars (arg)
5067 "Interchange characters around point, moving forward one character.
5068 With prefix arg ARG, effect is to take character before point
5069 and drag it forward past ARG other characters (backward if ARG negative).
5070 If no argument and at end of line, the previous two chars are exchanged."
5071 (interactive "*P")
5072 (and (null arg) (eolp) (forward-char -1))
5073 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5075 (defun transpose-words (arg)
5076 "Interchange words around point, leaving point at end of them.
5077 With prefix arg ARG, effect is to take word before or around point
5078 and drag it forward past ARG other words (backward if ARG negative).
5079 If ARG is zero, the words around or after point and around or after mark
5080 are interchanged."
5081 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5082 (interactive "*p")
5083 (transpose-subr 'forward-word arg))
5085 (defun transpose-sexps (arg)
5087 Does not work on a sexp that point is in the middle of
5088 if it is a list or string."
5089 (interactive "*p")
5090 (transpose-subr
5091 (lambda (arg)
5092 ;; Here we should try to simulate the behavior of
5093 ;; (cons (progn (forward-sexp x) (point))
5094 ;; (progn (forward-sexp (- x)) (point)))
5095 ;; Except that we don't want to rely on the second forward-sexp
5096 ;; putting us back to where we want to be, since forward-sexp-function
5097 ;; might do funny things like infix-precedence.
5098 (if (if (> arg 0)
5100 (and (not (bobp))
5102 ;; Jumping over a symbol. We might be inside it, mind you.
5103 (progn (funcall (if (> arg 0)
5104 'skip-syntax-backward 'skip-syntax-forward)
5105 "w_")
5106 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5107 ;; Otherwise, we're between sexps. Take a step back before jumping
5108 ;; to make sure we'll obey the same precedence no matter which direction
5109 ;; we're going.
5110 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5111 (cons (save-excursion (forward-sexp arg) (point))
5112 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5113 (not (zerop (funcall (if (> arg 0)
5114 'skip-syntax-forward
5115 'skip-syntax-backward)
5116 ".")))))
5117 (point)))))
5118 arg 'special))
5120 (defun transpose-lines (arg)
5121 "Exchange current line and previous line, leaving point after both.
5122 With argument ARG, takes previous line and moves it past ARG lines.
5123 With argument 0, interchanges line point is in with line mark is in."
5124 (interactive "*p")
5125 (transpose-subr (function
5126 (lambda (arg)
5127 (if (> arg 0)
5128 (progn
5129 ;; Move forward over ARG lines,
5130 ;; but create newlines if necessary.
5131 (setq arg (forward-line arg))
5133 (setq arg (1+ arg)))
5134 (if (> arg 0)
5135 (newline arg)))
5136 (forward-line arg))))
5137 arg))
5139 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5140 ;; which seems inconsistent with the ARG /= 0 case.
5141 ;; FIXME document SPECIAL.
5142 (defun transpose-subr (mover arg &optional special)
5143 "Subroutine to do the work of transposing objects.
5144 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5145 moves forward by units of the given object (e.g. forward-sentence,
5146 forward-paragraph). If ARG is zero, exchanges the current object
5147 with the one containing mark. If ARG is an integer, moves the
5148 current object past ARG following (if ARG is positive) or
5149 preceding (if ARG is negative) objects, leaving point after the
5150 current object."
5151 (let ((aux (if special mover
5152 (lambda (x)
5153 (cons (progn (funcall mover x) (point))
5154 (progn (funcall mover (- x)) (point))))))
5155 pos1 pos2)
5156 (cond
5157 ((= arg 0)
5158 (save-excursion
5159 (setq pos1 (funcall aux 1))
5160 (goto-char (or (mark) (error "No mark set in this buffer")))
5161 (setq pos2 (funcall aux 1))
5162 (transpose-subr-1 pos1 pos2))
5163 (exchange-point-and-mark))
5164 ((> arg 0)
5165 (setq pos1 (funcall aux -1))
5166 (setq pos2 (funcall aux arg))
5167 (transpose-subr-1 pos1 pos2)
5168 (goto-char (car pos2)))
5169 (t
5170 (setq pos1 (funcall aux -1))
5171 (goto-char (car pos1))
5172 (setq pos2 (funcall aux arg))
5173 (transpose-subr-1 pos1 pos2)))))
5175 (defun transpose-subr-1 (pos1 pos2)
5176 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5177 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5178 (when (> (car pos1) (car pos2))
5179 (let ((swap pos1))
5180 (setq pos1 pos2 pos2 swap)))
5181 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5182 (atomic-change-group
5183 (let (word2)
5184 ;; FIXME: We first delete the two pieces of text, so markers that
5185 ;; used to point to after the text end up pointing to before it :-(
5186 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5187 (goto-char (car pos2))
5188 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5189 (goto-char (car pos1))
5190 (insert word2))))
5191 \f
5192 (defun backward-word (&optional arg)
5193 "Move backward until encountering the beginning of a word.
5194 With argument ARG, do this that many times."
5195 (interactive "^p")
5196 (forward-word (- (or arg 1))))
5198 (defun mark-word (&optional arg allow-extend)
5199 "Set mark ARG words away from point.
5201 move to with the same argument.
5202 Interactively, if this command is repeated
5203 or (in Transient Mark mode) if the mark is active,
5204 it marks the next ARG words after the ones already marked."
5206 (cond ((and allow-extend
5207 (or (and (eq last-command this-command) (mark t))
5208 (region-active-p)))
5209 (setq arg (if arg (prefix-numeric-value arg)
5210 (if (< (mark) (point)) -1 1)))
5211 (set-mark
5212 (save-excursion
5213 (goto-char (mark))
5214 (forward-word arg)
5215 (point))))
5216 (t
5217 (push-mark
5218 (save-excursion
5219 (forward-word (prefix-numeric-value arg))
5220 (point))
5221 nil t))))
5223 (defun kill-word (arg)
5224 "Kill characters forward until encountering the end of a word.
5225 With argument ARG, do this that many times."
5226 (interactive "p")
5227 (kill-region (point) (progn (forward-word arg) (point))))
5229 (defun backward-kill-word (arg)
5230 "Kill characters backward until encountering the beginning of a word.
5231 With argument ARG, do this that many times."
5232 (interactive "p")
5233 (kill-word (- arg)))
5235 (defun current-word (&optional strict really-word)
5236 "Return the symbol or word that point is on (or a nearby one) as a string.
5237 The return value includes no text properties.
5238 If optional arg STRICT is non-nil, return nil unless point is within
5239 or adjacent to a symbol or word. In all cases the value can be nil
5240 if there is no word nearby.
5241 The function, belying its name, normally finds a symbol.
5242 If optional arg REALLY-WORD is non-nil, it finds just a word."
5243 (save-excursion
5244 (let* ((oldpoint (point)) (start (point)) (end (point))
5245 (syntaxes (if really-word "w" "w_"))
5246 (not-syntaxes (concat "^" syntaxes)))
5247 (skip-syntax-backward syntaxes) (setq start (point))
5248 (goto-char oldpoint)
5249 (skip-syntax-forward syntaxes) (setq end (point))
5250 (when (and (eq start oldpoint) (eq end oldpoint)
5251 ;; Point is neither within nor adjacent to a word.
5252 (not strict))
5253 ;; Look for preceding word in same line.
5254 (skip-syntax-backward not-syntaxes (line-beginning-position))
5255 (if (bolp)
5256 ;; No preceding word in same line.
5257 ;; Look for following word in same line.
5258 (progn
5259 (skip-syntax-forward not-syntaxes (line-end-position))
5260 (setq start (point))
5261 (skip-syntax-forward syntaxes)
5262 (setq end (point)))
5263 (setq end (point))
5264 (skip-syntax-backward syntaxes)
5265 (setq start (point))))
5266 ;; If we found something nonempty, return it as a string.
5267 (unless (= start end)
5268 (buffer-substring-no-properties start end)))))
5269 \f
5270 (defcustom fill-prefix nil
5271 "String for filling to insert at front of new line, or nil for none."
5272 :type '(choice (const :tag "None" nil)
5273 string)
5274 :group 'fill)
5275 (make-variable-buffer-local 'fill-prefix)
5276 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5278 (defcustom auto-fill-inhibit-regexp nil
5279 "Regexp to match lines which should not be auto-filled."
5280 :type '(choice (const :tag "None" nil)
5281 regexp)
5282 :group 'fill)
5284 (defun do-auto-fill ()
5285 "The default value for `normal-auto-fill-function'.
5286 This is the default auto-fill function, some major modes use a different one.
5287 Returns t if it really did any work."
5288 (let (fc justify give-up
5289 (fill-prefix fill-prefix))
5290 (if (or (not (setq justify (current-justification)))
5291 (null (setq fc (current-fill-column)))
5292 (and (eq justify 'left)
5293 (<= (current-column) fc))
5294 (and auto-fill-inhibit-regexp
5295 (save-excursion (beginning-of-line)
5296 (looking-at auto-fill-inhibit-regexp))))
5297 nil ;; Auto-filling not required
5298 (if (memq justify '(full center right))
5299 (save-excursion (unjustify-current-line)))
5301 ;; Choose a fill-prefix automatically.
5302 (when (and adaptive-fill-mode
5303 (or (null fill-prefix) (string= fill-prefix "")))
5304 (let ((prefix
5305 (fill-context-prefix
5306 (save-excursion (fill-forward-paragraph -1) (point))
5307 (save-excursion (fill-forward-paragraph 1) (point)))))
5308 (and prefix (not (equal prefix ""))
5309 ;; Use auto-indentation rather than a guessed empty prefix.
5310 (not (and fill-indent-according-to-mode
5312 (setq fill-prefix prefix))))
5314 (while (and (not give-up) (> (current-column) fc))
5315 ;; Determine where to split the line.
5316 (let* (after-prefix
5317 (fill-point
5318 (save-excursion
5319 (beginning-of-line)
5320 (setq after-prefix (point))
5321 (and fill-prefix
5322 (looking-at (regexp-quote fill-prefix))
5323 (setq after-prefix (match-end 0)))
5324 (move-to-column (1+ fc))
5325 (fill-move-to-break-point after-prefix)
5326 (point))))
5328 ;; See whether the place we found is any good.
5329 (if (save-excursion
5330 (goto-char fill-point)
5331 (or (bolp)
5332 ;; There is no use breaking at end of line.
5333 (save-excursion (skip-chars-forward " ") (eolp))
5334 ;; It is futile to split at the end of the prefix
5335 ;; since we would just insert the prefix again.
5336 (and after-prefix (<= (point) after-prefix))
5337 ;; Don't split right after a comment starter
5338 ;; since we would just make another comment starter.
5339 (and comment-start-skip
5340 (let ((limit (point)))
5341 (beginning-of-line)
5342 (and (re-search-forward comment-start-skip
5343 limit t)
5344 (eq (point) limit))))))
5345 ;; No good place to break => stop trying.
5346 (setq give-up t)
5347 ;; Ok, we have a useful place to break the line. Do it.
5348 (let ((prev-column (current-column)))
5349 ;; If point is at the fill-point, do not `save-excursion'.
5350 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5351 ;; point will end up before it rather than after it.
5352 (if (save-excursion
5354 (= (point) fill-point))
5355 (default-indent-new-line t)
5356 (save-excursion
5357 (goto-char fill-point)
5358 (default-indent-new-line t)))
5359 ;; Now do justification, if required
5360 (if (not (eq justify 'left))
5361 (save-excursion
5362 (end-of-line 0)
5363 (justify-current-line justify nil t)))
5364 ;; If making the new line didn't reduce the hpos of
5365 ;; the end of the line, then give up now;
5366 ;; trying again will not help.
5367 (if (>= (current-column) prev-column)
5368 (setq give-up t))))))
5369 ;; Justify last line.
5370 (justify-current-line justify t t)
5371 t)))
5373 (defvar comment-line-break-function 'comment-indent-new-line
5374 "Mode-specific function which line breaks and continues a comment.
5375 This function is called during auto-filling when a comment syntax
5376 is defined.
5377 The function should take a single optional argument, which is a flag
5378 indicating whether it should use soft newlines.")
5380 (defun default-indent-new-line (&optional soft)
5381 "Break line at point and indent.
5382 If a comment syntax is defined, call `comment-indent-new-line'.
5384 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5385 unless optional argument SOFT is non-nil."
5386 (interactive)
5387 (if comment-start
5388 (funcall comment-line-break-function soft)
5389 ;; Insert the newline before removing empty space so that markers
5390 ;; get preserved better.
5392 (save-excursion (forward-char -1) (delete-horizontal-space))
5393 (delete-horizontal-space)
5395 (if (and fill-prefix (not adaptive-fill-mode))
5396 ;; Blindly trust a non-adaptive fill-prefix.
5397 (progn
5398 (indent-to-left-margin)
5399 (insert-before-markers-and-inherit fill-prefix))
5401 (cond
5402 ;; If there's an adaptive prefix, use it unless we're inside
5403 ;; a comment and the prefix is not a comment starter.
5404 (fill-prefix
5405 (indent-to-left-margin)
5406 (insert-and-inherit fill-prefix))
5407 ;; If we're not inside a comment, just try to indent.
5408 (t (indent-according-to-mode))))))
5410 (defvar normal-auto-fill-function 'do-auto-fill
5411 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5412 Some major modes set this.")
5414 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5415 ;; `functions' and `hooks' are usually unsafe to set, but setting
5416 ;; auto-fill-function to nil in a file-local setting is safe and
5417 ;; can be useful to prevent auto-filling.
5418 (put 'auto-fill-function 'safe-local-variable 'null)
5420 (define-minor-mode auto-fill-mode
5421 "Toggle automatic line breaking (Auto Fill mode).
5422 With a prefix argument ARG, enable Auto Fill mode if ARG is
5423 positive, and disable it otherwise. If called from Lisp, enable
5424 the mode if ARG is omitted or nil.
5426 When Auto Fill mode is enabled, inserting a space at a column
5427 beyond `current-fill-column' automatically breaks the line at a
5428 previous space.
5430 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5431 non-`nil'.
5433 The value of `normal-auto-fill-function' specifies the function to use
5434 for `auto-fill-function' when turning Auto Fill mode on."
5435 :variable (auto-fill-function
5436 . (lambda (v) (setq auto-fill-function
5437 (if v normal-auto-fill-function)))))
5439 ;; This holds a document string used to document auto-fill-mode.
5440 (defun auto-fill-function ()
5441 "Automatically break line at a previous space, in insertion of text."
5442 nil)
5444 (defun turn-on-auto-fill ()
5445 "Unconditionally turn on Auto Fill mode."
5446 (auto-fill-mode 1))
5448 (defun turn-off-auto-fill ()
5449 "Unconditionally turn off Auto Fill mode."
5450 (auto-fill-mode -1))
5452 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5454 (defun set-fill-column (arg)
5455 "Set `fill-column' to specified argument.
5458 (interactive
5459 (list (or current-prefix-arg
5460 ;; We used to use current-column silently, but C-x f is too easily
5461 ;; typed as a typo for C-x C-f, so we turned it into an error and
5462 ;; now an interactive prompt.
5463 (read-number "Set fill-column to: " (current-column)))))
5464 (if (consp arg)
5465 (setq arg (current-column)))
5466 (if (not (integerp arg))
5467 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5468 (error "set-fill-column requires an explicit argument")
5469 (message "Fill column set to %d (was %d)" arg fill-column)
5470 (setq fill-column arg)))
5471 \f
5472 (defun set-selective-display (arg)
5473 "Set `selective-display' to ARG; clear it if no arg.
5474 When the value of `selective-display' is a number > 0,
5475 lines whose indentation is >= that value are not displayed.
5476 The variable `selective-display' has a separate value for each buffer."
5477 (interactive "P")
5478 (if (eq selective-display t)
5479 (error "selective-display already in use for marked lines"))
5480 (let ((current-vpos
5481 (save-restriction
5482 (narrow-to-region (point-min) (point))
5483 (goto-char (window-start))
5484 (vertical-motion (window-height)))))
5485 (setq selective-display
5486 (and arg (prefix-numeric-value arg)))
5487 (recenter current-vpos))
5488 (set-window-start (selected-window) (window-start (selected-window)))
5489 (princ "selective-display set to " t)
5490 (prin1 selective-display t)
5491 (princ "." t))
5493 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5495 (defun toggle-truncate-lines (&optional arg)
5496 "Toggle truncating of long lines for the current buffer.
5497 When truncating is off, long lines are folded.
5498 With prefix argument ARG, truncate long lines if ARG is positive,
5499 otherwise fold them. Note that in side-by-side windows, this
5500 command has no effect if `truncate-partial-width-windows' is
5501 non-nil."
5502 (interactive "P")
5503 (setq truncate-lines
5504 (if (null arg)
5505 (not truncate-lines)
5506 (> (prefix-numeric-value arg) 0)))
5507 (force-mode-line-update)
5508 (unless truncate-lines
5509 (let ((buffer (current-buffer)))
5510 (walk-windows (lambda (window)
5511 (if (eq buffer (window-buffer window))
5512 (set-window-hscroll window 0)))
5513 nil t)))
5514 (message "Truncate long lines %s"
5515 (if truncate-lines "enabled" "disabled")))
5517 (defun toggle-word-wrap (&optional arg)
5518 "Toggle whether to use word-wrapping for continuation lines.
5519 With prefix argument ARG, wrap continuation lines at word boundaries
5520 if ARG is positive, otherwise wrap them at the right screen edge.
5521 This command toggles the value of `word-wrap'. It has no effect
5522 if long lines are truncated."
5523 (interactive "P")
5524 (setq word-wrap
5525 (if (null arg)
5526 (not word-wrap)
5527 (> (prefix-numeric-value arg) 0)))
5528 (force-mode-line-update)
5529 (message "Word wrapping %s"
5530 (if word-wrap "enabled" "disabled")))
5532 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5533 "The string displayed in the mode line when in overwrite mode.")
5534 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5535 "The string displayed in the mode line when in binary overwrite mode.")
5537 (define-minor-mode overwrite-mode
5538 "Toggle Overwrite mode.
5539 With a prefix argument ARG, enable Overwrite mode if ARG is
5540 positive, and disable it otherwise. If called from Lisp, enable
5541 the mode if ARG is omitted or nil.
5543 When Overwrite mode is enabled, printing characters typed in
5544 replace existing text on a one-for-one basis, rather than pushing
5545 it to the right. At the end of a line, such characters extend
5546 the line. Before a tab, such characters insert until the tab is
5548 overwrite mode; this is supposed to make it easier to insert
5549 characters when necessary."
5550 :variable (overwrite-mode
5551 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5553 (define-minor-mode binary-overwrite-mode
5554 "Toggle Binary Overwrite mode.
5555 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5556 is positive, and disable it otherwise. If called from Lisp,
5557 enable the mode if ARG is omitted or nil.
5559 When Binary Overwrite mode is enabled, printing characters typed
5560 in replace existing text. Newlines are not treated specially, so
5561 typing at the end of a line joins the line to the next, with the
5562 typed character between them. Typing before a tab character
5563 simply replaces the tab with the character typed.
5565 ordinary typing characters do.
5567 Note that Binary Overwrite mode is not its own minor mode; it is
5568 a specialization of overwrite mode, entered by setting the
5569 `overwrite-mode' variable to `overwrite-mode-binary'."
5570 :variable (overwrite-mode
5571 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5573 (define-minor-mode line-number-mode
5574 "Toggle line number display in the mode line (Line Number mode).
5575 With a prefix argument ARG, enable Line Number mode if ARG is
5576 positive, and disable it otherwise. If called from Lisp, enable
5577 the mode if ARG is omitted or nil.
5579 Line numbers do not appear for very large buffers and buffers
5580 with very long lines; see variables `line-number-display-limit'
5581 and `line-number-display-limit-width'."
5582 :init-value t :global t :group 'mode-line)
5584 (define-minor-mode column-number-mode
5585 "Toggle column number display in the mode line (Column Number mode).
5586 With a prefix argument ARG, enable Column Number mode if ARG is
5587 positive, and disable it otherwise.
5589 If called from Lisp, enable the mode if ARG is omitted or nil."
5590 :global t :group 'mode-line)
5592 (define-minor-mode size-indication-mode
5593 "Toggle buffer size display in the mode line (Size Indication mode).
5594 With a prefix argument ARG, enable Size Indication mode if ARG is
5595 positive, and disable it otherwise.
5597 If called from Lisp, enable the mode if ARG is omitted or nil."
5598 :global t :group 'mode-line)
5600 (define-minor-mode auto-save-mode
5601 "Toggle auto-saving in the current buffer (Auto Save mode).
5602 With a prefix argument ARG, enable Auto Save mode if ARG is
5603 positive, and disable it otherwise.
5605 If called from Lisp, enable the mode if ARG is omitted or nil."
5606 :variable ((and buffer-auto-save-file-name
5607 ;; If auto-save is off because buffer has shrunk,
5608 ;; then toggling should turn it on.
5609 (>= buffer-saved-size 0))
5610 . (lambda (val)
5611 (setq buffer-auto-save-file-name
5612 (cond
5613 ((null val) nil)
5614 ((and buffer-file-name auto-save-visited-file-name
5615 (not buffer-read-only))
5616 buffer-file-name)
5617 (t (make-auto-save-file-name))))))
5618 ;; If -1 was stored here, to temporarily turn off saving,
5619 ;; turn it back on.
5620 (and (< buffer-saved-size 0)
5621 (setq buffer-saved-size 0)))
5622 \f
5623 (defgroup paren-blinking nil
5624 "Blinking matching of parens and expressions."
5625 :prefix "blink-matching-"
5626 :group 'paren-matching)
5628 (defcustom blink-matching-paren t
5629 "Non-nil means show matching open-paren when close-paren is inserted."
5630 :type 'boolean
5631 :group 'paren-blinking)
5633 (defcustom blink-matching-paren-on-screen t
5634 "Non-nil means show matching open-paren when it is on screen.
5635 If nil, don't show it (but the open-paren can still be shown
5636 when it is off screen).
5638 This variable has no effect if `blink-matching-paren' is nil.
5639 \(In that case, the open-paren is never shown.)
5640 It is also ignored if `show-paren-mode' is enabled."
5641 :type 'boolean
5642 :group 'paren-blinking)
5644 (defcustom blink-matching-paren-distance (* 100 1024)
5645 "If non-nil, maximum distance to search backwards for matching open-paren.
5646 If nil, search stops at the beginning of the accessible portion of the buffer."
5647 :version "23.2" ; 25->100k
5648 :type '(choice (const nil) integer)
5649 :group 'paren-blinking)
5651 (defcustom blink-matching-delay 1
5652 "Time in seconds to delay after showing a matching paren."
5653 :type 'number
5654 :group 'paren-blinking)
5656 (defcustom blink-matching-paren-dont-ignore-comments nil
5657 "If nil, `blink-matching-paren' ignores comments.
5658 More precisely, when looking for the matching parenthesis,
5659 it skips the contents of comments that end before point."
5660 :type 'boolean
5661 :group 'paren-blinking)
5663 (defun blink-matching-check-mismatch (start end)
5664 "Return whether or not START...END are matching parens.
5665 END is the current point and START is the blink position.
5666 START might be nil if no matching starter was found.
5667 Returns non-nil if we find there is a mismatch."
5668 (let* ((end-syntax (syntax-after (1- end)))
5669 (matching-paren (and (consp end-syntax)
5670 (eq (syntax-class end-syntax) 5)
5671 (cdr end-syntax))))
5672 ;; For self-matched chars like " and $, we can't know when they're
5673 ;; mismatched or unmatched, so we can only do it for parens.
5674 (when matching-paren
5675 (not (and start
5676 (or
5677 (eq (char-after start) matching-paren)
5678 ;; The cdr might hold a new paren-class info rather than
5679 ;; a matching-char info, in which case the two CDRs
5680 ;; should match.
5681 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5683 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5684 "Function to check parentheses mismatches.
5685 The function takes two arguments (START and END) where START is the
5686 position just before the opening token and END is the position right after.
5687 START can be nil, if it was not found.
5688 The function should return non-nil if the two tokens do not match.")
5690 (defun blink-matching-open ()
5691 "Move cursor momentarily to the beginning of the sexp before point."
5692 (interactive)
5693 (when (and (not (bobp))
5694 blink-matching-paren)
5695 (let* ((oldpos (point))
5696 (message-log-max nil) ; Don't log messages about paren matching.
5697 (blinkpos
5698 (save-excursion
5699 (save-restriction
5700 (if blink-matching-paren-distance
5701 (narrow-to-region
5702 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5703 (- (point) blink-matching-paren-distance))
5704 oldpos))
5705 (let ((parse-sexp-ignore-comments
5706 (and parse-sexp-ignore-comments
5707 (not blink-matching-paren-dont-ignore-comments))))
5708 (condition-case ()
5709 (progn
5710 (forward-sexp -1)
5711 ;; backward-sexp skips backward over prefix chars,
5712 ;; so move back to the matching paren.
5713 (while (and (< (point) (1- oldpos))
5714 (let ((code (syntax-after (point))))
5715 (or (eq (syntax-class code) 6)
5716 (eq (logand 1048576 (car code))
5717 1048576))))
5718 (forward-char 1))
5719 (point))
5720 (error nil))))))
5721 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5722 (cond
5723 (mismatch
5724 (if blinkpos
5725 (if (minibufferp)
5726 (minibuffer-message "Mismatched parentheses")
5727 (message "Mismatched parentheses"))
5728 (if (minibufferp)
5729 (minibuffer-message "No matching parenthesis found")
5730 (message "No matching parenthesis found"))))
5731 ((not blinkpos) nil)
5732 ((pos-visible-in-window-p blinkpos)
5733 ;; Matching open within window, temporarily move to blinkpos but only
5734 ;; if `blink-matching-paren-on-screen' is non-nil.
5735 (and blink-matching-paren-on-screen
5736 (not show-paren-mode)
5737 (save-excursion
5738 (goto-char blinkpos)
5739 (sit-for blink-matching-delay))))
5740 (t
5741 (save-excursion
5742 (goto-char blinkpos)
5743 (let ((open-paren-line-string
5744 ;; Show what precedes the open in its line, if anything.
5745 (cond
5747 (buffer-substring (line-beginning-position)
5748 (1+ blinkpos)))
5749 ;; Show what follows the open in its line, if anything.
5750 ((save-excursion
5751 (forward-char 1)
5753 (not (eolp)))
5754 (buffer-substring blinkpos
5755 (line-end-position)))
5756 ;; Otherwise show the previous nonblank line,
5757 ;; if there is one.
5759 (concat
5760 (buffer-substring (progn
5762 (line-beginning-position))
5763 (progn (end-of-line)
5765 (point)))
5766 ;; Replace the newline and other whitespace with `...'.
5767 "..."
5768 (buffer-substring blinkpos (1+ blinkpos))))
5769 ;; There is nothing to show except the char itself.
5770 (t (buffer-substring blinkpos (1+ blinkpos))))))
5771 (message "Matches %s"
5772 (substring-no-properties open-paren-line-string)))))))))
5774 (defvar blink-paren-function 'blink-matching-open
5775 "Function called, if non-nil, whenever a close parenthesis is inserted.
5776 More precisely, a char with closeparen syntax is self-inserted.")
5778 (defun blink-paren-post-self-insert-function ()
5779 (when (and (eq (char-before) last-command-event) ; Sanity check.
5780 (memq (char-syntax last-command-event) '(?\) ?\$))
5781 blink-paren-function
5782 (not executing-kbd-macro)
5783 (not noninteractive)
5784 ;; Verify an even number of quoting characters precede the close.
5785 (= 1 (logand 1 (- (point)
5786 (save-excursion
5787 (forward-char -1)
5789 (point))))))
5790 (funcall blink-paren-function)))
5792 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5793 ;; Most likely, this hook is nil, so this arg doesn't matter,
5794 ;; but I use it as a reminder that this function usually
5795 ;; likes to be run after others since it does `sit-for'.
5796 'append)
5797 \f
5798 ;; This executes C-g typed while Emacs is waiting for a command.
5799 ;; Quitting out of a program does not go through here;
5800 ;; that happens in the QUIT macro at the C code level.
5801 (defun keyboard-quit ()
5802 "Signal a `quit' condition.
5803 During execution of Lisp code, this character causes a quit directly.
5804 At top-level, as an editor command, this simply beeps."
5805 (interactive)
5806 ;; Avoid adding the region to the window selection.
5807 (setq saved-region-selection nil)
5808 (let (select-active-regions)
5809 (deactivate-mark))
5810 (if (fboundp 'kmacro-keyboard-quit)
5811 (kmacro-keyboard-quit))
5812 (setq defining-kbd-macro nil)
5813 (let ((debug-on-quit nil))
5814 (signal 'quit nil)))
5816 (defvar buffer-quit-function nil
5819 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5821 (defun keyboard-escape-quit ()
5823 This command can exit an interactive command such as `query-replace',
5824 can clear out a prefix argument or a region,
5825 can get out of the minibuffer or other recursive edit,
5826 cancel the use of the current buffer (for special-purpose buffers),
5827 or go back to just one window (by deleting all but the selected window)."
5828 (interactive)
5829 (cond ((eq last-command 'mode-exited) nil)
5830 ((region-active-p)
5831 (deactivate-mark))
5832 ((> (minibuffer-depth) 0)
5833 (abort-recursive-edit))
5834 (current-prefix-arg
5835 nil)
5836 ((> (recursion-depth) 0)
5837 (exit-recursive-edit))
5838 (buffer-quit-function
5839 (funcall buffer-quit-function))
5840 ((not (one-window-p t))
5841 (delete-other-windows))
5843 (bury-buffer))))
5845 (defun play-sound-file (file &optional volume device)
5846 "Play sound stored in FILE.
5847 VOLUME and DEVICE correspond to the keywords of the sound
5848 specification for `play-sound'."
5849 (interactive "fPlay sound file: ")
5850 (let ((sound (list :file file)))
5851 (if volume
5852 (plist-put sound :volume volume))
5853 (if device
5854 (plist-put sound :device device))
5855 (push 'sound sound)
5856 (play-sound sound)))
5858 \f
5859 (defcustom read-mail-command 'rmail
5860 "Your preference for a mail reading package.
5861 This is used by some keybindings which support reading mail.
5862 See also `mail-user-agent' concerning sending mail."
5865 (function-item :tag "Emacs interface to MH"
5867 (function :tag "Other"))
5868 :version "21.1"
5869 :group 'mail)
5871 (defcustom mail-user-agent 'message-user-agent
5872 "Your preference for a mail composition package.
5873 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5874 outgoing email message. This variable lets you specify which
5875 mail-sending package you prefer.
5877 Valid values include:
5879 `message-user-agent' -- use the Message package.
5880 See Info node `(message)'.
5881 `sendmail-user-agent' -- use the Mail package.
5882 See Info node `(emacs)Sending Mail'.
5883 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5884 See Info node `(mh-e)'.
5885 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5886 paraphernalia if Gnus is running, particularly
5887 the Gcc: header for archiving.
5889 Additional valid symbols may be available; check with the author of
5890 your package for details. The function should return non-nil if it
5891 succeeds.
5893 See also `read-mail-command' concerning reading mail."
5894 :type '(radio (function-item :tag "Message package"
5896 message-user-agent)
5897 (function-item :tag "Mail package"
5899 sendmail-user-agent)
5900 (function-item :tag "Emacs interface to MH"
5902 mh-e-user-agent)
5903 (function-item :tag "Message with full Gnus features"
5905 gnus-user-agent)
5906 (function :tag "Other"))
5907 :version "23.2" ; sendmail->message
5908 :group 'mail)
5910 (defcustom compose-mail-user-agent-warnings t
5911 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5912 If the value of `mail-user-agent' is the default, and the user
5913 appears to have customizations applying to the old default,
5914 `compose-mail' issues a warning."
5915 :type 'boolean
5916 :version "23.2"
5917 :group 'mail)
5919 (defun rfc822-goto-eoh ()
5920 "If the buffer starts with a mail header, move point to the header's end.
5921 Otherwise, moves to `point-min'.
5922 The end of the header is the start of the next line, if there is one,
5923 else the end of the last line. This function obeys RFC822."
5924 (goto-char (point-min))
5925 (when (re-search-forward
5927 (goto-char (match-beginning 0))))
5929 ;; Used by Rmail (e.g., rmail-forward).
5930 (defvar mail-encode-mml nil
5931 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5932 the outgoing message before sending it.")
5934 (defun compose-mail (&optional to subject other-headers continue
5935 switch-function yank-action send-actions
5936 return-action)
5937 "Start composing a mail message to send.
5938 This uses the user's chosen mail composition package
5939 as selected with the variable `mail-user-agent'.
5940 The optional arguments TO and SUBJECT specify recipients
5941 and the initial Subject field, respectively.
5943 OTHER-HEADERS is an alist specifying additional
5944 header fields. Elements look like (HEADER . VALUE) where both
5945 HEADER and VALUE are strings.
5947 CONTINUE, if non-nil, says to continue editing a message already
5948 being composed. Interactively, CONTINUE is the prefix argument.
5950 SWITCH-FUNCTION, if non-nil, is a function to use to
5951 switch to and display the buffer used for mail composition.
5953 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5954 to insert the raw text of the message being replied to.
5955 It has the form (FUNCTION . ARGS). The user agent will apply
5956 FUNCTION to ARGS, to insert the raw text of the original message.
5957 \(The user agent will also run `mail-citation-hook', *after* the
5958 original text has been inserted in this way.)
5960 SEND-ACTIONS is a list of actions to call when the message is sent.
5961 Each action has the form (FUNCTION . ARGS).
5963 RETURN-ACTION, if non-nil, is an action for returning to the
5964 caller. It has the form (FUNCTION . ARGS). The function is
5965 called after the mail has been sent or put aside, and the mail
5966 buffer buried."
5967 (interactive
5968 (list nil nil nil current-prefix-arg))
5970 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5971 ;; from sendmail-user-agent to message-user-agent. Some users may
5972 ;; encounter incompatibilities. This hack tries to detect problems
5973 ;; and warn about them.
5974 (and compose-mail-user-agent-warnings
5975 (eq mail-user-agent 'message-user-agent)
5976 (let (warn-vars)
5977 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5978 mail-yank-hooks mail-archive-file-name
5979 mail-default-reply-to mail-mailing-lists
5980 mail-self-blind))
5981 (and (boundp var)
5982 (symbol-value var)
5983 (push var warn-vars)))
5984 (when warn-vars
5985 (display-warning 'mail
5986 (format "\
5987 The default mail mode is now Message mode.
5988 You have the following Mail mode variable%s customized:
5990 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5991 (if (> (length warn-vars) 1) "s" "")
5992 (mapconcat 'symbol-name
5993 warn-vars " "))))))
5995 (let ((function (get mail-user-agent 'composefunc)))
5996 (funcall function to subject other-headers continue switch-function
5997 yank-action send-actions return-action)))
5999 (defun compose-mail-other-window (&optional to subject other-headers continue
6000 yank-action send-actions
6001 return-action)
6003 (interactive (list nil nil nil current-prefix-arg))
6004 (compose-mail to subject other-headers continue
6005 'switch-to-buffer-other-window yank-action send-actions
6006 return-action))
6008 (defun compose-mail-other-frame (&optional to subject other-headers continue
6009 yank-action send-actions
6010 return-action)
6012 (interactive (list nil nil nil current-prefix-arg))
6013 (compose-mail to subject other-headers continue
6014 'switch-to-buffer-other-frame yank-action send-actions
6015 return-action))
6017 \f
6018 (defvar set-variable-value-history nil
6019 "History of values entered with `set-variable'.
6021 Maximum length of the history list is determined by the value
6022 of `history-length', which see.")
6024 (defun set-variable (variable value &optional make-local)
6025 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6026 VARIABLE should be a user option variable name, a Lisp variable
6027 meant to be customized by users. You should enter VALUE in Lisp syntax,
6028 so if you want VALUE to be a string, you must surround it with doublequotes.
6029 VALUE is used literally, not evaluated.
6031 If VARIABLE has a `variable-interactive' property, that is used as if
6032 it were the arg to `interactive' (which see) to interactively read VALUE.
6034 If VARIABLE has been defined with `defcustom', then the type information
6035 in the definition is used to check that VALUE is valid.
6037 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6038 (interactive
6039 (let* ((default-var (variable-at-point))
6040 (var (if (custom-variable-p default-var)
6041 (read-variable (format "Set variable (default %s): " default-var)
6042 default-var)
6043 (read-variable "Set variable: ")))
6044 (minibuffer-help-form '(describe-variable var))
6045 (prop (get var 'variable-interactive))
6046 (obsolete (car (get var 'byte-obsolete-variable)))
6047 (prompt (format "Set %s %s to value: " var
6048 (cond ((local-variable-p var)
6049 "(buffer-local)")
6050 ((or current-prefix-arg
6051 (local-variable-if-set-p var))
6052 "buffer-locally")
6053 (t "globally"))))
6054 (val (progn
6055 (when obsolete
6056 (message (concat "`%S' is obsolete; "
6057 (if (symbolp obsolete) "use `%S' instead" "%s"))
6058 var obsolete)
6059 (sit-for 3))
6060 (if prop
6061 ;; Use VAR's `variable-interactive' property
6062 ;; as an interactive spec for prompting.
6063 (call-interactively `(lambda (arg)
6064 (interactive ,prop)
6065 arg))
6066 (read
6067 (read-string prompt nil
6068 'set-variable-value-history
6069 (format "%S" (symbol-value var))))))))
6070 (list var val current-prefix-arg)))
6072 (and (custom-variable-p variable)
6073 (not (get variable 'custom-type))
6074 (custom-load-symbol variable))
6075 (let ((type (get variable 'custom-type)))
6076 (when type
6077 ;; Match with custom type.
6078 (require 'cus-edit)
6079 (setq type (widget-convert type))
6080 (unless (widget-apply type :match value)
6081 (error "Value `%S' does not match type %S of %S"
6082 value (car type) variable))))
6084 (if make-local
6085 (make-local-variable variable))
6087 (set variable value)
6089 ;; Force a thorough redisplay for the case that the variable
6090 ;; has an effect on the display, like `tab-width' has.
6091 (force-mode-line-update))
6092 \f
6093 ;; Define the major mode for lists of completions.
6095 (defvar completion-list-mode-map
6096 (let ((map (make-sparse-keymap)))
6097 (define-key map [mouse-2] 'mouse-choose-completion)
6098 (define-key map [follow-link] 'mouse-face)
6099 (define-key map [down-mouse-2] nil)
6100 (define-key map "\C-m" 'choose-completion)
6101 (define-key map "\e\e\e" 'delete-completion-window)
6102 (define-key map [left] 'previous-completion)
6103 (define-key map [right] 'next-completion)
6104 (define-key map "q" 'quit-window)
6105 (define-key map "z" 'kill-this-buffer)
6106 map)
6107 "Local map for completion list buffers.")
6109 ;; Completion mode is suitable only for specially formatted data.
6110 (put 'completion-list-mode 'mode-class 'special)
6112 (defvar completion-reference-buffer nil
6113 "Record the buffer that was current when the completion list was requested.
6114 This is a local variable in the completion list buffer.
6115 Initial value is nil to avoid some compiler warnings.")
6117 (defvar completion-no-auto-exit nil
6118 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6119 This also applies to other functions such as `choose-completion'.")
6121 (defvar completion-base-position nil
6122 "Position of the base of the text corresponding to the shown completions.
6123 This variable is used in the *Completions* buffers.
6124 Its value is a list of the form (START END) where START is the place
6125 where the completion should be inserted and END (if non-nil) is the end
6126 of the text to replace. If END is nil, point is used instead.")
6128 (defvar completion-list-insert-choice-function #'completion--replace
6129 "Function to use to insert the text chosen in *Completions*.
6130 Called with three arguments (BEG END TEXT), it should replace the text
6131 between BEG and END with TEXT. Expected to be set buffer-locally
6132 in the *Completions* buffer.")
6134 (defvar completion-base-size nil
6135 "Number of chars before point not involved in completion.
6136 This is a local variable in the completion list buffer.
6137 It refers to the chars in the minibuffer if completing in the
6138 minibuffer, or in `completion-reference-buffer' otherwise.
6139 Only characters in the field at point are included.
6141 If nil, Emacs determines which part of the tail end of the
6142 buffer's text is involved in completion by comparing the text
6143 directly.")
6144 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6146 (defun delete-completion-window ()
6147 "Delete the completion list window.
6148 Go to the window from which completion was requested."
6149 (interactive)
6150 (let ((buf completion-reference-buffer))
6151 (if (one-window-p t)
6152 (if (window-dedicated-p (selected-window))
6153 (delete-frame (selected-frame)))
6154 (delete-window (selected-window))
6155 (if (get-buffer-window buf)
6156 (select-window (get-buffer-window buf))))))
6158 (defun previous-completion (n)
6159 "Move to the previous item in the completion list."
6160 (interactive "p")
6161 (next-completion (- n)))
6163 (defun next-completion (n)
6164 "Move to the next item in the completion list.
6165 With prefix argument N, move N items (negative N means move backward)."
6166 (interactive "p")
6167 (let ((beg (point-min)) (end (point-max)))
6168 (while (and (> n 0) (not (eobp)))
6169 ;; If in a completion, move to the end of it.
6170 (when (get-text-property (point) 'mouse-face)
6171 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6172 ;; Move to start of next one.
6173 (unless (get-text-property (point) 'mouse-face)
6174 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6175 (setq n (1- n)))
6176 (while (and (< n 0) (not (bobp)))
6177 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6178 ;; If in a completion, move to the start of it.
6179 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6180 (goto-char (previous-single-property-change
6181 (point) 'mouse-face nil beg)))
6182 ;; Move to end of the previous completion.
6183 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6184 (goto-char (previous-single-property-change
6185 (point) 'mouse-face nil beg)))
6186 ;; Move to the start of that one.
6187 (goto-char (previous-single-property-change
6188 (point) 'mouse-face nil beg))
6189 (setq n (1+ n))))))
6191 (defun choose-completion (&optional event)
6192 "Choose the completion at point."
6193 (interactive (list last-nonmenu-event))
6194 ;; In case this is run via the mouse, give temporary modes such as
6195 ;; isearch a chance to turn off.
6196 (run-hooks 'mouse-leave-buffer-hook)
6197 (with-current-buffer (window-buffer (posn-window (event-start event)))
6198 (let ((buffer completion-reference-buffer)
6199 (base-size completion-base-size)
6200 (base-position completion-base-position)
6201 (insert-function completion-list-insert-choice-function)
6202 (choice
6203 (save-excursion
6204 (goto-char (posn-point (event-start event)))
6205 (let (beg end)
6206 (cond
6207 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6208 (setq end (point) beg (1+ (point))))
6209 ((and (not (bobp))
6210 (get-text-property (1- (point)) 'mouse-face))
6211 (setq end (1- (point)) beg (point)))
6212 (t (error "No completion here")))
6213 (setq beg (previous-single-property-change beg 'mouse-face))
6214 (setq end (or (next-single-property-change end 'mouse-face)
6215 (point-max)))
6216 (buffer-substring-no-properties beg end)))))
6218 (unless (buffer-live-p buffer)
6219 (error "Destination buffer is dead"))
6220 (quit-window nil (posn-window (event-start event)))
6222 (with-current-buffer buffer
6223 (choose-completion-string
6224 choice buffer
6225 (or base-position
6226 (when base-size
6227 ;; Someone's using old completion code that doesn't know
6228 ;; about base-position yet.
6229 (list (+ base-size (field-beginning))))
6230 ;; If all else fails, just guess.
6231 (list (choose-completion-guess-base-position choice)))
6232 insert-function)))))
6234 ;; Delete the longest partial match for STRING
6235 ;; that can be found before POINT.
6236 (defun choose-completion-guess-base-position (string)
6237 (save-excursion
6238 (let ((opoint (point))
6239 len)
6240 ;; Try moving back by the length of the string.
6241 (goto-char (max (- (point) (length string))
6242 (minibuffer-prompt-end)))
6243 ;; See how far back we were actually able to move. That is the
6244 ;; upper bound on how much we can match and delete.
6245 (setq len (- opoint (point)))
6246 (if completion-ignore-case
6247 (setq string (downcase string)))
6248 (while (and (> len 0)
6249 (let ((tail (buffer-substring (point) opoint)))
6250 (if completion-ignore-case
6251 (setq tail (downcase tail)))
6252 (not (string= tail (substring string 0 len)))))
6253 (setq len (1- len))
6254 (forward-char 1))
6255 (point))))
6257 (defun choose-completion-delete-max-match (string)
6258 (delete-region (choose-completion-guess-base-position string) (point)))
6259 (make-obsolete 'choose-completion-delete-max-match
6260 'choose-completion-guess-base-position "23.2")
6262 (defvar choose-completion-string-functions nil
6263 "Functions that may override the normal insertion of a completion choice.
6264 These functions are called in order with four arguments:
6265 CHOICE - the string to insert in the buffer,
6266 BUFFER - the buffer in which the choice should be inserted,
6267 MINI-P - non-nil if BUFFER is a minibuffer, and
6268 BASE-SIZE - the number of characters in BUFFER before
6269 the string being completed.
6271 If a function in the list returns non-nil, that function is supposed
6272 to have inserted the CHOICE in the BUFFER, and possibly exited
6273 the minibuffer; no further functions will be called.
6275 If all functions in the list return nil, that means to use
6276 the default method of inserting the completion in BUFFER.")
6278 (defun choose-completion-string (choice &optional
6279 buffer base-position insert-function)
6280 "Switch to BUFFER and insert the completion choice CHOICE.
6281 BASE-POSITION, says where to insert the completion."
6283 ;; If BUFFER is the minibuffer, exit the minibuffer
6284 ;; unless it is reading a file name and CHOICE is a directory,
6285 ;; or completion-no-auto-exit is non-nil.
6287 ;; Some older code may call us passing `base-size' instead of
6288 ;; `base-position'. It's difficult to make any use of `base-size',
6289 ;; so we just ignore it.
6290 (unless (consp base-position)
6291 (message "Obsolete `base-size' passed to choose-completion-string")
6292 (setq base-position nil))
6294 (let* ((buffer (or buffer completion-reference-buffer))
6295 (mini-p (minibufferp buffer)))
6296 ;; If BUFFER is a minibuffer, barf unless it's the currently
6297 ;; active minibuffer.
6298 (if (and mini-p
6299 (not (and (active-minibuffer-window)
6300 (equal buffer
6301 (window-buffer (active-minibuffer-window))))))
6302 (error "Minibuffer is not active for completion")
6303 ;; Set buffer so buffer-local choose-completion-string-functions works.
6304 (set-buffer buffer)
6305 (unless (run-hook-with-args-until-success
6306 'choose-completion-string-functions
6307 ;; The fourth arg used to be `mini-p' but was useless
6308 ;; (since minibufferp can be used on the `buffer' arg)
6309 ;; and indeed unused. The last used to be `base-size', so we
6310 ;; keep it to try and avoid breaking old code.
6311 choice buffer base-position nil)
6312 ;; This remove-text-properties should be unnecessary since `choice'
6313 ;; comes from buffer-substring-no-properties.
6314 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6315 ;; Insert the completion into the buffer where it was requested.
6316 (funcall (or insert-function completion-list-insert-choice-function)
6317 (or (car base-position) (point))
6318 (or (cadr base-position) (point))
6319 choice)
6320 ;; Update point in the window that BUFFER is showing in.
6321 (let ((window (get-buffer-window buffer t)))
6322 (set-window-point window (point)))
6323 ;; If completing for the minibuffer, exit it with this choice.
6324 (and (not completion-no-auto-exit)
6325 (minibufferp buffer)
6326 minibuffer-completion-table
6327 ;; If this is reading a file name, and the file name chosen
6328 ;; is a directory, don't exit the minibuffer.
6329 (let* ((result (buffer-substring (field-beginning) (point)))
6330 (bounds
6331 (completion-boundaries result minibuffer-completion-table
6332 minibuffer-completion-predicate
6333 "")))
6334 (if (eq (car bounds) (length result))
6335 ;; The completion chosen leads to a new set of completions
6336 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6337 (let ((mini (active-minibuffer-window)))
6338 (select-window mini)
6339 (when minibuffer-auto-raise
6340 (raise-frame (window-frame mini))))
6341 (exit-minibuffer))))))))
6343 (define-derived-mode completion-list-mode nil "Completion List"
6344 "Major mode for buffers showing lists of possible completions.
6346 to select the completion near point.
6348 with the mouse.
6351 (set (make-local-variable 'completion-base-size) nil))
6353 (defun completion-list-mode-finish ()
6354 "Finish setup of the completions buffer.
6355 Called from `temp-buffer-show-hook'."
6356 (when (eq major-mode 'completion-list-mode)
6357 (setq buffer-read-only t)))
6359 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6362 ;; Variables and faces used in `completion-setup-function'.
6364 (defcustom completion-show-help t
6365 "Non-nil means show help message in *Completions* buffer."
6366 :type 'boolean
6367 :version "22.1"
6368 :group 'completion)
6370 ;; This function goes in completion-setup-hook, so that it is called
6371 ;; after the text of the completion list buffer is written.
6372 (defun completion-setup-function ()
6373 (let* ((mainbuf (current-buffer))
6374 (base-dir
6375 ;; When reading a file name in the minibuffer,
6376 ;; try and find the right default-directory to set in the
6377 ;; completion list buffer.
6378 ;; FIXME: Why do we do that, actually? --Stef
6379 (if minibuffer-completing-file-name
6380 (file-name-as-directory
6381 (expand-file-name
6382 (substring (minibuffer-completion-contents)
6383 0 (or completion-base-size 0)))))))
6384 (with-current-buffer standard-output
6385 (let ((base-size completion-base-size) ;Read before killing localvars.
6386 (base-position completion-base-position)
6387 (insert-fun completion-list-insert-choice-function))
6388 (completion-list-mode)
6389 (set (make-local-variable 'completion-base-size) base-size)
6390 (set (make-local-variable 'completion-base-position) base-position)
6391 (set (make-local-variable 'completion-list-insert-choice-function)
6392 insert-fun))
6393 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6394 (if base-dir (setq default-directory base-dir))
6395 ;; Maybe insert help string.
6396 (when completion-show-help
6397 (goto-char (point-min))
6398 (if (display-mouse-p)
6399 (insert (substitute-command-keys
6401 (insert (substitute-command-keys
6405 (add-hook 'completion-setup-hook 'completion-setup-function)
6407 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6408 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6410 (defun switch-to-completions ()
6411 "Select the completion list window."
6412 (interactive)
6413 (let ((window (or (get-buffer-window "*Completions*" 0)
6414 ;; Make sure we have a completions window.
6415 (progn (minibuffer-completion-help)
6416 (get-buffer-window "*Completions*" 0)))))
6417 (when window
6418 (select-window window)
6419 ;; In the new buffer, go to the first completion.
6420 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6421 (when (bobp)
6422 (next-completion 1)))))
6423 \f
6424 ;;; Support keyboard commands to turn on various modifiers.
6426 ;; These functions -- which are not commands -- each add one modifier
6427 ;; to the following event.
6429 (defun event-apply-alt-modifier (_ignore-prompt)
6432 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6433 (defun event-apply-super-modifier (_ignore-prompt)
6436 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6437 (defun event-apply-hyper-modifier (_ignore-prompt)
6440 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6441 (defun event-apply-shift-modifier (_ignore-prompt)
6444 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6445 (defun event-apply-control-modifier (_ignore-prompt)
6448 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6449 (defun event-apply-meta-modifier (_ignore-prompt)
6452 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6454 (defun event-apply-modifier (event symbol lshiftby prefix)
6455 "Apply a modifier flag to event EVENT.
6456 SYMBOL is the name of this modifier, as a symbol.
6457 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6458 PREFIX is the string that represents this modifier in an event type symbol."
6459 (if (numberp event)
6460 (cond ((eq symbol 'control)
6461 (if (and (<= (downcase event) ?z)
6462 (>= (downcase event) ?a))
6463 (- (downcase event) ?a -1)
6464 (if (and (<= (downcase event) ?Z)
6465 (>= (downcase event) ?A))
6466 (- (downcase event) ?A -1)
6467 (logior (lsh 1 lshiftby) event))))
6468 ((eq symbol 'shift)
6469 (if (and (<= (downcase event) ?z)
6470 (>= (downcase event) ?a))
6471 (upcase event)
6472 (logior (lsh 1 lshiftby) event)))
6473 (t
6474 (logior (lsh 1 lshiftby) event)))
6475 (if (memq symbol (event-modifiers event))
6476 event
6477 (let ((event-type (if (symbolp event) event (car event))))
6478 (setq event-type (intern (concat prefix (symbol-name event-type))))
6479 (if (symbolp event)
6480 event-type
6481 (cons event-type (cdr event)))))))
6483 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6484 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6485 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6486 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6487 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6488 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6489 \f
6490 ;;;; Keypad support.
6492 ;; Make the keypad keys act like ordinary typing keys. If people add
6493 ;; bindings for the function key symbols, then those bindings will
6494 ;; override these, so this shouldn't interfere with any existing
6495 ;; bindings.
6497 ;; Also tell read-char how to handle these keys.
6498 (mapc
6499 (lambda (keypad-normal)
6500 (let ((keypad (nth 0 keypad-normal))
6501 (normal (nth 1 keypad-normal)))
6502 (put keypad 'ascii-character normal)
6503 (define-key function-key-map (vector keypad) (vector normal))))
6504 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6505 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6506 (kp-space ?\s)
6509 (kp-multiply ?*)
6510 (kp-add ?+)
6511 (kp-separator ?,)
6512 (kp-subtract ?-)
6513 (kp-decimal ?.)
6514 (kp-divide ?/)
6515 (kp-equal ?=)
6516 ;; Do the same for various keys that are represented as symbols under
6517 ;; GUIs but naturally correspond to characters.
6518 (backspace 127)
6519 (delete 127)
6522 (clear ?\C-l)
6523 (return ?\C-m)
6524 (escape ?\e)
6525 ))
6526 \f
6527 ;;;;
6528 ;;;; forking a twin copy of a buffer.
6529 ;;;;
6531 (defvar clone-buffer-hook nil
6532 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6534 (defvar clone-indirect-buffer-hook nil
6535 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6537 (defun clone-process (process &optional newname)
6538 "Create a twin copy of PROCESS.
6539 If NEWNAME is nil, it defaults to PROCESS' name;
6540 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6541 If PROCESS is associated with a buffer, the new process will be associated
6542 with the current buffer instead.
6543 Returns nil if PROCESS has already terminated."
6544 (setq newname (or newname (process-name process)))
6546 (setq newname (substring newname 0 (match-beginning 0))))
6547 (when (memq (process-status process) '(run stop open))
6548 (let* ((process-connection-type (process-tty-name process))
6549 (new-process
6550 (if (memq (process-status process) '(open))
6551 (let ((args (process-contact process t)))
6552 (setq args (plist-put args :name newname))
6553 (setq args (plist-put args :buffer
6554 (if (process-buffer process)
6555 (current-buffer))))
6556 (apply 'make-network-process args))
6557 (apply 'start-process newname
6558 (if (process-buffer process) (current-buffer))
6559 (process-command process)))))
6560 (set-process-query-on-exit-flag
6561 new-process (process-query-on-exit-flag process))
6562 (set-process-inherit-coding-system-flag
6563 new-process (process-inherit-coding-system-flag process))
6564 (set-process-filter new-process (process-filter process))
6565 (set-process-sentinel new-process (process-sentinel process))
6566 (set-process-plist new-process (copy-sequence (process-plist process)))
6567 new-process)))
6569 ;; things to maybe add (currently partly covered by `funcall mode'):
6570 ;; - syntax-table
6571 ;; - overlays
6572 (defun clone-buffer (&optional newname display-flag)
6573 "Create and return a twin copy of the current buffer.
6574 Unlike an indirect buffer, the new buffer can be edited
6575 independently of the old one (if it is not read-only).
6576 NEWNAME is the name of the new buffer. It may be modified by
6577 adding or incrementing <N> at the end as necessary to create a
6578 unique buffer name. If nil, it defaults to the name of the
6579 current buffer, with the proper suffix. If DISPLAY-FLAG is
6580 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6581 clone a file-visiting buffer, or a buffer whose major mode symbol
6582 has a non-nil `no-clone' property, results in an error.
6584 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6585 current buffer with appropriate suffix. However, if a prefix
6586 argument is given, then the command prompts for NEWNAME in the
6587 minibuffer.
6589 This runs the normal hook `clone-buffer-hook' in the new buffer
6590 after it has been set up properly in other respects."
6591 (interactive
6592 (progn
6593 (if buffer-file-name
6594 (error "Cannot clone a file-visiting buffer"))
6595 (if (get major-mode 'no-clone)
6596 (error "Cannot clone a buffer in %s mode" mode-name))
6597 (list (if current-prefix-arg
6598 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6599 t)))
6600 (if buffer-file-name
6601 (error "Cannot clone a file-visiting buffer"))
6602 (if (get major-mode 'no-clone)
6603 (error "Cannot clone a buffer in %s mode" mode-name))
6604 (setq newname (or newname (buffer-name)))
6606 (setq newname (substring newname 0 (match-beginning 0))))
6607 (let ((buf (current-buffer))
6608 (ptmin (point-min))
6609 (ptmax (point-max))
6610 (pt (point))
6611 (mk (if mark-active (mark t)))
6612 (modified (buffer-modified-p))
6613 (mode major-mode)
6614 (lvars (buffer-local-variables))
6615 (process (get-buffer-process (current-buffer)))
6616 (new (generate-new-buffer (or newname (buffer-name)))))
6617 (save-restriction
6618 (widen)
6619 (with-current-buffer new
6620 (insert-buffer-substring buf)))
6621 (with-current-buffer new
6622 (narrow-to-region ptmin ptmax)
6623 (goto-char pt)
6624 (if mk (set-mark mk))
6625 (set-buffer-modified-p modified)
6627 ;; Clone the old buffer's process, if any.
6628 (when process (clone-process process))
6630 ;; Now set up the major mode.
6631 (funcall mode)
6633 ;; Set up other local variables.
6634 (mapc (lambda (v)
6635 (condition-case () ;in case var is read-only
6636 (if (symbolp v)
6637 (makunbound v)
6638 (set (make-local-variable (car v)) (cdr v)))
6639 (error nil)))
6640 lvars)
6642 ;; Run any hooks (typically set up by the major mode
6643 ;; for cloning to work properly).
6644 (run-hooks 'clone-buffer-hook))
6645 (if display-flag
6646 ;; Presumably the current buffer is shown in the selected frame, so
6647 ;; we want to display the clone elsewhere.
6648 (let ((same-window-regexps nil)
6649 (same-window-buffer-names))
6650 (pop-to-buffer new)))
6651 new))
6654 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6655 "Create an indirect buffer that is a twin copy of the current buffer.
6657 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6658 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6659 or if not called with a prefix arg, NEWNAME defaults to the current
6660 buffer's name. The name is modified by adding a `<N>' suffix to it
6661 or by incrementing the N in an existing suffix. Trying to clone a
6662 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6663 property results in an error.
6665 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6666 This is always done when called interactively.
6668 Optional third arg NORECORD non-nil means do not put this buffer at the
6669 front of the list of recently selected ones."
6670 (interactive
6671 (progn
6672 (if (get major-mode 'no-clone-indirect)
6673 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6674 (list (if current-prefix-arg
6675 (read-buffer "Name of indirect buffer: " (current-buffer)))
6676 t)))
6677 (if (get major-mode 'no-clone-indirect)
6678 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6679 (setq newname (or newname (buffer-name)))
6681 (setq newname (substring newname 0 (match-beginning 0))))
6682 (let* ((name (generate-new-buffer-name newname))
6683 (buffer (make-indirect-buffer (current-buffer) name t)))
6684 (with-current-buffer buffer
6685 (run-hooks 'clone-indirect-buffer-hook))
6686 (when display-flag
6687 (pop-to-buffer buffer norecord))
6688 buffer))
6691 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6692 "Like `clone-indirect-buffer' but display in another window."
6693 (interactive
6694 (progn
6695 (if (get major-mode 'no-clone-indirect)
6696 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6697 (list (if current-prefix-arg
6698 (read-buffer "Name of indirect buffer: " (current-buffer)))
6699 t)))
6700 (let ((pop-up-windows t))
6701 (clone-indirect-buffer newname display-flag norecord)))
6703 \f
6704 ;;; Handling of Backspace and Delete keys.
6706 (defcustom normal-erase-is-backspace 'maybe
6707 "Set the default behavior of the Delete and Backspace keys.
6709 If set to t, Delete key deletes forward and Backspace key deletes
6710 backward.
6712 If set to nil, both Delete and Backspace keys delete backward.
6714 If set to 'maybe (which is the default), Emacs automatically
6715 selects a behavior. On window systems, the behavior depends on
6716 the keyboard used. If the keyboard has both a Backspace key and
6717 a Delete key, and both are mapped to their usual meanings, the
6718 option's default value is set to t, so that Backspace can be used
6719 to delete backward, and Delete can be used to delete forward.
6721 If not running under a window system, customizing this option
6722 accomplishes a similar effect by mapping C-h, which is usually
6723 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6724 via `keyboard-translate'. The former functionality of C-h is
6725 available on the F1 key. You should probably not use this
6726 setting if you don't have both Backspace, Delete and F1 keys.
6728 Setting this variable with setq doesn't take effect. Programmatically,
6729 call `normal-erase-is-backspace-mode' (which see) instead."
6730 :type '(choice (const :tag "Off" nil)
6731 (const :tag "Maybe" maybe)
6732 (other :tag "On" t))
6733 :group 'editing-basics
6734 :version "21.1"
6735 :set (lambda (symbol value)
6736 ;; The fboundp is because of a problem with :set when
6737 ;; dumping Emacs. It doesn't really matter.
6738 (if (fboundp 'normal-erase-is-backspace-mode)
6739 (normal-erase-is-backspace-mode (or value 0))
6740 (set-default symbol value))))
6742 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6743 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6744 (unless frame (setq frame (selected-frame)))
6745 (with-selected-frame frame
6746 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6747 (normal-erase-is-backspace-mode
6748 (if (if (eq normal-erase-is-backspace 'maybe)
6749 (and (not noninteractive)
6750 (or (memq system-type '(ms-dos windows-nt))
6751 (memq window-system '(ns))
6752 (and (memq window-system '(x))
6753 (fboundp 'x-backspace-delete-keys-p)
6754 (x-backspace-delete-keys-p))
6755 ;; If the terminal Emacs is running on has erase char
6756 ;; set to ^H, use the Backspace key for deleting
6757 ;; backward, and the Delete key for deleting forward.
6758 (and (null window-system)
6759 (eq tty-erase-char ?\^H))))
6760 normal-erase-is-backspace)
6761 1 0)))))
6763 (define-minor-mode normal-erase-is-backspace-mode
6764 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6765 With a prefix argument ARG, enable this feature if ARG is
6766 positive, and disable it otherwise. If called from Lisp, enable
6767 the mode if ARG is omitted or nil.
6769 On window systems, when this mode is on, Delete is mapped to C-d
6770 and Backspace is mapped to DEL; when this mode is off, both
6771 Delete and Backspace are mapped to DEL. (The remapping goes via
6772 `local-function-key-map', so binding Delete or Backspace in the
6773 global or local keymap will override that.)
6775 In addition, on window systems, the bindings of C-Delete, M-Delete,
6776 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6777 the global keymap in accordance with the functionality of Delete and
6778 Backspace. For example, if Delete is remapped to C-d, which deletes
6779 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6780 to DEL, which deletes backward, C-Delete is bound to
6781 `backward-kill-word'.
6783 If not running on a window system, a similar effect is accomplished by
6784 remapping C-h (normally produced by the Backspace key) and DEL via
6785 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6786 to C-d; if it's off, the keys are not remapped.
6788 When not running on a window system, and this mode is turned on, the
6789 former functionality of C-h is available on the F1 key. You should
6790 probably not turn on this mode on a text-only terminal if you don't
6791 have both Backspace, Delete and F1 keys.
6793 See also `normal-erase-is-backspace'."
6794 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
6795 . (lambda (v)
6796 (setf (terminal-parameter nil 'normal-erase-is-backspace)
6797 (if v 1 0))))
6798 (let ((enabled (eq 1 (terminal-parameter
6799 nil 'normal-erase-is-backspace))))
6801 (cond ((or (memq window-system '(x w32 ns pc))
6802 (memq system-type '(ms-dos windows-nt)))
6803 (let ((bindings
6804 `(([M-delete] [M-backspace])
6805 ([C-M-delete] [C-M-backspace])
6806 ([?\e C-delete] [?\e C-backspace]))))
6808 (if enabled
6809 (progn
6810 (define-key local-function-key-map [delete] [deletechar])
6811 (define-key local-function-key-map [kp-delete] [?\C-d])
6812 (define-key local-function-key-map [backspace] [?\C-?])
6813 (dolist (b bindings)
6814 ;; Not sure if input-decode-map is really right, but
6815 ;; keyboard-translate-table (used below) only works
6816 ;; for integer events, and key-translation-table is
6817 ;; global (like the global-map, used earlier).
6818 (define-key input-decode-map (car b) nil)
6819 (define-key input-decode-map (cadr b) nil)))
6820 (define-key local-function-key-map [delete] [?\C-?])
6821 (define-key local-function-key-map [kp-delete] [?\C-?])
6822 (define-key local-function-key-map [backspace] [?\C-?])
6823 (dolist (b bindings)
6824 (define-key input-decode-map (car b) (cadr b))
6825 (define-key input-decode-map (cadr b) (car b))))))
6826 (t
6827 (if enabled
6828 (progn
6829 (keyboard-translate ?\C-h ?\C-?)
6830 (keyboard-translate ?\C-? ?\C-d))
6831 (keyboard-translate ?\C-h ?\C-h)
6832 (keyboard-translate ?\C-? ?\C-?))))
6834 (if (called-interactively-p 'interactive)
6835 (message "Delete key deletes %s"
6836 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6837 "forward" "backward")))))
6838 \f
6839 (defvar vis-mode-saved-buffer-invisibility-spec nil
6840 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6842 (define-minor-mode visible-mode
6843 "Toggle making all invisible text temporarily visible (Visible mode).
6844 With a prefix argument ARG, enable Visible mode if ARG is
6845 positive, and disable it otherwise. If called from Lisp, enable
6846 the mode if ARG is omitted or nil.
6848 This mode works by saving the value of `buffer-invisibility-spec'
6849 and setting it to nil."
6850 :lighter " Vis"
6851 :group 'editing-basics
6852 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6853 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6854 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6855 (when visible-mode
6856 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6857 buffer-invisibility-spec)
6858 (setq buffer-invisibility-spec nil)))
6859 \f
6860 ;; Minibuffer prompt stuff.
6862 ;;(defun minibuffer-prompt-modification (start end)
6863 ;; (error "You cannot modify the prompt"))
6864 ;;
6865 ;;
6866 ;;(defun minibuffer-prompt-insertion (start end)
6867 ;; (let ((inhibit-modification-hooks t))
6868 ;; (delete-region start end)
6869 ;; ;; Discard undo information for the text insertion itself
6870 ;; ;; and for the text deletion.above.
6871 ;; (when (consp buffer-undo-list)
6872 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6873 ;; (message "You cannot modify the prompt")))
6874 ;;
6875 ;;
6876 ;;(setq minibuffer-prompt-properties
6877 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6878 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6880 \f
6881 ;;;; Problematic external packages.
6883 ;; rms says this should be done by specifying symbols that define
6884 ;; versions together with bad values. This is therefore not as
6885 ;; flexible as it could be. See the thread:
6886 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6887 (defconst bad-packages-alist
6888 ;; Not sure exactly which semantic versions have problems.
6889 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6891 "The version of `semantic' loaded does not work in Emacs 22.
6892 It can cause constant high CPU load.
6893 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6894 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6895 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6896 ;; provided the `CUA-mode' feature. Since this is no longer true,
6897 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6898 (CUA-mode t nil
6899 "CUA-mode is now part of the standard GNU Emacs distribution,
6900 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6902 You have loaded an older version of CUA-mode which does not work
6903 correctly with this version of Emacs. You should remove the old
6904 version and use the one distributed with Emacs."))
6905 "Alist of packages known to cause problems in this version of Emacs.
6906 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6907 PACKAGE is either a regular expression to match file names, or a
6908 symbol (a feature name); see the documentation of
6909 `after-load-alist', to which this variable adds functions.
6910 SYMBOL is either the name of a string variable, or `t'. Upon
6911 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6912 warning using STRING as the message.")
6914 (defun bad-package-check (package)
6915 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6916 (condition-case nil
6917 (let* ((list (assoc package bad-packages-alist))
6918 (symbol (nth 1 list)))
6919 (and list
6920 (boundp symbol)
6921 (or (eq symbol t)
6922 (and (stringp (setq symbol (eval symbol)))
6923 (string-match-p (nth 2 list) symbol)))
6924 (display-warning package (nth 3 list) :warning)))
6925 (error nil)))
6927 (mapc (lambda (elem)
6928 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6929 bad-packages-alist)
6932 (provide 'simple)
6934 ;;; simple.el ends here