| blob | d06a04aa5dc0992a4f501c4880dbbbb123705448 |
1 ;;; simple.el --- basic editing commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1993-2013 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.
368 map))
372 "Parent major mode from which special major modes should inherit."
375 ;; Major mode meant to be the parent of programming modes.
380 map)
384 "Indent the expression after point."
391 "Major mode for editing programming language source code."
394 ;; Any programming language is always written left to right.
397 ;; Making and deleting lines.
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
416 ;; Don't auto-fill if we have a numeric argument.
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
422 ;; Mark the newline(s) `hard'.
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
448 nil)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
467 ;; Don't expand an abbrev before point.
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
485 When called from Lisp code, ARG may be a prefix string to copy."
490 ;; What prefix should we check for (nil means don't).
494 ;; Does this line start with it?
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
535 ;; Set singleblank if there is just one blank line here.
542 ;; Delete preceding blank lines, and this one too if it's the only one.
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
568 Trailing lines are deleted only if `delete-trailing-whitespace'
569 is called on the entire buffer (rather than an active region)."
575 "Delete trailing whitespace between START and END.
576 If called interactively, START and END are the start/end of the
577 region if the mark is active, or of the buffer's accessible
578 portion if the mark is inactive.
580 This command deletes whitespace characters after the last
581 non-whitespace character in each line between START and END. It
582 does not consider formfeed characters to be whitespace.
584 If this command acts on the entire buffer (i.e. if called
585 interactively with the mark inactive, or called from Lisp with
586 END nil), it also deletes all trailing lines at the end of the
587 buffer if the variable `delete-trailing-lines' is non-nil."
600 ;; Don't delete formfeeds, even if they are considered whitespace.
604 ;; Delete trailing empty lines.
607 delete-trailing-lines
608 ;; Really the end of buffer.
613 ;; Return nil for the benefit of `write-file-functions'.
614 nil)
617 "Insert a newline, then indent according to major mode.
618 Indentation is done using the value of `indent-line-function'.
619 In programming language modes, this is the same as TAB.
620 In some text modes, where TAB inserts a tab, this command indents to the
621 column specified by the function `current-left-margin'."
628 "Reindent current line, insert newline, then indent the new line.
629 Indentation of both lines is done according to the current major mode,
630 which means calling the current value of `indent-line-function'.
631 In programming language modes, this is the same as TAB.
632 In some text modes, where TAB inserts a tab, this indents to the
633 column specified by the function `current-left-margin'."
636 ;; Be careful to insert the newline before indenting the line.
637 ;; Otherwise, the indentation might be wrong.
641 ;; We are at EOL before the call to indent-according-to-mode, and
642 ;; after it we usually are as well, but not always. We tried to
643 ;; address it with `save-excursion' but that uses a normal marker
644 ;; whereas we need `move after insertion', so we do the save/restore
645 ;; by hand.
649 ;; Remove the trailing white-space after indentation because
650 ;; indentation may introduce the whitespace.
655 "Read next input character and insert it.
656 This is useful for inserting control characters.
657 With argument, insert ARG copies of the character.
659 If the first character you type after this command is an octal digit,
660 you should type a sequence of octal digits which specify a character code.
661 Any nondigit terminates the sequence. If the terminator is a RET,
662 it is discarded; any other terminator is used itself as input.
663 The variable `read-quoted-char-radix' specifies the radix for this feature;
664 set it to 10 or 16 to use decimal or hex instead of octal.
666 In overwrite mode, this function inserts the character anyway, and
667 does not handle octal digits specially. This means that if you use
668 overwrite as your normal editing mode, you can use this function to
669 insert characters when necessary.
671 In binary overwrite mode, this function does overwrite, and octal
672 digits are interpreted as a character code. This is intended to be
673 useful for editing binary files."
676 ;; Avoid "obsolete" warnings for translation-table-for-input.
683 ;; This used to assume character codes 0240 - 0377 stand for
684 ;; characters in some single-byte character set, and converted them
685 ;; to Emacs characters. But in 23.1 this feature is deprecated
686 ;; in favor of inserting the corresponding Unicode characters.
687 ;; (if (and enable-multibyte-characters
688 ;; (>= char ?\240)
689 ;; (<= char ?\377))
690 ;; (setq char (unibyte-char-to-multibyte char)))
699 "Move forward ARG lines and position at first nonblank character."
705 "Move backward ARG lines and position at first nonblank character."
711 "Move point to the first non-whitespace character on this line."
715 ;; Move back over chars that have whitespace syntax but have the p flag.
719 "Fixup white space between objects around point.
720 Leave one space or none, according to the context."
727 nil
731 "Delete all spaces and tabs around point.
732 If BACKWARD-ONLY is non-nil, only delete them before point."
737 orig-pos
746 "Delete all spaces and tabs around point, leaving one space (or N spaces).
747 If N is negative, delete newlines as well, leaving -N spaces."
764 \f
766 "Move point to the beginning of the buffer.
767 With numeric arg N, put point N/10 of the way from the beginning.
768 If the buffer is narrowed, this command uses the beginning of the
769 accessible part of the buffer.
771 If Transient Mark mode is disabled, leave mark at previous
774 Don't use this command in Lisp programs!
775 \(goto-char (point-min)) is faster."
784 ;; Avoid overflow for large buffer sizes!
792 "Move point to the end of the buffer.
793 With numeric arg N, put point N/10 of the way from the end.
794 If the buffer is narrowed, this command uses the end of the
795 accessible part of the buffer.
797 If Transient Mark mode is disabled, leave mark at previous
800 Don't use this command in Lisp programs!
801 \(goto-char (point-max)) is faster."
808 ;; Avoid overflow for large buffer sizes!
813 ;; If we went to a place in the middle of the buffer,
814 ;; adjust it to the beginning of a line.
817 ;; If the end of the buffer is not already on the screen,
818 ;; then scroll specially to put it near, but not at, the bottom.
823 "Whether single-char deletion commands delete an active region.
824 This has an effect only if Transient Mark mode is enabled, and
825 affects `delete-forward-char' and `delete-backward-char', though
826 not `delete-char'.
828 If the value is the symbol `kill', the active region is killed
829 instead of deleted."
837 "Delete the previous N characters (following if N is negative).
838 If Transient Mark mode is enabled, the mark is active, and N is 1,
839 delete the text in the region and deactivate the mark instead.
840 To disable this, set `delete-active-region' to nil.
842 Optional second arg KILLFLAG, if non-nil, means to kill (save in
843 kill ring) instead of delete. Interactively, N is the prefix
844 arg, and KILLFLAG is set if N is explicitly specified.
846 In Overwrite mode, single character backward deletion may replace
847 tabs with spaces so as to back over columns, unless point is at
848 the end of the line."
853 delete-active-region
855 ;; If a region is active, kill or delete it.
859 ;; In Overwrite mode, maybe untabify while deleting
869 ;; Otherwise, do simple deletion.
873 "Delete the following N characters (previous if N is negative).
874 If Transient Mark mode is enabled, the mark is active, and N is 1,
875 delete the text in the region and deactivate the mark instead.
876 To disable this, set `delete-active-region' to nil.
878 Optional second arg KILLFLAG non-nil means to kill (save in kill
879 ring) instead of delete. Interactively, N is the prefix arg, and
880 KILLFLAG is set if N was explicitly specified."
885 delete-active-region
887 ;; If a region is active, kill or delete it.
891 ;; Otherwise, do simple deletion.
895 "Put point at beginning and mark at end of buffer.
896 If narrowing is in effect, only uses the accessible part of the buffer.
897 You probably should not use this function in Lisp programs;
898 it is usually a mistake for a Lisp function to use any subroutine
899 that uses or sets the mark."
904 \f
906 ;; Counting lines, one way or another.
909 "Go to LINE, counting from line 1 at beginning of buffer.
910 If called interactively, a numeric prefix argument specifies
911 LINE; without a numeric prefix argument, read LINE from the
912 minibuffer.
914 If optional argument BUFFER is non-nil, switch to that buffer and
916 as argument, BUFFER is the most recently selected other buffer.
918 Prior to moving point, this function sets the mark (without
919 activating it), unless Transient Mark mode is enabled and the
920 mark is already active.
922 This function is usually the wrong thing to use in a Lisp program.
923 What you probably want instead is something like:
924 (goto-char (point-min))
925 (forward-line (1- N))
926 If at all possible, an even better solution is to use char counts
927 rather than line counts."
931 ;; Look for a default, a number in the buffer at point.
941 ;; Decide if we're switching buffers.
949 ;; Read the argument, offering that number (if any) as default.
952 buffer))))
953 ;; Switch to the desired buffer, one way or another.
958 ;; Leave mark at previous position
960 ;; Move to the specified line number in that buffer.
969 "Count the number of words in the region.
970 If called interactively, print a message reporting the number of
971 lines, words, and characters in the region (whether or not the
972 region is active); with prefix ARG, report for the entire buffer
973 rather than the region.
975 If called from Lisp, return the number of words between positions
976 START and END."
988 "Count words between START and END.
989 If called interactively, START and END are normally the start and
990 end of the buffer; but if the region is active, START and END are
991 the start and end of the region. Print a message reporting the
992 number of lines, words, and chars.
994 If called from Lisp, return the number of words between START and
995 END, without printing any message."
1005 words))
1021 str
1029 "Print the current buffer line number and narrowed line number of point."
1042 "Return number of lines between START and END.
1043 This is usually the number of newlines between them,
1044 but can be one more if START is not equal to END
1045 and the greater of them is not at the start of a line."
1061 done)))
1065 "Return (narrowed) buffer line number at position POS.
1066 If POS is nil, use current buffer location.
1067 Counting starts at (point-min), so the value refers
1068 to the contents of the accessible portion of the buffer."
1078 "Print info on cursor position (on screen and within buffer).
1079 Also describe the character after point, and give its character code
1080 in octal, decimal and hex.
1082 For a non-ASCII multibyte character, also give its encoding in the
1083 buffer's selected coding system if the coding system encodes the
1084 character safely. If the character is encoded into one byte, that
1085 code is shown in hex. If the character is encoded into more than one
1088 In addition, with prefix argument, show details about that character
1089 in *Help* buffer. See also the command `describe-char'."
1094 ;; If the character is one of LRE, LRO, RLE, RLO, it
1095 ;; will start a directional embedding, which could
1096 ;; completely disrupt the rest of the line (e.g., RLO
1097 ;; will display the rest of the line right-to-left).
1098 ;; So we put an invisible PDF character after these
1099 ;; characters, to end the embedding, which eliminates
1100 ;; any effects on the rest of the line.
1102 ;; Strong right-to-left characters cause reordering of
1103 ;; the following numerical characters which show the
1104 ;; codepoint, so append LRM to countermand that.
1114 ;; Avoid overflow from multiplying by 100!
1118 ""
1124 pos total percent beg end col hscroll)
1126 pos total col hscroll))
1128 encoded encoding-msg display-prop under-display)
1135 ;; Check if the character is displayed with some `display'
1136 ;; text property. In that case, set under-display to the
1137 ;; buffer substring covered by that property.
1148 under-display)))
1154 char char char under-display)
1156 char char char under-display display-prop))
1159 char char char
1161 "..."
1165 ;; We show the detailed information about CHAR.
1172 bidi-fixer
1173 encoding-msg pos total percent beg end col hscroll)
1180 bidi-fixer encoding-msg pos total percent col hscroll))))))
1181 \f
1182 ;; Initialize read-expression-map. It is defined at C level.
1185 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1186 ;; too rarely useful.
1196 "The current default value or list of default values in the minibuffer.
1197 The functions `read-from-minibuffer' and `completing-read' bind
1201 "Value for `print-level' while printing value in `eval-expression'.
1202 A value of nil means no limit."
1208 "Value for `print-length' while printing value in `eval-expression'.
1209 A value of nil means no limit."
1215 "If non-nil set `debug-on-error' to t in `eval-expression'.
1216 If nil, don't change the value of `debug-on-error'."
1222 "Format VALUE as a result of evaluated expression.
1223 Return a formatted string which is displayed in the echo area
1224 in addition to the value printed by prin1 in functions which
1225 display the result of expression evaluation."
1238 ;; We define this, rather than making `eval' interactive,
1239 ;; for the sake of completion of names like eval-region, eval-buffer.
1242 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1243 When called interactively, read an Emacs Lisp expression and
1244 evaluate it.
1245 Value is also consed on to front of the variable `values'.
1246 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1247 with prefix argument) means insert the result into the current buffer
1248 instead of printing it in the echo area. Truncates long output
1249 according to the value of the variables `eval-expression-print-length'
1250 and `eval-expression-print-level'.
1252 If `eval-expression-debug-on-error' is non-nil, which is the default,
1253 this command arranges for all errors to enter the debugger."
1257 nil read-expression-map t
1259 current-prefix-arg))
1264 ;; Bind debug-on-error to something unique so that we can
1265 ;; detect when evalled code changes it.
1269 ;; If evalled code has changed the value of debug-on-error,
1270 ;; propagate that change to the global binding.
1286 "Prompting with PROMPT, let user edit COMMAND and eval result.
1287 COMMAND is a Lisp expression. Let user edit that expression in
1288 the minibuffer, then read and evaluate the result."
1295 read-expression-map t
1297 ;; If command was added to command-history as a string,
1298 ;; get rid of that. We want only evaluable expressions there.
1302 ;; If command to be redone does not match front of history,
1303 ;; add it to the history.
1309 "Edit and re-evaluate last complex command, or ARGth from last.
1310 A complex command is one which used the minibuffer.
1311 The command is placed in the minibuffer as a Lisp form for editing.
1312 The result is executed, repeating the command as changed.
1313 If the command has been changed or is not the most recent previous
1314 command it is added to the front of the command history.
1315 You can use the minibuffer history commands \
1317 to get different commands to edit and resubmit."
1320 newcmd)
1332 ;; If command was added to command-history as a
1333 ;; string, get rid of that. We want only
1334 ;; evaluable expressions there.
1338 ;; If command to be redone does not match front of history,
1339 ;; add it to the history.
1348 "Read command name to invoke in `execute-extended-command'."
1353 ;; Get a command name at point in the original buffer
1354 ;; to propose it after M-n.
1358 ;; Read a string, completing from and restricting to the set of
1359 ;; all defined commands. Don't provide any initial input.
1360 ;; Save the command read on the extended-command history list.
1371 ;; This isn't strictly correct if `execute-extended-command'
1372 ;; is bound to anything else (e.g. [menu]).
1373 ;; It could use (key-description (this-single-command-keys)),
1374 ;; but actually a prompt other than "M-x" would be confusing,
1375 ;; because "M-x" is a well-known prompt to read a command
1376 ;; and it serves as a shorthand for "Extended command: ".
1381 "Non-nil means show the equivalent key-binding when M-x command has one.
1382 The value can be a length of time to show the message for.
1383 If the value is non-nil and not a number, we wait 2 seconds."
1390 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1391 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1392 "Read function name, then read its arguments and call it.
1394 To pass a numeric argument to the command you are invoking with, specify
1395 the numeric argument to this command.
1397 Noninteractively, the argument PREFIXARG is the prefix argument to
1398 give to the command you invoke, if it asks for an argument."
1400 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1409 ;; Normally `real-this-command' should never be changed, but here we really
1410 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1411 ;; binding" for <cmd>, so the command the user really wanted to run is
1412 ;; `function' and not `execute-extended-command'. The difference is
1413 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1417 ;; If enabled, show which key runs this command.
1419 ;; But first wait, and skip the message if there is input.
1421 ;; If this command displayed something in the echo area;
1422 ;; wait a few seconds, then display our suggestion message.
1432 suggest-key-bindings
1434 \f
1436 "Default minibuffer history list.
1437 This is used for all minibuffer input
1438 except when an alternate history list is specified.
1440 Maximum length of the history list is determined by the value
1443 "Control whether history list elements are expressions or strings.
1444 If the value of this variable equals current minibuffer depth,
1445 they are expressions; otherwise they are strings.
1446 \(That convention is designed to do the right thing for
1453 "Text that was in this minibuffer before any history commands.
1454 This is nil if there have not yet been any history commands
1463 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1467 "Minibuffer history variables for which matching should ignore case.
1468 If a history variable is a member of this list, then the
1470 commands ignore case when searching it, regardless of `case-fold-search'."
1475 "Find the previous history element that matches REGEXP.
1476 \(Previous history elements refer to earlier actions.)
1477 With prefix argument N, search for Nth previous match.
1478 If N is negative, find the next or Nth next match.
1479 Normally, history elements are matched case-insensitively if
1480 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1481 makes the search case-sensitive.
1482 See also `minibuffer-history-case-insensitive-variables'."
1486 nil
1487 minibuffer-local-map
1488 nil
1489 'minibuffer-history-search-history
1491 ;; Use the last regexp specified, by default, if input is empty.
1496 regexp)
1506 ;; On some systems, ignore case for file names.
1508 minibuffer-history-case-insensitive-variables)
1509 t
1510 ;; Respect the user's setting for case-fold-search:
1511 case-fold-search)
1512 nil))
1513 prevpos
1514 match-string
1515 match-offset
1522 "No later matching history item"
1543 next-matching-history-element))
1547 "Find the next history element that matches REGEXP.
1548 \(The next history element refers to a more recent action.)
1549 With prefix argument N, search for Nth next match.
1550 If N is negative, find the previous or Nth previous match.
1551 Normally, history elements are matched case-insensitively if
1552 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1553 makes the search case-sensitive."
1557 nil
1558 minibuffer-local-map
1559 nil
1560 'minibuffer-history-search-history
1562 ;; Use the last regexp specified, by default, if input is empty.
1567 regexp)
1574 "Function run by `goto-history-element' before consuming default values.
1575 This is useful to dynamically add more elements to the list of default values
1576 when `goto-history-element' reaches the end of this list.
1577 Before calling this function `goto-history-element' sets the variable
1578 `minibuffer-default-add-done' to t, so it will call this function only
1579 once. In special cases, when this function needs to be called more
1580 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1584 "When nil, add more elements to the end of the list of default values.
1585 The value nil causes `goto-history-element' to add more elements to
1586 the list of defaults when it reaches the end of this list. It does
1592 "Return a list of all completions without the default value.
1593 This function is used to add all elements of the completion table to
1594 the end of the list of defaults just after the default value."
1597 minibuffer-completion-table
1598 minibuffer-completion-predicate)))
1604 "Puts element of the minibuffer history in the minibuffer.
1605 The argument NABS specifies the absolute history position."
1619 elt minibuffer-returned-to-present)
1626 "End of defaults; no next item"
1631 previous-history-element))
1643 minibuffer-default)))
1655 elt))
1659 "Puts next element of the minibuffer history in the minibuffer.
1660 With argument N, it uses the Nth following element."
1666 "Puts previous element of the minibuffer history in the minibuffer.
1667 With argument N, it uses the Nth previous element."
1673 "Get next history element which completes the minibuffer before the point.
1674 The contents of the minibuffer after the point are deleted, and replaced
1675 by the new completion."
1681 n)
1682 ;; next-matching-history-element always puts us at (point-min).
1683 ;; Move to the position we were at before changing the buffer contents.
1684 ;; This is still sensible, because the text before point has not changed.
1688 "\
1689 Get previous history element which completes the minibuffer before the point.
1690 The contents of the minibuffer after the point are deleted, and replaced
1691 by the new completion."
1695 ;; For compatibility with the old subr of the same name.
1697 "Return the display width of the minibuffer prompt.
1698 Return 0 if current buffer is not a minibuffer."
1699 ;; Return the width of everything before the field at the end of
1700 ;; the buffer; this should be 0 for normal buffers.
1702 \f
1703 ;; isearch minibuffer history
1710 "Set up a minibuffer for using isearch to search the minibuffer history.
1711 Intended to be added to `minibuffer-setup-hook'."
1723 "Clean up the minibuffer after terminating isearch in the minibuffer."
1728 "Return the proper search function, for isearch in minibuffer history."
1731 ;; Use standard functions to search within minibuffer text
1733 found)
1734 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1735 ;; searching forward. Lazy-highlight calls this lambda with the
1736 ;; bound arg, so skip the minibuffer prompt.
1740 ;; 1. First try searching in the initial minibuffer text
1743 noerror)
1744 ;; 2. If the above search fails, start putting next/prev history
1745 ;; elements in the minibuffer successively, and search the string
1746 ;; in them. Do this only when bound is nil (i.e. not while
1747 ;; lazy-highlighting search strings in the current minibuffer text).
1759 ;; After putting the next/prev history element, search
1760 ;; the string in them again, until next-history-element
1761 ;; or previous-history-element raises an error at the
1762 ;; beginning/end of history.
1765 ;; For backward search, don't search
1766 ;; in the minibuffer prompt
1768 noerror)))
1769 ;; Return point of the new search result
1771 ;; Return nil when next(prev)-history-element fails
1775 "Display the minibuffer history search prompt.
1776 If there are no search errors, this function displays an overlay with
1777 the isearch prompt which replaces the original minibuffer prompt.
1778 Otherwise, it displays the standard isearch message returned from
1779 `isearch-message'."
1781 ;; Use standard function `isearch-message' when not in the minibuffer,
1782 ;; or search fails, or has an error (like incomplete regexp).
1783 ;; This function overwrites minibuffer text with isearch message,
1784 ;; so it's possible to see what is wrong in the search string.
1786 ;; Otherwise, put the overlay with the standard isearch prompt over
1787 ;; the initial minibuffer prompt.
1796 ;; And clear any previous isearch message.
1800 "Wrap the minibuffer history search when search fails.
1801 Move point to the first history element for a forward search,
1802 or to the last history element for a backward search."
1803 ;; When `minibuffer-history-isearch-search' fails on reaching the
1804 ;; beginning/end of the history, wrap the search to the first/last
1805 ;; minibuffer history element.
1813 "Save a function restoring the state of minibuffer history search.
1814 Save `minibuffer-history-position' to the additional state parameter
1815 in the search status stack."
1821 "Restore the minibuffer history search state.
1822 Go to the history element by the absolute history position HIST-POS."
1825 \f
1826 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1830 "Table mapping redo records to the corresponding undo one.
1831 A redo record for undo-in-region maps to t.
1841 "Within a run of consecutive undo commands, list remaining to be undone.
1845 "Undo some previous changes.
1846 Repeat this command to undo more changes.
1847 A numeric ARG serves as a repeat count.
1849 In Transient Mark mode when the mark is active, only undo changes within
1851 as an argument limits undo to changes within the current region."
1853 ;; Make last-command indicate for the next command that this was an undo.
1854 ;; That way, another undo will undo more.
1855 ;; If we get to the end of the undo history and get an error,
1856 ;; another undo command will find the undo history empty
1857 ;; and will get another error. To begin undoing the undos,
1858 ;; you must type some other command.
1860 ;; For an indirect buffer, look in the base buffer for the
1861 ;; auto-save data.
1865 message)
1866 ;; If we get an error in undo-start,
1867 ;; the next command should not be a "consecutive undo".
1868 ;; So set `this-command' to something other than `undo'.
1873 ;; If something (a timer or filter?) changed the buffer
1874 ;; since the previous command, don't continue the undo seq.
1878 ;; If the last undo record made was made by undo
1879 ;; it shows nothing else happened in between.
1886 ;; get rid of initial undo boundary
1888 ;; If we got this far, the next command should be a consecutive undo.
1890 ;; Check to see whether we're hitting a redo record, and if
1891 ;; so, ask the user whether she wants to skip the redo/undo pair.
1899 ;; The equiv entry might point to another redo record if we have done
1900 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1908 ;; Record the fact that the just-generated undo records come from an
1909 ;; undo operation--that is, they are redo records.
1910 ;; In the ordinary case (not within a region), map the redo
1911 ;; record to the following undos.
1912 ;; I don't know how to do that in the undo-in-region case.
1914 ;; Strip any leading undo boundaries there might be, like we do
1915 ;; above when checking.
1919 undo-equiv-table))
1920 ;; Don't specify a position in the undo record for the undo command.
1921 ;; Instead, undoing this should move point to where the change is.
1940 ;; Record what the current undo list says,
1941 ;; so the next command can tell if the buffer was modified in between.
1945 ;; Display a message announcing success.
1950 "Make BUFFER stop keeping undo information.
1951 No argument or nil as argument means do this for the current buffer."
1957 "Undo some previous changes.
1958 Repeat this command to undo more changes.
1959 A numeric ARG serves as a repeat count.
1960 Contrary to `undo', this will not redo a previous undo."
1965 "Non-nil while performing an undo.
1969 "Undo back N undo-boundaries beyond what was already undone recently.
1970 Call `undo-start' to get ready to undo recent changes,
1971 then call `undo-more' one or more times to undo them."
1976 ;; Note: The following, while pulling elements off
1977 ;; `pending-undo-list' will call primitive change functions which
1978 ;; will push more elements onto `buffer-undo-list'.
1984 "Undo N records from the front of the list LIST.
1985 Return what remains of the list."
1987 ;; This is a good feature, but would make undo-start
1988 ;; unable to do what is expected.
1989 ;;(when (null (car (list)))
1990 ;; ;; If the head of the list is a boundary, it is the boundary
1991 ;; ;; preceding this command. Get rid of it and don't count it.
1992 ;; (setq list (cdr list))))
1995 ;; In a writable buffer, enable undoing read-only text that is
1996 ;; so because of text properties.
1998 ;; Don't let `intangible' properties interfere with undo.
2000 ;; We use oldlist only to check for EQ. ++kfs
2006 ;; Handle an integer by setting point to that value.
2009 ;; Element (t . TIME) records previous modtime.
2010 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2011 ;; UNKNOWN_MODTIME_NSECS.
2013 ;; If this records an obsolete save
2014 ;; (not matching the actual disk file)
2015 ;; then don't mark unmodified.
2023 ;; Element (nil PROP VAL BEG . END) is property change.
2028 ;; Element (BEG . END) means range was inserted.
2030 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2031 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2034 ;; Set point first thing, so that undoing this undo
2035 ;; does not send point back to where it is now.
2038 ;; Element (apply FUN . ARGS) means call FUN to undo.
2042 ;; Long format: (apply DELTA START END FUN . ARGS).
2049 ;; Check that the function did what the entry
2050 ;; said it would do.
2060 ;; Element (STRING . POS) means STRING was deleted.
2070 ;; Now that we record marker adjustments
2071 ;; (caused by deletion) for undo,
2072 ;; we should always insert after markers,
2073 ;; so that undoing the marker adjustments
2074 ;; put the markers back in the right place.
2077 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2085 ;; Make sure an apply entry produces at least one undo entry,
2086 ;; so the test in `undo' for continuing an undo series
2087 ;; will work right.
2092 list)
2094 ;; Deep copy of a list
2096 "Make a copy of undo list LIST."
2102 elt))
2105 "Set `pending-undo-list' to the front of the undo list.
2106 The next call to `undo-more' will undo the most recently made change.
2107 If BEG and END are specified, then only undo elements
2108 that apply to text between BEG and END are used; other undo elements
2109 are ignored. If BEG and END are nil, all undo elements are used."
2115 buffer-undo-list)))
2120 "Return a list of undo elements for the region START to END.
2121 The elements come from `buffer-undo-list', but we keep only
2122 the elements inside this region, and discard those outside this region.
2123 If we find an element that crosses an edge of this region,
2124 we stop and ignore all further elements."
2127 undo-adjusted-markers
2128 some-rejected
2129 undo-elt temp-undo-list delta)
2134 ;; This is a "was unmodified" element.
2135 ;; Keep it if we have kept everything thus far.
2142 ;; Don't put two nils together in the list
2156 ;; Loop down the earlier events adjusting their buffer
2157 ;; positions to reflect the fact that a change to the buffer
2158 ;; isn't being undone. We only need to process those element
2159 ;; types which undo-elt-in-region will return as being in
2160 ;; the region since only those types can ever get into the
2161 ;; output
2170 ;; (TEXT . POSITION)
2177 ;; (BEGIN . END)
2182 ;; (nil PROPERTY VALUE BEG . END)
2192 "Determine whether UNDO-ELT falls inside the region START ... END.
2193 If it crosses the edge, we return nil."
2198 t)
2200 nil)
2202 ;; (TEXT . POSITION)
2206 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2207 ;; See if MARKER is inside the region.
2218 ;; (nil PROPERTY VALUE BEG . END)
2223 ;; (BEGIN . END)
2228 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2229 This assumes we have already decided that UNDO-ELT
2230 is not *inside* the region START...END."
2233 ;; (nil PROPERTY VALUE BEG . END)
2238 ;; (BEGIN . END)
2242 ;; Return the first affected buffer position and the delta for an undo element
2243 ;; delta is defined as the change in subsequent buffer positions if we *did*
2244 ;; the undo.
2248 ;; (TEXT . POSITION)
2251 ;; (BEGIN . END)
2258 "If non-nil ask about discarding undo info for the current command.
2259 Normally, Emacs discards the undo info for the current command if
2260 it exceeds `undo-outer-limit'. But if you set this option
2261 non-nil, it asks in the echo area whether to discard the info.
2262 If you answer no, there is a slight risk that Emacs might crash, so
2263 only do it if you really want to undo the command.
2265 This option is mainly intended for debugging. You have to be
2266 careful if you use it for other purposes. Garbage collection is
2267 inhibited while the question is asked, meaning that Emacs might
2268 leak memory. So you should make sure that you do not wait
2269 excessively long before answering the question."
2275 "If non-nil, an extra level of size that's ok in an undo item.
2276 We don't ask the user about truncating the undo list until the
2277 current item gets bigger than this amount.
2282 ;; When the first undo batch in an undo list is longer than
2283 ;; undo-outer-limit, this function gets called to warn the user that
2284 ;; the undo info for the current command was discarded. Garbage
2285 ;; collection is inhibited around the call, so it had better not do a
2286 ;; lot of consing.
2292 ;; Don't ask the question again unless it gets even bigger.
2293 ;; This applies, in particular, if the user quits from the question.
2294 ;; Such a quit quits out of GC, but something else will call GC
2295 ;; again momentarily. It will call this function again,
2296 ;; but we don't want to ask the question again.
2303 t)
2304 nil))
2309 "The undo info was discarded because it exceeded \
2310 `undo-outer-limit'.
2312 This is normal if you executed a command that made a huge change
2313 to the buffer. In that case, to prevent similar problems in the
2314 future, set `undo-outer-limit' to a value that is large enough to
2315 cover the maximum size of normal changes you expect a single
2316 command to make, but not so large that it might exceed the
2317 maximum memory allotted to Emacs.
2319 If you did not execute any such command, the situation is
2320 probably due to a bug and you should report it.
2322 You can disable the popping up of this buffer by adding the entry
2323 \(undo discard-info) to the user option `warning-suppress-types',
2327 t))
2328 \f
2330 "History list for some commands that read shell commands.
2332 Maximum length of the history list is determined by the value
2339 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2340 This buffer is used when `shell-command' or `shell-command-on-region'
2341 is run interactively. A value of nil means that output to stderr and
2348 "Return a list of all commands associated with the current file.
2349 This function is used to add all related commands retrieved by `mailcap'
2350 to the end of the list of defaults just after the default value."
2354 minibuffer-default))
2359 commands))
2370 map)
2374 "Read a shell command from the minibuffer.
2375 The arguments are the same as the ones of `read-from-minibuffer',
2376 except READ and KEYMAP are missing and HIST defaults
2377 to `shell-command-history'."
2385 minibuffer-local-shell-command-map
2386 nil
2388 args)))
2391 "What to do when the output buffer is used by another shell command.
2392 This option specifies how to resolve the conflict where a new command
2393 wants to direct its output to the buffer `*Async Shell Command*',
2394 but this buffer is already taken by another running shell command.
2396 The value `confirm-kill-process' is used to ask for confirmation before
2397 killing the already running process and running a new process
2398 in the same buffer, `confirm-new-buffer' for confirmation before running
2399 the command in a new buffer with a name other than the default buffer name,
2400 `new-buffer' for doing the same without confirmation,
2401 `confirm-rename-buffer' for confirmation before renaming the existing
2402 output buffer and running a new command in the default buffer,
2403 `rename-buffer' for doing the same without confirmation."
2405 confirm-kill-process)
2407 confirm-new-buffer)
2409 new-buffer)
2411 confirm-rename-buffer)
2413 rename-buffer))
2418 "Execute string COMMAND asynchronously in background.
2420 Like `shell-command', but adds `&' at the end of COMMAND
2421 to execute it asynchronously.
2423 The output appears in the buffer `*Async Shell Command*'.
2424 That buffer is in shell mode.
2426 In Elisp, you will often be better served by calling `start-process'
2427 directly, since it offers more control and does not impose the use of a
2428 shell (with its need to quote arguments)."
2438 current-prefix-arg
2439 shell-command-default-error-buffer))
2445 "Execute string COMMAND in inferior shell; display output, if any.
2446 With prefix argument, insert the COMMAND's output at point.
2448 If COMMAND ends in `&', execute it asynchronously.
2449 The output appears in the buffer `*Async Shell Command*'.
2450 That buffer is in shell mode. You can also use
2451 `async-shell-command' that automatically adds `&'.
2453 Otherwise, COMMAND is executed synchronously. The output appears in
2454 the buffer `*Shell Command Output*'. If the output is short enough to
2455 display in the echo area (which is determined by the variables
2456 `resize-mini-windows' and `max-mini-window-height'), it is shown
2457 there, but it is nonetheless available in buffer `*Shell Command
2458 Output*' even though that buffer is not automatically displayed.
2460 To specify a coding system for converting non-ASCII characters
2462 before this command.
2464 Noninteractive callers can specify coding systems by binding
2465 `coding-system-for-read' and `coding-system-for-write'.
2467 The optional second argument OUTPUT-BUFFER, if non-nil,
2468 says to put the output in some other buffer.
2469 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2470 If OUTPUT-BUFFER is not a buffer and not nil,
2471 insert output in current buffer. (This cannot be done asynchronously.)
2472 In either case, the buffer is first erased, and the output is
2473 inserted after point (leaving mark after it).
2475 If the command terminates without error, but generates output,
2477 the output can be displayed in the echo area or in its buffer.
2478 If the output is short enough to display in the echo area
2479 \(determined by the variable `max-mini-window-height' if
2480 `resize-mini-windows' is non-nil), it is shown there.
2481 Otherwise,the buffer containing the output is displayed.
2485 of the output.
2487 If there is no output, or if output is inserted in the current buffer,
2488 then `*Shell Command Output*' is deleted.
2490 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2491 or buffer name to which to direct the command's standard error output.
2492 If it is nil, error output is mingled with regular output.
2493 In an interactive call, the variable `shell-command-default-error-buffer'
2494 specifies the value of ERROR-BUFFER.
2496 In Elisp, you will often be better served by calling `call-process' or
2497 `start-process' directly, since it offers more control and does not impose
2498 the use of a shell (with its need to quote arguments)."
2509 current-prefix-arg
2510 shell-command-default-error-buffer))
2511 ;; Look for a handler in case default-directory is a remote file name.
2519 ;; Output goes in current buffer.
2525 temporary-file-directory)))
2526 nil)))
2529 ;; We do not use -f for csh; we will not support broken use of
2530 ;; .cshrcs. Even the BSD csh manual says to use
2531 ;; "if ($?prompt) exit" before things which are not useful
2532 ;; non-interactively. Besides, if someone wants their other
2533 ;; aliases for shell commands then they can still have them.
2537 t)
2538 nil shell-command-switch command)
2545 ;; Do no formatting while reading error file,
2546 ;; because that can run a shell command, and we
2547 ;; don't want that to cause an infinite recursion.
2549 ;; Put point after the inserted errors.
2553 ;; This is like exchange-point-and-mark, but doesn't
2554 ;; activate the mark. It is cleaner to avoid activation,
2555 ;; even though the command loop would deactivate the mark
2556 ;; because we inserted text.
2560 ;; Output goes in a separate buffer.
2561 ;; Preserve the match data in case called from a program.
2564 ;; Command ending with ampersand means asynchronous.
2568 proc)
2569 ;; Remove the ampersand.
2571 ;; Ask the user what to do with already running process.
2576 ;; If will kill a process, query first.
2581 ;; If will create a new buffer, query first.
2587 ;; It will create a new buffer.
2591 ;; If will rename the buffer, query first.
2600 ;; It will rename the buffer.
2607 ;; Setting buffer-read-only to nil doesn't suffice
2608 ;; if some text has a non-nil read-only property,
2609 ;; which comint sometimes adds for prompts.
2615 shell-command-switch command))
2619 ;; Use the comint filter for proper handling of carriage motion
2620 ;; (see `comint-inhibit-carriage-motion'),.
2622 ))
2623 ;; Otherwise, command is executed synchronously.
2625 output-buffer nil error-buffer)))))))
2629 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2630 MESSAGE may be either a string or a buffer.
2632 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2633 the maximum height of the echo area, as defined by `max-mini-window-height'
2634 if `resize-mini-windows' is non-nil.
2636 Returns either the string shown in the echo area, or when a pop-up
2637 buffer is used, the window used to display it.
2639 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2640 name of the buffer used to display it in the case where a pop-up buffer
2641 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2642 string and it is displayed in the echo area, it is not specified whether
2643 the contents are inserted into the buffer anyway.
2645 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2646 and only used if a buffer is displayed."
2648 ;; Trivial case where we can use the echo area
2652 ;; Trivial case where we can just remove single trailing newline
2655 ;; General case
2658 message
2667 0
2671 (<= lines
2675 max-mini-window-height))
2677 max-mini-window-height)
2681 ;; Don't use the echo area if the output buffer is
2682 ;; already displayed in the selected frame.
2684 ;; Echo area
2690 ;; Buffer
2693 not-this-window frame))))))))
2696 ;; We have a sentinel to prevent insertion of a termination message
2697 ;; in the buffer itself.
2705 &optional output-buffer replace
2706 error-buffer display-error-buffer)
2707 "Execute string COMMAND in inferior shell with region as input.
2708 Normally display output (if any) in temp buffer `*Shell Command Output*';
2709 Prefix arg means replace the region with it. Return the exit code of
2710 COMMAND.
2712 To specify a coding system for converting non-ASCII characters
2714 before this command. By default, the input (from the current buffer)
2715 is encoded using coding-system specified by `process-coding-system-alist',
2716 falling back to `default-process-coding-system' if no match for COMMAND
2717 is found in `process-coding-system-alist'.
2719 Noninteractive callers can specify coding systems by binding
2720 `coding-system-for-read' and `coding-system-for-write'.
2722 If the command generates output, the output may be displayed
2723 in the echo area or in a buffer.
2724 If the output is short enough to display in the echo area
2725 \(determined by the variable `max-mini-window-height' if
2726 `resize-mini-windows' is non-nil), it is shown there.
2727 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2728 The output is available in that buffer in both cases.
2730 If there is output and an error, a message about the error
2731 appears at the end of the output. If there is no output, or if
2732 output is inserted in the current buffer, the buffer `*Shell
2733 Command Output*' is deleted.
2735 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2736 command's output. If the value is a buffer or buffer name, put
2737 the output there. Any other value, including nil, means to
2738 insert the output in the current buffer. In either case, the
2739 output is inserted after point (leaving mark after it).
2741 Optional fifth arg REPLACE, if non-nil, means to insert the
2742 output in place of text from START to END, putting point and mark
2743 around it.
2745 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2746 or buffer name to which to direct the command's standard error
2747 output. If nil, error output is mingled with regular output.
2748 When called interactively, `shell-command-default-error-buffer'
2749 is used for ERROR-BUFFER.
2751 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2752 display the error buffer if there were any errors. When called
2753 interactively, this is t."
2757 ;; Do this before calling region-beginning
2758 ;; and region-end, in case subprocess output
2759 ;; relocates them while we are in the minibuffer.
2761 ;; call-interactively recognizes region-beginning and
2762 ;; region-end specially, leaving them in the history.
2764 string
2765 current-prefix-arg
2766 current-prefix-arg
2767 shell-command-default-error-buffer
2768 t)))
2774 temporary-file-directory)))
2775 nil))
2776 exit-status)
2780 ;; Replace specified region with output from command.
2782 ;; Don't muck with mark unless REPLACE says we should.
2789 t)
2790 nil shell-command-switch command))
2791 ;; It is rude to delete a buffer which the command is not using.
2792 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2793 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2794 ;; (kill-buffer shell-buffer)))
2795 ;; Don't muck with mark unless REPLACE says we should.
2797 ;; No prefix argument: put the output in a temp buffer,
2798 ;; replacing its entire contents.
2803 ;; If the input is the same buffer as the output,
2804 ;; delete everything but the specified region,
2805 ;; then replace that region with the output.
2811 shell-file-name t
2814 t)
2815 nil shell-command-switch
2816 command)))
2817 ;; Clear the output buffer, then run the command with
2818 ;; output there.
2829 buffer)
2830 nil shell-command-switch command)))
2831 ;; Report the output.
2841 ;; There's some output, display it
2843 ;; No output; error?
2850 shell-command-default-error-buffer)
2857 output))
2860 exit-status))
2863 exit-status output))))
2864 ;; Don't kill: there might be useful info in the undo-log.
2865 ;; (kill-buffer buffer)
2866 ))))
2874 ;; Do no formatting while reading error file,
2875 ;; because that can run a shell command, and we
2876 ;; don't want that to cause an infinite recursion.
2878 ;; Put point after the inserted errors.
2883 exit-status))
2886 "Execute shell command COMMAND and return its output as a string."
2889 standard-output
2893 "Process files synchronously in a separate process.
2894 Similar to `call-process', but may invoke a file handler based on
2895 `default-directory'. The current working directory of the
2896 subprocess is `default-directory'.
2898 File names in INFILE and BUFFER are handled normally, but file
2899 names in ARGS should be relative to `default-directory', as they
2900 are passed to the process verbatim. \(This is a difference to
2901 `call-process' which does not support file handlers for INFILE
2902 and BUFFER.\)
2904 Some file handlers might not support all variants, for example
2905 they might behave as if DISPLAY was nil, regardless of the actual
2906 value passed."
2908 lc stderr-file)
2918 display args)
2924 "Whether a call of `process-file' changes remote files.
2926 By default, this variable is always set to `t', meaning that a
2927 call of `process-file' could potentially change any file on a
2928 remote host. When set to `nil', a file handler could optimize
2929 its behavior with respect to remote file attribute caching.
2931 You should only ever change this variable with a let-binding;
2935 "Start a program in a subprocess. Return the process object for it.
2937 Similar to `start-process', but may invoke a file handler based on
2938 `default-directory'. See Info node `(elisp)Magic File Names'.
2940 This handler ought to run PROGRAM, perhaps on the local host,
2941 perhaps on a remote host that corresponds to `default-directory'.
2942 In the latter case, the local part of `default-directory' becomes
2943 the working directory of the process.
2945 PROGRAM and PROGRAM-ARGS might be file names. They are not
2946 objects of file handler invocation. File handlers might not
2947 support pty association, if PROGRAM is nil."
2951 \f
2952 ;;;; Process menu
2964 "Major mode for listing the processes called by Emacs."
2976 "Recompute the list of processes for the Process List buffer.
2977 Also, delete any process that is exited or signaled."
2990 face link
2993 follow-link t
2994 process-buffer ,buf
2995 action process-menu-visit-buffer)
3004 "datagram"
3021 tabulated-list-entries))))))
3027 "Display a list of all processes.
3028 If optional argument QUERY-ONLY is non-nil, only processes with
3029 the query-on-exit flag set are listed.
3030 Any process listed as exited or signaled is actually eliminated
3031 after the listing is made.
3032 Optional argument BUFFER specifies a buffer to use, instead of
3034 The return value is always nil."
3046 nil)
3047 \f
3051 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
3052 (define-key map [switch-frame] nil)
3053 (define-key map [?\C-u] 'universal-argument-more)
3054 (define-key map [?-] 'universal-argument-minus)
3055 (define-key map [?0] 'digit-argument)
3056 (define-key map [?1] 'digit-argument)
3057 (define-key map [?2] 'digit-argument)
3058 (define-key map [?3] 'digit-argument)
3059 (define-key map [?4] 'digit-argument)
3060 (define-key map [?5] 'digit-argument)
3061 (define-key map [?6] 'digit-argument)
3062 (define-key map [?7] 'digit-argument)
3063 (define-key map [?8] 'digit-argument)
3064 (define-key map [?9] 'digit-argument)
3065 (define-key map [kp-0] 'digit-argument)
3066 (define-key map [kp-1] 'digit-argument)
3067 (define-key map [kp-2] 'digit-argument)
3068 (define-key map [kp-3] 'digit-argument)
3069 (define-key map [kp-4] 'digit-argument)
3070 (define-key map [kp-5] 'digit-argument)
3071 (define-key map [kp-6] 'digit-argument)
3072 (define-key map [kp-7] 'digit-argument)
3073 (define-key map [kp-8] 'digit-argument)
3074 (define-key map [kp-9] 'digit-argument)
3075 (define-key map [kp-subtract] 'universal-argument-minus)
3076 map)
3079 (defvar universal-argument-num-events nil
3080 "Number of argument-specifying events read by `universal-argument'.
3081 `universal-argument-other-key' uses this to discard those events
3082 from (this-command-keys), and reread only the final command.")
3084 (defvar saved-overriding-map t
3085 "The saved value of `overriding-terminal-local-map'.
3089 (defun save&set-overriding-map (map)
3090 "Set `overriding-terminal-local-map' to MAP."
3091 (when (eq saved-overriding-map t)
3092 (setq saved-overriding-map overriding-terminal-local-map)
3093 (setq overriding-terminal-local-map map)))
3095 (defun restore-overriding-map ()
3096 "Restore `overriding-terminal-local-map' to its saved value."
3097 (setq overriding-terminal-local-map saved-overriding-map)
3098 (setq saved-overriding-map t))
3100 (defun universal-argument ()
3101 "Begin a numeric argument for the following command.
3106 multiplies the argument by 4 each time.
3108 which is different in effect from any particular numeric argument.
3110 (interactive)
3111 (setq prefix-arg (list 4))
3112 (setq universal-argument-num-events (length (this-command-keys)))
3113 (save&set-overriding-map universal-argument-map))
3115 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3116 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3117 (defun universal-argument-more (arg)
3118 (interactive "P")
3119 (if (consp arg)
3120 (setq prefix-arg (list (* 4 (car arg))))
3121 (if (eq arg '-)
3122 (setq prefix-arg (list -4))
3123 (setq prefix-arg arg)
3124 (restore-overriding-map)))
3125 (setq universal-argument-num-events (length (this-command-keys))))
3127 (defun negative-argument (arg)
3128 "Begin a negative numeric argument for the next command.
3130 (interactive "P")
3131 (cond ((integerp arg)
3132 (setq prefix-arg (- arg)))
3133 ((eq arg '-)
3134 (setq prefix-arg nil))
3135 (t
3136 (setq prefix-arg '-)))
3137 (setq universal-argument-num-events (length (this-command-keys)))
3138 (save&set-overriding-map universal-argument-map))
3140 (defun digit-argument (arg)
3141 "Part of the numeric argument for the next command.
3143 (interactive "P")
3144 (let* ((char (if (integerp last-command-event)
3145 last-command-event
3146 (get last-command-event 'ascii-character)))
3148 (cond ((integerp arg)
3149 (setq prefix-arg (+ (* arg 10)
3150 (if (< arg 0) (- digit) digit))))
3151 ((eq arg '-)
3152 ;; Treat -0 as just -, so that -01 will work.
3153 (setq prefix-arg (if (zerop digit) '- (- digit))))
3154 (t
3155 (setq prefix-arg digit))))
3156 (setq universal-argument-num-events (length (this-command-keys)))
3157 (save&set-overriding-map universal-argument-map))
3159 ;; For backward compatibility, minus with no modifiers is an ordinary
3160 ;; command if digits have already been entered.
3161 (defun universal-argument-minus (arg)
3162 (interactive "P")
3163 (if (integerp arg)
3164 (universal-argument-other-key arg)
3165 (negative-argument arg)))
3167 ;; Anything else terminates the argument and is left in the queue to be
3168 ;; executed as a command.
3169 (defun universal-argument-other-key (arg)
3170 (interactive "P")
3171 (setq prefix-arg arg)
3172 (let* ((key (this-command-keys))
3173 (keylist (listify-key-sequence key)))
3174 (setq unread-command-events
3175 (append (nthcdr universal-argument-num-events keylist)
3176 unread-command-events)))
3177 (reset-this-command-lengths)
3178 (restore-overriding-map))
3179 \f
3181 (defvar filter-buffer-substring-functions nil
3182 "This variable is a wrapper hook around `filter-buffer-substring'.
3183 Each member of the hook should be a function accepting four arguments:
3184 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
3185 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3186 as those of `filter-buffer-substring' in each case.
3188 The first hook function to be called receives a FUN equivalent
3189 to the default operation of `filter-buffer-substring',
3190 i.e. one that returns the buffer-substring between BEG and
3191 END (processed by any `buffer-substring-filters'). Normally,
3192 the hook function will call FUN and then do its own processing
3193 of the result. The next hook function receives a FUN equivalent
3194 to the previous hook function, calls it, and does its own
3195 processing, and so on. The overall result is that of all hook
3196 functions acting in sequence.
3198 Any hook may choose not to call FUN though, in which case it
3199 effectively replaces the default behavior with whatever it chooses.
3200 Of course, a later hook function may do the same thing.")
3202 (defvar buffer-substring-filters nil
3203 "List of filter functions for `filter-buffer-substring'.
3204 Each function must accept a single argument, a string, and return
3205 a string. The buffer substring is passed to the first function
3206 in the list, and the return value of each function is passed to
3207 the next. The final result (if `buffer-substring-filters' is
3208 nil, this is the unfiltered buffer-substring) is passed to the
3209 first function on `filter-buffer-substring-functions'.
3211 As a special convention, point is set to the start of the buffer text
3212 being operated on (i.e., the first argument of `filter-buffer-substring')
3213 before these functions are called.")
3214 (make-obsolete-variable 'buffer-substring-filters
3215 'filter-buffer-substring-functions "24.1")
3217 (defun filter-buffer-substring (beg end &optional delete)
3218 "Return the buffer substring between BEG and END, after filtering.
3219 The wrapper hook `filter-buffer-substring-functions' performs
3220 the actual filtering. The obsolete variable `buffer-substring-filters'
3221 is also consulted. If both of these are nil, no filtering is done.
3223 If DELETE is non-nil, the text between BEG and END is deleted
3224 from the buffer.
3226 This function should be used instead of `buffer-substring',
3227 `buffer-substring-no-properties', or `delete-and-extract-region'
3228 when you want to allow filtering to take place. For example,
3229 major or minor modes can use `filter-buffer-substring-functions' to
3230 extract characters that are special to a buffer, and should not
3231 be copied into other buffers."
3232 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3233 (cond
3234 ((or delete buffer-substring-filters)
3235 (save-excursion
3236 (goto-char beg)
3237 (let ((string (if delete (delete-and-extract-region beg end)
3238 (buffer-substring beg end))))
3239 (dolist (filter buffer-substring-filters)
3240 (setq string (funcall filter string)))
3241 string)))
3242 (t
3243 (buffer-substring beg end)))))
3246 ;;;; Window system cut and paste hooks.
3248 (defvar interprogram-cut-function nil
3249 "Function to call to make a killed region available to other programs.
3250 Most window systems provide a facility for cutting and pasting
3251 text between different programs, such as the clipboard on X and
3252 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3254 This variable holds a function that Emacs calls whenever text is
3255 put in the kill ring, to make the new kill available to other
3256 programs. The function takes one argument, TEXT, which is a
3257 string containing the text which should be made available.")
3259 (defvar interprogram-paste-function nil
3260 "Function to call to get text cut from other programs.
3261 Most window systems provide a facility for cutting and pasting
3262 text between different programs, such as the clipboard on X and
3263 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3265 This variable holds a function that Emacs calls to obtain text
3266 that other programs have provided for pasting. The function is
3267 called with no arguments. If no other program has provided text
3268 to paste, the function should return nil (in which case the
3269 caller, usually `current-kill', should use the top of the Emacs
3270 kill ring). If another program has provided text to paste, the
3271 function should return that text as a string (in which case the
3272 caller should put this string in the kill ring as the latest
3273 kill).
3275 The function may also return a list of strings if the window
3276 system supports multiple selections. The first string will be
3277 used as the pasted text, but the other will be placed in the kill
3278 ring for easy access via `yank-pop'.
3280 Note that the function should return a string only if a program
3281 other than Emacs has provided a string for pasting; if Emacs
3282 provided the most recent string, the function should return nil.
3283 If it is difficult to tell whether Emacs or some other program
3284 provided the current string, it is probably good enough to return
3285 nil if the string is equal (according to `string=') to the last
3286 text Emacs provided.")
3287 \f
3290 ;;;; The kill ring data structure.
3292 (defvar kill-ring nil
3293 "List of killed text sequences.
3294 Since the kill ring is supposed to interact nicely with cut-and-paste
3295 facilities offered by window systems, use of this variable should
3296 interact nicely with `interprogram-cut-function' and
3297 `interprogram-paste-function'. The functions `kill-new',
3298 `kill-append', and `current-kill' are supposed to implement this
3299 interaction; you may want to use them instead of manipulating the kill
3300 ring directly.")
3302 (defcustom kill-ring-max 60
3303 "Maximum length of kill ring before oldest elements are thrown away."
3304 :type 'integer
3305 :group 'killing)
3307 (defvar kill-ring-yank-pointer nil
3308 "The tail of the kill ring whose car is the last thing yanked.")
3310 (defcustom save-interprogram-paste-before-kill nil
3311 "Save clipboard strings into kill ring before replacing them.
3312 When one selects something in another program to paste it into Emacs,
3313 but kills something in Emacs before actually pasting it,
3314 this selection is gone unless this variable is non-nil,
3315 in which case the other program's selection is saved in the `kill-ring'
3317 :type 'boolean
3318 :group 'killing
3319 :version "23.2")
3321 (defcustom kill-do-not-save-duplicates nil
3322 "Do not add a new string to `kill-ring' if it duplicates the last one.
3323 The comparison is done using `equal-including-properties'."
3324 :type 'boolean
3325 :group 'killing
3326 :version "23.2")
3328 (defun kill-new (string &optional replace yank-handler)
3329 "Make STRING the latest kill in the kill ring.
3330 Set `kill-ring-yank-pointer' to point to it.
3331 If `interprogram-cut-function' is non-nil, apply it to STRING.
3332 Optional second argument REPLACE non-nil means that STRING will replace
3333 the front of the kill ring, rather than being added to the list.
3335 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3336 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3337 STRING.
3339 When the yank handler has a non-nil PARAM element, the original STRING
3340 argument is not used by `insert-for-yank'. However, since Lisp code
3341 may access and use elements from the kill ring directly, the STRING
3343 (if (> (length string) 0)
3344 (if yank-handler
3345 (put-text-property 0 (length string)
3346 'yank-handler yank-handler string))
3347 (if yank-handler
3348 (signal 'args-out-of-range
3349 (list string "yank-handler specified for empty string"))))
3350 (unless (and kill-do-not-save-duplicates
3351 ;; Due to text properties such as 'yank-handler that
3352 ;; can alter the contents to yank, comparison using
3353 ;; `equal' is unsafe.
3354 (equal-including-properties string (car kill-ring)))
3355 (if (fboundp 'menu-bar-update-yank-menu)
3356 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3357 (when save-interprogram-paste-before-kill
3358 (let ((interprogram-paste (and interprogram-paste-function
3359 (funcall interprogram-paste-function))))
3360 (when interprogram-paste
3361 (dolist (s (if (listp interprogram-paste)
3362 (nreverse interprogram-paste)
3363 (list interprogram-paste)))
3364 (unless (and kill-do-not-save-duplicates
3365 (equal-including-properties s (car kill-ring)))
3366 (push s kill-ring))))))
3367 (unless (and kill-do-not-save-duplicates
3368 (equal-including-properties string (car kill-ring)))
3369 (if (and replace kill-ring)
3370 (setcar kill-ring string)
3371 (push string kill-ring)
3372 (if (> (length kill-ring) kill-ring-max)
3373 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3374 (setq kill-ring-yank-pointer kill-ring)
3375 (if interprogram-cut-function
3376 (funcall interprogram-cut-function string)))
3377 (set-advertised-calling-convention
3378 'kill-new '(string &optional replace) "23.3")
3380 (defun kill-append (string before-p &optional yank-handler)
3381 "Append STRING to the end of the latest kill in the kill ring.
3382 If BEFORE-P is non-nil, prepend STRING to the kill.
3383 If `interprogram-cut-function' is set, pass the resulting kill to it."
3384 (let* ((cur (car kill-ring)))
3385 (kill-new (if before-p (concat string cur) (concat cur string))
3386 (or (= (length cur) 0)
3387 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3388 yank-handler)))
3389 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3391 (defcustom yank-pop-change-selection nil
3392 "Whether rotating the kill ring changes the window system selection.
3393 If non-nil, whenever the kill ring is rotated (usually via the
3394 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3395 to copy the new kill to the window system selection."
3396 :type 'boolean
3397 :group 'killing
3398 :version "23.1")
3400 (defun current-kill (n &optional do-not-move)
3401 "Rotate the yanking point by N places, and then return that kill.
3402 If N is zero and `interprogram-paste-function' is set to a
3403 function that returns a string or a list of strings, and if that
3404 function doesn't return nil, then that string (or list) is added
3405 to the front of the kill ring and the string (or first string in
3406 the list) is returned as the latest kill.
3408 If N is not zero, and if `yank-pop-change-selection' is
3409 non-nil, use `interprogram-cut-function' to transfer the
3410 kill at the new yank point into the window system selection.
3412 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3413 move the yanking point; just return the Nth kill forward."
3415 (let ((interprogram-paste (and (= n 0)
3416 interprogram-paste-function
3417 (funcall interprogram-paste-function))))
3418 (if interprogram-paste
3419 (progn
3420 ;; Disable the interprogram cut function when we add the new
3421 ;; text to the kill ring, so Emacs doesn't try to own the
3422 ;; selection, with identical text.
3423 (let ((interprogram-cut-function nil))
3424 (if (listp interprogram-paste)
3425 (mapc 'kill-new (nreverse interprogram-paste))
3426 (kill-new interprogram-paste)))
3427 (car kill-ring))
3428 (or kill-ring (error "Kill ring is empty"))
3429 (let ((ARGth-kill-element
3430 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3431 (length kill-ring))
3432 kill-ring)))
3433 (unless do-not-move
3434 (setq kill-ring-yank-pointer ARGth-kill-element)
3435 (when (and yank-pop-change-selection
3436 (> n 0)
3437 interprogram-cut-function)
3438 (funcall interprogram-cut-function (car ARGth-kill-element))))
3439 (car ARGth-kill-element)))))
3443 ;;;; Commands for manipulating the kill ring.
3445 (defcustom kill-read-only-ok nil
3446 "Non-nil means don't signal an error for killing read-only text."
3447 :type 'boolean
3448 :group 'killing)
3450 (defun kill-region (beg end &optional yank-handler)
3452 This deletes the text from the buffer and saves it in the kill ring.
3456 If you want to append the killed region to the last killed text,
3459 If the buffer is read-only, Emacs will beep and refrain from deleting
3460 the text, but put the text in the kill ring anyway. This means that
3461 you can use the killing commands to copy text from a read-only buffer.
3463 Lisp programs should use this function for killing text.
3464 (To delete text, use `delete-region'.)
3465 Supply two arguments, character positions indicating the stretch of text
3466 to be killed.
3468 If the previous command was also a kill command,
3469 the text killed this time appends to the text killed last time
3470 to make one entry in the kill ring."
3471 ;; Pass point first, then mark, because the order matters
3472 ;; when calling kill-append.
3473 (interactive (list (point) (mark)))
3474 (unless (and beg end)
3475 (error "The mark is not set now, so there is no region"))
3476 (condition-case nil
3477 (let ((string (filter-buffer-substring beg end t)))
3478 (when string ;STRING is nil if BEG = END
3479 ;; Add that string to the kill ring, one way or another.
3480 (if (eq last-command 'kill-region)
3481 (kill-append string (< end beg) yank-handler)
3482 (kill-new string nil yank-handler)))
3483 (when (or string (eq last-command 'kill-region))
3484 (setq this-command 'kill-region))
3485 (setq deactivate-mark t)
3486 nil)
3487 ((buffer-read-only text-read-only)
3488 ;; The code above failed because the buffer, or some of the characters
3489 ;; in the region, are read-only.
3490 ;; We should beep, in case the user just isn't aware of this.
3491 ;; However, there's no harm in putting
3492 ;; the region's text in the kill ring, anyway.
3493 (copy-region-as-kill beg end)
3494 ;; Set this-command now, so it will be set even if we get an error.
3495 (setq this-command 'kill-region)
3496 ;; This should barf, if appropriate, and give us the correct error.
3497 (if kill-read-only-ok
3498 (progn (message "Read only text copied to kill ring") nil)
3499 ;; Signal an error if the buffer is read-only.
3500 (barf-if-buffer-read-only)
3501 ;; If the buffer isn't read-only, the text is.
3502 (signal 'text-read-only (list (current-buffer)))))))
3503 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3505 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3506 ;; to get two copies of the text when the user accidentally types M-w and
3507 ;; then corrects it with the intended C-w.
3508 (defun copy-region-as-kill (beg end)
3509 "Save the region as if killed, but don't kill it.
3510 In Transient Mark mode, deactivate the mark.
3511 If `interprogram-cut-function' is non-nil, also save the text for a window
3512 system cut and paste.
3514 This command's old key binding has been given to `kill-ring-save'."
3515 (interactive "r")
3516 (if (eq last-command 'kill-region)
3517 (kill-append (filter-buffer-substring beg end) (< end beg))
3518 (kill-new (filter-buffer-substring beg end)))
3519 (setq deactivate-mark t)
3520 nil)
3522 (defun kill-ring-save (beg end)
3523 "Save the region as if killed, but don't kill it.
3524 In Transient Mark mode, deactivate the mark.
3525 If `interprogram-cut-function' is non-nil, also save the text for a window
3526 system cut and paste.
3528 If you want to append the killed line to the last killed text,
3531 This command is similar to `copy-region-as-kill', except that it gives
3532 visual feedback indicating the extent of the region being copied."
3533 (interactive "r")
3534 (copy-region-as-kill beg end)
3535 ;; This use of called-interactively-p is correct because the code it
3536 ;; controls just gives the user visual feedback.
3537 (if (called-interactively-p 'interactive)
3538 (indicate-copied-region)))
3540 (defun indicate-copied-region (&optional message-len)
3541 "Indicate that the region text has been copied interactively.
3542 If the mark is visible in the selected window, blink the cursor
3543 between point and mark if there is currently no active region
3544 highlighting.
3546 If the mark lies outside the selected window, display an
3547 informative message containing a sample of the copied text. The
3548 optional argument MESSAGE-LEN, if non-nil, specifies the length
3549 of this sample text; it defaults to 40."
3550 (let ((mark (mark t))
3551 (point (point))
3552 ;; Inhibit quitting so we can make a quit here
3553 ;; look like a C-g typed as a command.
3554 (inhibit-quit t))
3555 (if (pos-visible-in-window-p mark (selected-window))
3556 ;; Swap point-and-mark quickly so as to show the region that
3557 ;; was selected. Don't do it if the region is highlighted.
3558 (unless (and (region-active-p)
3559 (face-background 'region))
3560 ;; Swap point and mark.
3561 (set-marker (mark-marker) (point) (current-buffer))
3562 (goto-char mark)
3563 (sit-for blink-matching-delay)
3564 ;; Swap back.
3565 (set-marker (mark-marker) mark (current-buffer))
3566 (goto-char point)
3567 ;; If user quit, deactivate the mark
3568 ;; as C-g would as a command.
3569 (and quit-flag mark-active
3570 (deactivate-mark)))
3571 (let ((len (min (abs (- mark point))
3572 (or message-len 40))))
3573 (if (< point mark)
3574 ;; Don't say "killed"; that is misleading.
3576 (buffer-substring-no-properties (- mark len) mark))
3578 (buffer-substring-no-properties mark (+ mark len))))))))
3580 (defun append-next-kill (&optional interactive)
3581 "Cause following command, if it kills, to append to previous kill.
3582 The argument is used for internal purposes; do not supply one."
3583 (interactive "p")
3584 ;; We don't use (interactive-p), since that breaks kbd macros.
3585 (if interactive
3586 (progn
3587 (setq this-command 'kill-region)
3588 (message "If the next command is a kill, it will append"))
3589 (setq last-command 'kill-region)))
3590 \f
3591 ;; Yanking.
3593 (defcustom yank-handled-properties
3594 '((font-lock-face . yank-handle-font-lock-face-property)
3595 (category . yank-handle-category-property))
3596 "List of special text property handling conditions for yanking.
3597 Each element should have the form (PROP . FUN), where PROP is a
3598 property symbol and FUN is a function. When the `yank' command
3599 inserts text into the buffer, it scans the inserted text for
3600 stretches of text that have `eq' values of the text property
3601 PROP; for each such stretch of text, FUN is called with three
3602 arguments: the property's value in that text, and the start and
3603 end positions of the text.
3605 This is done prior to removing the properties specified by
3606 `yank-excluded-properties'."
3607 :group 'killing
3608 :version "24.3")
3610 ;; This is actually used in subr.el but defcustom does not work there.
3611 (defcustom yank-excluded-properties
3612 '(category field follow-link fontified font-lock-face help-echo
3613 intangible invisible keymap local-map mouse-face read-only
3614 yank-handler)
3615 "Text properties to discard when yanking.
3616 The value should be a list of text properties to discard or t,
3617 which means to discard all text properties.
3619 See also `yank-handled-properties'."
3620 :type '(choice (const :tag "All" t) (repeat symbol))
3621 :group 'killing
3622 :version "24.3")
3624 (defvar yank-window-start nil)
3625 (defvar yank-undo-function nil
3626 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3627 Function is called with two parameters, START and END corresponding to
3628 the value of the mark and point; it is guaranteed that START <= END.
3629 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3631 (defun yank-pop (&optional arg)
3632 "Replace just-yanked stretch of killed text with a different stretch.
3633 This command is allowed only immediately after a `yank' or a `yank-pop'.
3634 At such a time, the region contains a stretch of reinserted
3635 previously-killed text. `yank-pop' deletes that text and inserts in its
3636 place a different stretch of killed text.
3638 With no argument, the previous kill is inserted.
3639 With argument N, insert the Nth previous kill.
3640 If N is negative, this is a more recent kill.
3642 The sequence of kills wraps around, so that after the oldest one
3643 comes the newest one.
3645 When this command inserts killed text into the buffer, it honors
3646 `yank-excluded-properties' and `yank-handler' as described in the
3647 doc string for `insert-for-yank-1', which see."
3648 (interactive "*p")
3649 (if (not (eq last-command 'yank))
3650 (error "Previous command was not a yank"))
3651 (setq this-command 'yank)
3652 (unless arg (setq arg 1))
3653 (let ((inhibit-read-only t)
3654 (before (< (point) (mark t))))
3655 (if before
3656 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3657 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3658 (setq yank-undo-function nil)
3659 (set-marker (mark-marker) (point) (current-buffer))
3660 (insert-for-yank (current-kill arg))
3661 ;; Set the window start back where it was in the yank command,
3662 ;; if possible.
3663 (set-window-start (selected-window) yank-window-start t)
3664 (if before
3665 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3666 ;; It is cleaner to avoid activation, even though the command
3667 ;; loop would deactivate the mark because we inserted text.
3668 (goto-char (prog1 (mark t)
3669 (set-marker (mark-marker) (point) (current-buffer))))))
3670 nil)
3672 (defun yank (&optional arg)
3674 More precisely, reinsert the most recent kill, which is the
3675 stretch of killed text most recently killed OR yanked. Put point
3676 at the end, and set mark at the beginning without activating it.
3678 With argument N, reinsert the Nth most recent kill.
3680 When this command inserts text into the buffer, it honors the
3681 `yank-handled-properties' and `yank-excluded-properties'
3682 variables, and the `yank-handler' text property. See
3683 `insert-for-yank-1' for details.
3686 (interactive "*P")
3687 (setq yank-window-start (window-start))
3688 ;; If we don't get all the way thru, make last-command indicate that
3689 ;; for the following command.
3690 (setq this-command t)
3691 (push-mark (point))
3692 (insert-for-yank (current-kill (cond
3693 ((listp arg) 0)
3694 ((eq arg '-) -2)
3695 (t (1- arg)))))
3696 (if (consp arg)
3697 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3698 ;; It is cleaner to avoid activation, even though the command
3699 ;; loop would deactivate the mark because we inserted text.
3700 (goto-char (prog1 (mark t)
3701 (set-marker (mark-marker) (point) (current-buffer)))))
3702 ;; If we do get all the way thru, make this-command indicate that.
3703 (if (eq this-command t)
3704 (setq this-command 'yank))
3705 nil)
3707 (defun rotate-yank-pointer (arg)
3708 "Rotate the yanking point in the kill ring.
3709 With ARG, rotate that many kills forward (or backward, if negative)."
3710 (interactive "p")
3711 (current-kill arg))
3712 \f
3713 ;; Some kill commands.
3715 ;; Internal subroutine of delete-char
3716 (defun kill-forward-chars (arg)
3717 (if (listp arg) (setq arg (car arg)))
3718 (if (eq arg '-) (setq arg -1))
3719 (kill-region (point) (+ (point) arg)))
3721 ;; Internal subroutine of backward-delete-char
3722 (defun kill-backward-chars (arg)
3723 (if (listp arg) (setq arg (car arg)))
3724 (if (eq arg '-) (setq arg -1))
3725 (kill-region (point) (- (point) arg)))
3727 (defcustom backward-delete-char-untabify-method 'untabify
3728 "The method for untabifying when deleting backward.
3729 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3730 `hungry' -- delete all whitespace, both tabs and spaces;
3731 `all' -- delete all whitespace, including tabs, spaces and newlines;
3732 nil -- just delete one character."
3733 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3734 :version "20.3"
3735 :group 'killing)
3737 (defun backward-delete-char-untabify (arg &optional killp)
3738 "Delete characters backward, changing tabs into spaces.
3739 The exact behavior depends on `backward-delete-char-untabify-method'.
3740 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3741 Interactively, ARG is the prefix arg (default 1)
3742 and KILLP is t if a prefix arg was specified."
3744 (when (eq backward-delete-char-untabify-method 'untabify)
3745 (let ((count arg))
3746 (save-excursion
3747 (while (and (> count 0) (not (bobp)))
3749 (let ((col (current-column)))
3750 (forward-char -1)
3751 (setq col (- col (current-column)))
3752 (insert-char ?\s col)
3753 (delete-char 1)))
3754 (forward-char -1)
3755 (setq count (1- count))))))
3757 ((eq backward-delete-char-untabify-method 'all)
3759 (n (if skip
3760 (let* ((oldpt (point))
3761 (wh (- oldpt (save-excursion
3762 (skip-chars-backward skip)
3763 (constrain-to-field nil oldpt)))))
3764 (+ arg (if (zerop wh) 0 (1- wh))))
3765 arg)))
3766 ;; Avoid warning about delete-backward-char
3767 (with-no-warnings (delete-backward-char n killp))))
3769 (defun zap-to-char (arg char)
3770 "Kill up to and including ARGth occurrence of CHAR.
3771 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3772 Goes backward if ARG is negative; error if CHAR not found."
3773 (interactive (list (prefix-numeric-value current-prefix-arg)
3774 (read-char "Zap to char: " t)))
3775 ;; Avoid "obsolete" warnings for translation-table-for-input.
3776 (with-no-warnings
3777 (if (char-table-p translation-table-for-input)
3778 (setq char (or (aref translation-table-for-input char) char))))
3779 (kill-region (point) (progn
3780 (search-forward (char-to-string char) nil nil arg)
3781 (point))))
3783 ;; kill-line and its subroutines.
3785 (defcustom kill-whole-line nil
3786 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3787 :type 'boolean
3788 :group 'killing)
3790 (defun kill-line (&optional arg)
3791 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3792 With prefix argument ARG, kill that many lines from point.
3793 Negative arguments kill lines backward.
3794 With zero argument, kills the text before point on the current line.
3797 a number counts as a prefix arg.
3799 To kill a whole line, when point is not at the beginning, type \
3802 If `show-trailing-whitespace' is non-nil, this command will just
3803 kill the rest of the current line, even if there are only
3804 nonblanks there.
3806 If `kill-whole-line' is non-nil, then this command kills the whole line
3807 including its terminating newline, when used at the beginning of a line
3808 with no argument. As a consequence, you can always kill a whole line
3811 If you want to append the killed line to the last killed text,
3814 If the buffer is read-only, Emacs will beep and refrain from deleting
3815 the line, but put the line in the kill ring anyway. This means that
3816 you can use this command to copy text from a read-only buffer.
3817 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3818 even beep.)"
3819 (interactive "P")
3820 (kill-region (point)
3821 ;; It is better to move point to the other end of the kill
3822 ;; before killing. That way, in a read-only buffer, point
3823 ;; moves across the text that is copied to the kill ring.
3824 ;; The choice has no effect on undo now that undo records
3825 ;; the value of point from before the command was run.
3826 (progn
3827 (if arg
3828 (forward-visible-line (prefix-numeric-value arg))
3829 (if (eobp)
3830 (signal 'end-of-buffer nil))
3831 (let ((end
3832 (save-excursion
3833 (end-of-visible-line) (point))))
3834 (if (or (save-excursion
3835 ;; If trailing whitespace is visible,
3836 ;; don't treat it as nothing.
3837 (unless show-trailing-whitespace
3839 (= (point) end))
3840 (and kill-whole-line (bolp)))
3841 (forward-visible-line 1)
3842 (goto-char end))))
3843 (point))))
3845 (defun kill-whole-line (&optional arg)
3846 "Kill current line.
3847 With prefix ARG, kill that many lines starting from the current line.
3848 If ARG is negative, kill backward. Also kill the preceding newline.
3850 If ARG is zero, kill current line but exclude the trailing newline."
3851 (interactive "p")
3852 (or arg (setq arg 1))
3853 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3854 (signal 'end-of-buffer nil))
3855 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3856 (signal 'beginning-of-buffer nil))
3857 (unless (eq last-command 'kill-region)
3858 (kill-new "")
3859 (setq last-command 'kill-region))
3860 (cond ((zerop arg)
3861 ;; We need to kill in two steps, because the previous command
3862 ;; could have been a kill command, in which case the text
3863 ;; before point needs to be prepended to the current kill
3864 ;; ring entry and the text after point appended. Also, we
3865 ;; need to use save-excursion to avoid copying the same text
3866 ;; twice to the kill ring in read-only buffers.
3867 (save-excursion
3868 (kill-region (point) (progn (forward-visible-line 0) (point))))
3869 (kill-region (point) (progn (end-of-visible-line) (point))))
3870 ((< arg 0)
3871 (save-excursion
3872 (kill-region (point) (progn (end-of-visible-line) (point))))
3873 (kill-region (point)
3874 (progn (forward-visible-line (1+ arg))
3875 (unless (bobp) (backward-char))
3876 (point))))
3877 (t
3878 (save-excursion
3879 (kill-region (point) (progn (forward-visible-line 0) (point))))
3880 (kill-region (point)
3881 (progn (forward-visible-line arg) (point))))))
3883 (defun forward-visible-line (arg)
3884 "Move forward by ARG lines, ignoring currently invisible newlines only.
3885 If ARG is negative, move backward -ARG lines.
3886 If ARG is zero, move to the beginning of the current line."
3887 (condition-case nil
3888 (if (> arg 0)
3889 (progn
3890 (while (> arg 0)
3891 (or (zerop (forward-line 1))
3892 (signal 'end-of-buffer nil))
3893 ;; If the newline we just skipped is invisible,
3894 ;; don't count it.
3895 (let ((prop
3896 (get-char-property (1- (point)) 'invisible)))
3897 (if (if (eq buffer-invisibility-spec t)
3898 prop
3899 (or (memq prop buffer-invisibility-spec)
3900 (assq prop buffer-invisibility-spec)))
3901 (setq arg (1+ arg))))
3902 (setq arg (1- arg)))
3903 ;; If invisible text follows, and it is a number of complete lines,
3904 ;; skip it.
3905 (let ((opoint (point)))
3906 (while (and (not (eobp))
3907 (let ((prop
3908 (get-char-property (point) 'invisible)))
3909 (if (eq buffer-invisibility-spec t)
3910 prop
3911 (or (memq prop buffer-invisibility-spec)
3912 (assq prop buffer-invisibility-spec)))))
3913 (goto-char
3914 (if (get-text-property (point) 'invisible)
3915 (or (next-single-property-change (point) 'invisible)
3916 (point-max))
3917 (next-overlay-change (point)))))
3918 (unless (bolp)
3919 (goto-char opoint))))
3920 (let ((first t))
3921 (while (or first (<= arg 0))
3922 (if first
3923 (beginning-of-line)
3924 (or (zerop (forward-line -1))
3925 (signal 'beginning-of-buffer nil)))
3926 ;; If the newline we just moved to is invisible,
3927 ;; don't count it.
3928 (unless (bobp)
3929 (let ((prop
3930 (get-char-property (1- (point)) 'invisible)))
3931 (unless (if (eq buffer-invisibility-spec t)
3932 prop
3933 (or (memq prop buffer-invisibility-spec)
3934 (assq prop buffer-invisibility-spec)))
3935 (setq arg (1+ arg)))))
3936 (setq first nil))
3937 ;; If invisible text follows, and it is a number of complete lines,
3938 ;; skip it.
3939 (let ((opoint (point)))
3940 (while (and (not (bobp))
3941 (let ((prop
3942 (get-char-property (1- (point)) 'invisible)))
3943 (if (eq buffer-invisibility-spec t)
3944 prop
3945 (or (memq prop buffer-invisibility-spec)
3946 (assq prop buffer-invisibility-spec)))))
3947 (goto-char
3948 (if (get-text-property (1- (point)) 'invisible)
3949 (or (previous-single-property-change (point) 'invisible)
3950 (point-min))
3951 (previous-overlay-change (point)))))
3952 (unless (bolp)
3953 (goto-char opoint)))))
3954 ((beginning-of-buffer end-of-buffer)
3955 nil)))
3957 (defun end-of-visible-line ()
3958 "Move to end of current visible line."
3959 (end-of-line)
3960 ;; If the following character is currently invisible,
3961 ;; skip all characters with that same `invisible' property value,
3962 ;; then find the next newline.
3963 (while (and (not (eobp))
3964 (save-excursion
3966 (let ((prop
3967 (get-char-property (point) 'invisible)))
3968 (if (eq buffer-invisibility-spec t)
3969 prop
3970 (or (memq prop buffer-invisibility-spec)
3971 (assq prop buffer-invisibility-spec))))))
3973 (if (get-text-property (point) 'invisible)
3974 (goto-char (or (next-single-property-change (point) 'invisible)
3975 (point-max)))
3976 (goto-char (next-overlay-change (point))))
3977 (end-of-line)))
3978 \f
3979 (defun insert-buffer (buffer)
3980 "Insert after point the contents of BUFFER.
3981 Puts mark after the inserted text.
3982 BUFFER may be a buffer or a buffer name.
3984 This function is meant for the user to run interactively.
3985 Don't call it from programs: use `insert-buffer-substring' instead!"
3986 (interactive
3987 (list
3988 (progn
3989 (barf-if-buffer-read-only)
3990 (read-buffer "Insert buffer: "
3991 (if (eq (selected-window) (next-window (selected-window)))
3992 (other-buffer (current-buffer))
3993 (window-buffer (next-window (selected-window))))
3994 t))))
3995 (push-mark
3996 (save-excursion
3997 (insert-buffer-substring (get-buffer buffer))
3998 (point)))
3999 nil)
4001 (defun append-to-buffer (buffer start end)
4002 "Append to specified buffer the text of the region.
4003 It is inserted into that buffer before its point.
4005 When calling from a program, give three arguments:
4006 BUFFER (or buffer name), START and END.
4007 START and END specify the portion of the current buffer to be copied."
4008 (interactive
4009 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4010 (region-beginning) (region-end)))
4011 (let* ((oldbuf (current-buffer))
4012 (append-to (get-buffer-create buffer))
4013 (windows (get-buffer-window-list append-to t t))
4014 point)
4015 (save-excursion
4016 (with-current-buffer append-to
4017 (setq point (point))
4018 (barf-if-buffer-read-only)
4019 (insert-buffer-substring oldbuf start end)
4020 (dolist (window windows)
4021 (when (= (window-point window) point)
4022 (set-window-point window (point))))))))
4024 (defun prepend-to-buffer (buffer start end)
4025 "Prepend to specified buffer the text of the region.
4026 It is inserted into that buffer after its point.
4028 When calling from a program, give three arguments:
4029 BUFFER (or buffer name), START and END.
4030 START and END specify the portion of the current buffer to be copied."
4032 (let ((oldbuf (current-buffer)))
4033 (with-current-buffer (get-buffer-create buffer)
4034 (barf-if-buffer-read-only)
4035 (save-excursion
4036 (insert-buffer-substring oldbuf start end)))))
4038 (defun copy-to-buffer (buffer start end)
4039 "Copy to specified buffer the text of the region.
4040 It is inserted into that buffer, replacing existing text there.
4042 When calling from a program, give three arguments:
4043 BUFFER (or buffer name), START and END.
4044 START and END specify the portion of the current buffer to be copied."
4046 (let ((oldbuf (current-buffer)))
4047 (with-current-buffer (get-buffer-create buffer)
4048 (barf-if-buffer-read-only)
4049 (erase-buffer)
4050 (save-excursion
4051 (insert-buffer-substring oldbuf start end)))))
4052 \f
4053 (put 'mark-inactive 'error-conditions '(mark-inactive error))
4054 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
4056 (defvar activate-mark-hook nil
4057 "Hook run when the mark becomes active.
4058 It is also run at the end of a command, if the mark is active and
4059 it is possible that the region may have changed.")
4061 (defvar deactivate-mark-hook nil
4062 "Hook run when the mark becomes inactive.")
4064 (defun mark (&optional force)
4065 "Return this buffer's mark value as integer, or nil if never set.
4067 In Transient Mark mode, this function signals an error if
4068 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4069 or the argument FORCE is non-nil, it disregards whether the mark
4070 is active, and returns an integer or nil in the usual way.
4072 If you are using this in an editing command, you are most likely making
4073 a mistake; see the documentation of `set-mark'."
4074 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4075 (marker-position (mark-marker))
4076 (signal 'mark-inactive nil)))
4078 (defsubst deactivate-mark (&optional force)
4079 "Deactivate the mark.
4080 If Transient Mark mode is disabled, this function normally does
4081 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4083 Deactivating the mark sets `mark-active' to nil, updates the
4084 primary selection according to `select-active-regions', and runs
4085 `deactivate-mark-hook'.
4087 If Transient Mark mode was temporarily enabled, reset the value
4088 of the variable `transient-mark-mode'; if this causes Transient
4089 Mark mode to be disabled, don't change `mark-active' to nil or
4090 run `deactivate-mark-hook'."
4091 (when (or transient-mark-mode force)
4092 (when (and (if (eq select-active-regions 'only)
4093 (eq (car-safe transient-mark-mode) 'only)
4094 select-active-regions)
4095 (region-active-p)
4096 (display-selections-p))
4097 ;; The var `saved-region-selection', if non-nil, is the text in
4098 ;; the region prior to the last command modifying the buffer.
4099 ;; Set the selection to that, or to the current region.
4100 (cond (saved-region-selection
4101 (x-set-selection 'PRIMARY saved-region-selection)
4102 (setq saved-region-selection nil))
4103 ;; If another program has acquired the selection, region
4104 ;; deactivation should not clobber it (Bug#11772).
4105 ((and (/= (region-beginning) (region-end))
4106 (or (x-selection-owner-p 'PRIMARY)
4107 (null (x-selection-exists-p 'PRIMARY))))
4108 (x-set-selection 'PRIMARY
4109 (buffer-substring (region-beginning)
4110 (region-end))))))
4111 (if (and (null force)
4112 (or (eq transient-mark-mode 'lambda)
4113 (and (eq (car-safe transient-mark-mode) 'only)
4114 (null (cdr transient-mark-mode)))))
4115 ;; When deactivating a temporary region, don't change
4116 ;; `mark-active' or run `deactivate-mark-hook'.
4117 (setq transient-mark-mode nil)
4118 (if (eq (car-safe transient-mark-mode) 'only)
4119 (setq transient-mark-mode (cdr transient-mark-mode)))
4120 (setq mark-active nil)
4121 (run-hooks 'deactivate-mark-hook))))
4123 (defun activate-mark ()
4124 "Activate the mark."
4125 (when (mark t)
4126 (setq mark-active t)
4127 (unless transient-mark-mode
4128 (setq transient-mark-mode 'lambda))
4129 (run-hooks 'activate-mark-hook)))
4131 (defun set-mark (pos)
4132 "Set this buffer's mark to POS. Don't use this function!
4133 That is to say, don't use this function unless you want
4134 the user to see that the mark has moved, and you want the previous
4135 mark position to be lost.
4137 Normally, when a new mark is set, the old one should go on the stack.
4138 This is why most applications should use `push-mark', not `set-mark'.
4140 Novice Emacs Lisp programmers often try to use the mark for the wrong
4141 purposes. The mark saves a location for the user's convenience.
4142 Most editing commands should not alter the mark.
4143 To remember a location for internal use in the Lisp program,
4144 store it in a Lisp variable. Example:
4146 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4148 (if pos
4149 (progn
4150 (setq mark-active t)
4151 (run-hooks 'activate-mark-hook)
4152 (set-marker (mark-marker) pos (current-buffer)))
4153 ;; Normally we never clear mark-active except in Transient Mark mode.
4154 ;; But when we actually clear out the mark value too, we must
4155 ;; clear mark-active in any mode.
4156 (deactivate-mark t)
4157 (set-marker (mark-marker) nil)))
4159 (defcustom use-empty-active-region nil
4161 If nil, region-aware commands treat empty regions as inactive.
4162 If non-nil, region-aware commands treat the region as active as
4163 long as the mark is active, even if the region is empty.
4165 Region-aware commands are those that act on the region if it is
4166 active and Transient Mark mode is enabled, and on the text near
4167 point otherwise."
4168 :type 'boolean
4169 :version "23.1"
4170 :group 'editing-basics)
4172 (defun use-region-p ()
4173 "Return t if the region is active and it is appropriate to act on it.
4174 This is used by commands that act specially on the region under
4175 Transient Mark mode.
4177 The return value is t if Transient Mark mode is enabled and the
4178 mark is active; furthermore, if `use-empty-active-region' is nil,
4179 the region must not be empty. Otherwise, the return value is nil.
4181 For some commands, it may be appropriate to ignore the value of
4182 `use-empty-active-region'; in that case, use `region-active-p'."
4183 (and (region-active-p)
4184 (or use-empty-active-region (> (region-end) (region-beginning)))))
4186 (defun region-active-p ()
4187 "Return t if Transient Mark mode is enabled and the mark is active.
4189 Some commands act specially on the region when Transient Mark
4190 mode is enabled. Usually, such commands should use
4191 `use-region-p' instead of this function, because `use-region-p'
4192 also checks the value of `use-empty-active-region'."
4193 (and transient-mark-mode mark-active))
4195 (defvar mark-ring nil
4196 "The list of former marks of the current buffer, most recent first.")
4197 (make-variable-buffer-local 'mark-ring)
4198 (put 'mark-ring 'permanent-local t)
4200 (defcustom mark-ring-max 16
4201 "Maximum size of mark ring. Start discarding off end if gets this big."
4202 :type 'integer
4203 :group 'editing-basics)
4205 (defvar global-mark-ring nil
4206 "The list of saved global marks, most recent first.")
4208 (defcustom global-mark-ring-max 16
4209 "Maximum size of global mark ring. \
4210 Start discarding off end if gets this big."
4211 :type 'integer
4212 :group 'editing-basics)
4214 (defun pop-to-mark-command ()
4215 "Jump to mark, and pop a new position for mark off the ring.
4216 \(Does not affect global mark ring\)."
4217 (interactive)
4218 (if (null (mark t))
4219 (error "No mark set in this buffer")
4220 (if (= (point) (mark t))
4221 (message "Mark popped"))
4222 (goto-char (mark t))
4223 (pop-mark)))
4225 (defun push-mark-command (arg &optional nomsg)
4226 "Set mark at where point is.
4227 If no prefix ARG and mark is already set there, just activate it.
4228 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4229 (interactive "P")
4230 (let ((mark (marker-position (mark-marker))))
4231 (if (or arg (null mark) (/= mark (point)))
4232 (push-mark nil nomsg t)
4233 (setq mark-active t)
4234 (run-hooks 'activate-mark-hook)
4235 (unless nomsg
4236 (message "Mark activated")))))
4238 (defcustom set-mark-command-repeat-pop nil
4241 will pop the mark twice, and
4243 will pop the mark three times.
4247 :type 'boolean
4248 :group 'editing-basics)
4250 (defun set-mark-command (arg)
4251 "Set the mark where point is, or jump to the mark.
4252 Setting the mark also alters the region, which is the text
4253 between point and mark; this is the closest equivalent in
4256 With no prefix argument, set the mark at point, and push the
4257 old mark position on local mark ring. Also push the old mark on
4258 global mark ring, if the previous mark was set in another buffer.
4260 When Transient Mark Mode is off, immediately repeating this
4261 command activates `transient-mark-mode' temporarily.
4264 jump to the mark, and set the mark from
4265 position popped off the local mark ring \(this does not affect the global
4267 mark ring \(see `pop-global-mark'\).
4269 If `set-mark-command-repeat-pop' is non-nil, repeating
4271 off the local (or global) mark ring and jumps there.
4274 argument, unconditionally set mark where point is, even if
4275 `set-mark-command-repeat-pop' is non-nil.
4277 Novice Emacs Lisp programmers often try to use the mark for the wrong
4278 purposes. See the documentation of `set-mark' for more information."
4279 (interactive "P")
4280 (cond ((eq transient-mark-mode 'lambda)
4281 (setq transient-mark-mode nil))
4282 ((eq (car-safe transient-mark-mode) 'only)
4283 (deactivate-mark)))
4284 (cond
4285 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4286 (push-mark-command nil))
4287 ((not (eq this-command 'set-mark-command))
4288 (if arg
4289 (pop-to-mark-command)
4290 (push-mark-command t)))
4291 ((and set-mark-command-repeat-pop
4292 (eq last-command 'pop-to-mark-command))
4293 (setq this-command 'pop-to-mark-command)
4294 (pop-to-mark-command))
4295 ((and set-mark-command-repeat-pop
4296 (eq last-command 'pop-global-mark)
4297 (not arg))
4298 (setq this-command 'pop-global-mark)
4299 (pop-global-mark))
4300 (arg
4301 (setq this-command 'pop-to-mark-command)
4302 (pop-to-mark-command))
4303 ((eq last-command 'set-mark-command)
4304 (if (region-active-p)
4305 (progn
4306 (deactivate-mark)
4307 (message "Mark deactivated"))
4308 (activate-mark)
4309 (message "Mark activated")))
4310 (t
4311 (push-mark-command nil))))
4313 (defun push-mark (&optional location nomsg activate)
4314 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4315 If the last global mark pushed was not in the current buffer,
4316 also push LOCATION on the global mark ring.
4317 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4319 Novice Emacs Lisp programmers often try to use the mark for the wrong
4320 purposes. See the documentation of `set-mark' for more information.
4322 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4323 (unless (null (mark t))
4324 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4325 (when (> (length mark-ring) mark-ring-max)
4326 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4327 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4328 (set-marker (mark-marker) (or location (point)) (current-buffer))
4329 ;; Now push the mark on the global mark ring.
4330 (if (and global-mark-ring
4331 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4332 ;; The last global mark pushed was in this same buffer.
4333 ;; Don't push another one.
4334 nil
4335 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4336 (when (> (length global-mark-ring) global-mark-ring-max)
4337 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4338 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4339 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4340 (message "Mark set"))
4341 (if (or activate (not transient-mark-mode))
4342 (set-mark (mark t)))
4343 nil)
4345 (defun pop-mark ()
4346 "Pop off mark ring into the buffer's actual mark.
4347 Does not set point. Does nothing if mark ring is empty."
4348 (when mark-ring
4349 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4350 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4351 (move-marker (car mark-ring) nil)
4352 (if (null (mark t)) (ding))
4353 (setq mark-ring (cdr mark-ring)))
4354 (deactivate-mark))
4356 (define-obsolete-function-alias
4357 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4358 (defun exchange-point-and-mark (&optional arg)
4359 "Put the mark where point is now, and point where the mark is now.
4360 This command works even when the mark is not active,
4361 and it reactivates the mark.
4363 If Transient Mark mode is on, a prefix ARG deactivates the mark
4364 if it is active, and otherwise avoids reactivating it. If
4365 Transient Mark mode is off, a prefix ARG enables Transient Mark
4366 mode temporarily."
4367 (interactive "P")
4368 (let ((omark (mark t))
4369 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4370 (if (null omark)
4371 (error "No mark set in this buffer"))
4372 (deactivate-mark)
4373 (set-mark (point))
4374 (goto-char omark)
4375 (cond (temp-highlight
4376 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4377 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4378 (not (or arg (region-active-p))))
4379 (deactivate-mark))
4380 (t (activate-mark)))
4381 nil))
4383 (defcustom shift-select-mode t
4384 "When non-nil, shifted motion keys activate the mark momentarily.
4386 While the mark is activated in this way, any shift-translated point
4387 motion key extends the region, and if Transient Mark mode was off, it
4388 is temporarily turned on. Furthermore, the mark will be deactivated
4389 by any subsequent point motion key that was not shift-translated, or
4390 by any action that normally deactivates the mark in Transient Mark mode.
4392 See `this-command-keys-shift-translated' for the meaning of
4393 shift-translation."
4394 :type 'boolean
4395 :group 'editing-basics)
4397 (defun handle-shift-selection ()
4398 "Activate/deactivate mark depending on invocation thru shift translation.
4399 This function is called by `call-interactively' when a command
4400 with a `^' character in its `interactive' spec is invoked, before
4401 running the command itself.
4403 If `shift-select-mode' is enabled and the command was invoked
4404 through shift translation, set the mark and activate the region
4405 temporarily, unless it was already set in this way. See
4406 `this-command-keys-shift-translated' for the meaning of shift
4407 translation.
4409 Otherwise, if the region has been activated temporarily,
4410 deactivate it, and restore the variable `transient-mark-mode' to
4411 its earlier value."
4412 (cond ((and shift-select-mode this-command-keys-shift-translated)
4413 (unless (and mark-active
4414 (eq (car-safe transient-mark-mode) 'only))
4415 (setq transient-mark-mode
4416 (cons 'only
4417 (unless (eq transient-mark-mode 'lambda)
4418 transient-mark-mode)))
4419 (push-mark nil nil t)))
4420 ((eq (car-safe transient-mark-mode) 'only)
4421 (setq transient-mark-mode (cdr transient-mark-mode))
4422 (deactivate-mark))))
4424 (define-minor-mode transient-mark-mode
4425 "Toggle Transient Mark mode.
4426 With a prefix argument ARG, enable Transient Mark mode if ARG is
4427 positive, and disable it otherwise. If called from Lisp, enable
4428 Transient Mark mode if ARG is omitted or nil.
4430 Transient Mark mode is a global minor mode. When enabled, the
4431 region is highlighted whenever the mark is active. The mark is
4433 operations that set the mark but whose main purpose is something
4439 Many commands change their behavior when Transient Mark mode is
4440 in effect and the mark is active, by acting on the region instead
4441 of their usual default part of the buffer's text. Examples of
4444 To see the documentation of commands which are sensitive to the
4447 :global t
4448 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4449 :variable transient-mark-mode)
4451 (defvar widen-automatically t
4452 "Non-nil means it is ok for commands to call `widen' when they want to.
4453 Some commands will do this in order to go to positions outside
4454 the current accessible part of the buffer.
4456 If `widen-automatically' is nil, these commands will do something else
4457 as a fallback, and won't change the buffer bounds.")
4459 (defvar non-essential nil
4460 "Whether the currently executing code is performing an essential task.
4461 This variable should be non-nil only when running code which should not
4462 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4463 user for a password when we are simply scanning a set of files in the
4464 background or displaying possible completions before the user even asked
4465 for it.")
4467 (defun pop-global-mark ()
4468 "Pop off global mark ring and jump to the top location."
4469 (interactive)
4470 ;; Pop entries which refer to non-existent buffers.
4471 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4472 (setq global-mark-ring (cdr global-mark-ring)))
4473 (or global-mark-ring
4474 (error "No global mark set"))
4475 (let* ((marker (car global-mark-ring))
4476 (buffer (marker-buffer marker))
4477 (position (marker-position marker)))
4478 (setq global-mark-ring (nconc (cdr global-mark-ring)
4479 (list (car global-mark-ring))))
4480 (set-buffer buffer)
4481 (or (and (>= position (point-min))
4482 (<= position (point-max)))
4483 (if widen-automatically
4484 (widen)
4485 (error "Global mark position is outside accessible part of buffer")))
4486 (goto-char position)
4487 (switch-to-buffer buffer)))
4488 \f
4489 (defcustom next-line-add-newlines nil
4490 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4491 :type 'boolean
4492 :version "21.1"
4493 :group 'editing-basics)
4495 (defun next-line (&optional arg try-vscroll)
4496 "Move cursor vertically down ARG lines.
4497 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4498 If there is no character in the target line exactly under the current column,
4499 the cursor is positioned after the character in that line which spans this
4500 column, or at the end of the line if it is not long enough.
4501 If there is no line in the buffer after this one, behavior depends on the
4502 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4503 to create a line, and moves the cursor to that line. Otherwise it moves the
4504 cursor to the end of the buffer.
4506 If the variable `line-move-visual' is non-nil, this command moves
4507 by display lines. Otherwise, it moves by buffer lines, without
4508 taking variable-width characters or continued lines into account.
4511 a semipermanent goal column for this command.
4512 Then instead of trying to move exactly vertically (or as close as possible),
4513 this command moves to the specified goal column (or as close as possible).
4514 The goal column is stored in the variable `goal-column', which is nil
4515 when there is no goal column. Note that setting `goal-column'
4516 overrides `line-move-visual' and causes this command to move by buffer
4517 lines rather than by display lines.
4519 If you are thinking of using this in a Lisp program, consider
4520 using `forward-line' instead. It is usually easier to use
4521 and more reliable (no dependence on goal column, etc.)."
4523 (or arg (setq arg 1))
4524 (if (and next-line-add-newlines (= arg 1))
4525 (if (save-excursion (end-of-line) (eobp))
4526 ;; When adding a newline, don't expand an abbrev.
4527 (let ((abbrev-mode nil))
4528 (end-of-line)
4530 (line-move arg nil nil try-vscroll))
4531 (if (called-interactively-p 'interactive)
4532 (condition-case err
4533 (line-move arg nil nil try-vscroll)
4534 ((beginning-of-buffer end-of-buffer)
4535 (signal (car err) (cdr err))))
4536 (line-move arg nil nil try-vscroll)))
4537 nil)
4539 (defun previous-line (&optional arg try-vscroll)
4540 "Move cursor vertically up ARG lines.
4541 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4542 If there is no character in the target line exactly over the current column,
4543 the cursor is positioned after the character in that line which spans this
4544 column, or at the end of the line if it is not long enough.
4546 If the variable `line-move-visual' is non-nil, this command moves
4547 by display lines. Otherwise, it moves by buffer lines, without
4548 taking variable-width characters or continued lines into account.
4551 a semipermanent goal column for this command.
4552 Then instead of trying to move exactly vertically (or as close as possible),
4553 this command moves to the specified goal column (or as close as possible).
4554 The goal column is stored in the variable `goal-column', which is nil
4555 when there is no goal column. Note that setting `goal-column'
4556 overrides `line-move-visual' and causes this command to move by buffer
4557 lines rather than by display lines.
4559 If you are thinking of using this in a Lisp program, consider using
4560 `forward-line' with a negative argument instead. It is usually easier
4561 to use and more reliable (no dependence on goal column, etc.)."
4563 (or arg (setq arg 1))
4564 (if (called-interactively-p 'interactive)
4565 (condition-case err
4566 (line-move (- arg) nil nil try-vscroll)
4567 ((beginning-of-buffer end-of-buffer)
4568 (signal (car err) (cdr err))))
4569 (line-move (- arg) nil nil try-vscroll))
4570 nil)
4572 (defcustom track-eol nil
4573 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4574 This means moving to the end of each line moved onto.
4575 The beginning of a blank line does not count as the end of a line.
4576 This has no effect when `line-move-visual' is non-nil."
4577 :type 'boolean
4578 :group 'editing-basics)
4580 (defcustom goal-column nil
4582 A non-nil setting overrides `line-move-visual', which see."
4583 :type '(choice integer
4584 (const :tag "None" nil))
4585 :group 'editing-basics)
4586 (make-variable-buffer-local 'goal-column)
4588 (defvar temporary-goal-column 0
4589 "Current goal column for vertical motion.
4590 It is the column where point was at the start of the current run
4591 of vertical motion commands.
4593 When moving by visual lines via `line-move-visual', it is a cons
4594 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4595 divided by the default column width, and HSCROLL is the number of
4596 columns by which window is scrolled from left margin.
4598 When the `track-eol' feature is doing its job, the value is
4599 `most-positive-fixnum'.")
4601 (defcustom line-move-ignore-invisible t
4603 Outline mode sets this."
4604 :type 'boolean
4605 :group 'editing-basics)
4607 (defcustom line-move-visual t
4608 "When non-nil, `line-move' moves point by visual lines.
4609 This movement is based on where the cursor is displayed on the
4610 screen, instead of relying on buffer contents alone. It takes
4611 into account variable-width characters and line continuation.
4612 If nil, `line-move' moves point by logical lines.
4613 A non-nil setting of `goal-column' overrides the value of this variable
4614 and forces movement by logical lines.
4615 A window that is horizontally scrolled also forces movement by logical
4616 lines."
4617 :type 'boolean
4618 :group 'editing-basics
4619 :version "23.1")
4621 ;; Returns non-nil if partial move was done.
4622 (defun line-move-partial (arg noerror to-end)
4623 (if (< arg 0)
4624 ;; Move backward (up).
4625 ;; If already vscrolled, reduce vscroll
4626 (let ((vs (window-vscroll nil t)))
4627 (when (> vs (frame-char-height))
4628 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4630 ;; Move forward (down).
4631 (let* ((lh (window-line-height -1))
4632 (vpos (nth 1 lh))
4633 (ypos (nth 2 lh))
4634 (rbot (nth 3 lh))
4635 py vs)
4636 (when (or (null lh)
4637 (>= rbot (frame-char-height))
4638 (<= ypos (- (frame-char-height))))
4639 (unless lh
4640 (let ((wend (pos-visible-in-window-p t nil t)))
4641 (setq rbot (nth 3 wend)
4642 vpos (nth 5 wend))))
4643 (cond
4644 ;; If last line of window is fully visible, move forward.
4645 ((or (null rbot) (= rbot 0))
4646 nil)
4647 ;; If cursor is not in the bottom scroll margin, move forward.
4648 ((and (> vpos 0)
4649 (< (setq py
4650 (or (nth 1 (window-line-height))
4651 (let ((ppos (posn-at-point)))
4652 (cdr (or (posn-actual-col-row ppos)
4653 (posn-col-row ppos))))))
4654 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4655 nil)
4656 ;; When already vscrolled, we vscroll some more if we can,
4657 ;; or clear vscroll and move forward at end of tall image.
4658 ((> (setq vs (window-vscroll nil t)) 0)
4659 (when (> rbot 0)
4660 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4661 ;; If cursor just entered the bottom scroll margin, move forward,
4662 ;; but also vscroll one line so redisplay won't recenter.
4663 ((and (> vpos 0)
4664 (= py (min (- (window-text-height) scroll-margin 1)
4665 (1- vpos))))
4666 (set-window-vscroll nil (frame-char-height) t)
4667 (line-move-1 arg noerror to-end)
4668 t)
4669 ;; If there are lines above the last line, scroll-up one line.
4670 ((> vpos 0)
4671 (scroll-up 1)
4672 t)
4673 ;; Finally, start vscroll.
4674 (t
4675 (set-window-vscroll nil (frame-char-height) t)))))))
4678 ;; This is like line-move-1 except that it also performs
4679 ;; vertical scrolling of tall images if appropriate.
4680 ;; That is not really a clean thing to do, since it mixes
4681 ;; scrolling with cursor motion. But so far we don't have
4682 ;; a cleaner solution to the problem of making C-n do something
4683 ;; useful given a tall image.
4684 (defun line-move (arg &optional noerror to-end try-vscroll)
4685 (if noninteractive
4686 (forward-line arg)
4687 (unless (and auto-window-vscroll try-vscroll
4688 ;; Only vscroll for single line moves
4689 (= (abs arg) 1)
4690 ;; Under scroll-conservatively, the display engine
4691 ;; does this better.
4692 (zerop scroll-conservatively)
4693 ;; But don't vscroll in a keyboard macro.
4694 (not defining-kbd-macro)
4695 (not executing-kbd-macro)
4696 (line-move-partial arg noerror to-end))
4697 (set-window-vscroll nil 0 t)
4698 (if (and line-move-visual
4699 ;; Display-based column are incompatible with goal-column.
4700 (not goal-column)
4701 ;; When the text in the window is scrolled to the left,
4702 ;; display-based motion doesn't make sense (because each
4703 ;; logical line occupies exactly one screen line).
4704 (not (> (window-hscroll) 0)))
4705 (line-move-visual arg noerror)
4706 (line-move-1 arg noerror to-end)))))
4708 ;; Display-based alternative to line-move-1.
4709 ;; Arg says how many lines to move. The value is t if we can move the
4710 ;; specified number of lines.
4711 (defun line-move-visual (arg &optional noerror)
4712 (let ((opoint (point))
4713 (hscroll (window-hscroll))
4714 target-hscroll)
4715 ;; Check if the previous command was a line-motion command, or if
4716 ;; we were called from some other command.
4717 (if (and (consp temporary-goal-column)
4718 (memq last-command `(next-line previous-line ,this-command)))
4719 ;; If so, there's no need to reset `temporary-goal-column',
4720 ;; but we may need to hscroll.
4721 (if (or (/= (cdr temporary-goal-column) hscroll)
4722 (> (cdr temporary-goal-column) 0))
4723 (setq target-hscroll (cdr temporary-goal-column)))
4724 ;; Otherwise, we should reset `temporary-goal-column'.
4725 (let ((posn (posn-at-point)))
4726 (cond
4727 ;; Handle the `overflow-newline-into-fringe' case:
4728 ((eq (nth 1 posn) 'right-fringe)
4729 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4730 ((car (posn-x-y posn))
4731 (setq temporary-goal-column
4732 (cons (/ (float (car (posn-x-y posn)))
4733 (frame-char-width)) hscroll))))))
4734 (if target-hscroll
4735 (set-window-hscroll (selected-window) target-hscroll))
4736 (or (and (= (vertical-motion
4737 (cons (or goal-column
4738 (if (consp temporary-goal-column)
4739 (car temporary-goal-column)
4740 temporary-goal-column))
4741 arg))
4742 arg)
4743 (or (>= arg 0)
4744 (/= (point) opoint)
4745 ;; If the goal column lies on a display string,
4746 ;; `vertical-motion' advances the cursor to the end
4747 ;; of the string. For arg < 0, this can cause the
4748 ;; cursor to get stuck. (Bug#3020).
4749 (= (vertical-motion arg) arg)))
4750 (unless noerror
4751 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4752 nil)))))
4754 ;; This is the guts of next-line and previous-line.
4755 ;; Arg says how many lines to move.
4756 ;; The value is t if we can move the specified number of lines.
4757 (defun line-move-1 (arg &optional noerror _to-end)
4758 ;; Don't run any point-motion hooks, and disregard intangibility,
4759 ;; for intermediate positions.
4760 (let ((inhibit-point-motion-hooks t)
4761 (opoint (point))
4762 (orig-arg arg))
4763 (if (consp temporary-goal-column)
4764 (setq temporary-goal-column (+ (car temporary-goal-column)
4765 (cdr temporary-goal-column))))
4766 (unwind-protect
4767 (progn
4768 (if (not (memq last-command '(next-line previous-line)))
4769 (setq temporary-goal-column
4770 (if (and track-eol (eolp)
4771 ;; Don't count beg of empty line as end of line
4772 ;; unless we just did explicit end-of-line.
4773 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4774 most-positive-fixnum
4775 (current-column))))
4777 (if (not (or (integerp selective-display)
4778 line-move-ignore-invisible))
4779 ;; Use just newline characters.
4780 ;; Set ARG to 0 if we move as many lines as requested.
4781 (or (if (> arg 0)
4782 (progn (if (> arg 1) (forward-line (1- arg)))
4783 ;; This way of moving forward ARG lines
4784 ;; verifies that we have a newline after the last one.
4785 ;; It doesn't get confused by intangible text.
4786 (end-of-line)
4787 (if (zerop (forward-line 1))
4788 (setq arg 0)))
4789 (and (zerop (forward-line arg))
4790 (bolp)
4791 (setq arg 0)))
4792 (unless noerror
4793 (signal (if (< arg 0)
4794 'beginning-of-buffer
4795 'end-of-buffer)
4796 nil)))
4797 ;; Move by arg lines, but ignore invisible ones.
4798 (let (done)
4799 (while (and (> arg 0) (not done))
4800 ;; If the following character is currently invisible,
4801 ;; skip all characters with that same `invisible' property value.
4802 (while (and (not (eobp)) (invisible-p (point)))
4803 (goto-char (next-char-property-change (point))))
4804 ;; Move a line.
4805 ;; We don't use `end-of-line', since we want to escape
4806 ;; from field boundaries occurring exactly at point.
4807 (goto-char (constrain-to-field
4808 (let ((inhibit-field-text-motion t))
4809 (line-end-position))
4810 (point) t t
4811 'inhibit-line-move-field-capture))
4812 ;; If there's no invisibility here, move over the newline.
4813 (cond
4814 ((eobp)
4815 (if (not noerror)
4816 (signal 'end-of-buffer nil)
4817 (setq done t)))
4818 ((and (> arg 1) ;; Use vertical-motion for last move
4819 (not (integerp selective-display))
4820 (not (invisible-p (point))))
4821 ;; We avoid vertical-motion when possible
4822 ;; because that has to fontify.
4823 (forward-line 1))
4824 ;; Otherwise move a more sophisticated way.
4825 ((zerop (vertical-motion 1))
4826 (if (not noerror)
4827 (signal 'end-of-buffer nil)
4828 (setq done t))))
4829 (unless done
4830 (setq arg (1- arg))))
4831 ;; The logic of this is the same as the loop above,
4832 ;; it just goes in the other direction.
4833 (while (and (< arg 0) (not done))
4834 ;; For completely consistency with the forward-motion
4835 ;; case, we should call beginning-of-line here.
4836 ;; However, if point is inside a field and on a
4837 ;; continued line, the call to (vertical-motion -1)
4838 ;; below won't move us back far enough; then we return
4839 ;; to the same column in line-move-finish, and point
4840 ;; gets stuck -- cyd
4841 (forward-line 0)
4842 (cond
4843 ((bobp)
4844 (if (not noerror)
4845 (signal 'beginning-of-buffer nil)
4846 (setq done t)))
4847 ((and (< arg -1) ;; Use vertical-motion for last move
4848 (not (integerp selective-display))
4849 (not (invisible-p (1- (point)))))
4850 (forward-line -1))
4851 ((zerop (vertical-motion -1))
4852 (if (not noerror)
4853 (signal 'beginning-of-buffer nil)
4854 (setq done t))))
4855 (unless done
4856 (setq arg (1+ arg))
4857 (while (and ;; Don't move over previous invis lines
4858 ;; if our target is the middle of this line.
4859 (or (zerop (or goal-column temporary-goal-column))
4860 (< arg 0))
4861 (not (bobp)) (invisible-p (1- (point))))
4862 (goto-char (previous-char-property-change (point))))))))
4863 ;; This is the value the function returns.
4864 (= arg 0))
4866 (cond ((> arg 0)
4867 ;; If we did not move down as far as desired, at least go
4868 ;; to end of line. Be sure to call point-entered and
4869 ;; point-left-hooks.
4870 (let* ((npoint (prog1 (line-end-position)
4871 (goto-char opoint)))
4872 (inhibit-point-motion-hooks nil))
4873 (goto-char npoint)))
4874 ((< arg 0)
4875 ;; If we did not move up as far as desired,
4876 ;; at least go to beginning of line.
4877 (let* ((npoint (prog1 (line-beginning-position)
4878 (goto-char opoint)))
4879 (inhibit-point-motion-hooks nil))
4880 (goto-char npoint)))
4881 (t
4882 (line-move-finish (or goal-column temporary-goal-column)
4883 opoint (> orig-arg 0)))))))
4885 (defun line-move-finish (column opoint forward)
4886 (let ((repeat t))
4887 (while repeat
4888 ;; Set REPEAT to t to repeat the whole thing.
4889 (setq repeat nil)
4891 (let (new
4892 (old (point))
4893 (line-beg (line-beginning-position))
4894 (line-end
4895 ;; Compute the end of the line
4896 ;; ignoring effectively invisible newlines.
4897 (save-excursion
4898 ;; Like end-of-line but ignores fields.
4900 (while (and (not (eobp)) (invisible-p (point)))
4901 (goto-char (next-char-property-change (point)))
4903 (point))))
4905 ;; Move to the desired column.
4906 (line-move-to-column (truncate column))
4908 ;; Corner case: suppose we start out in a field boundary in
4909 ;; the middle of a continued line. When we get to
4910 ;; line-move-finish, point is at the start of a new *screen*
4911 ;; line but the same text line; then line-move-to-column would
4912 ;; move us backwards. Test using C-n with point on the "x" in
4913 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4914 (and forward
4915 (< (point) old)
4916 (goto-char old))
4918 (setq new (point))
4920 ;; Process intangibility within a line.
4921 ;; With inhibit-point-motion-hooks bound to nil, a call to
4922 ;; goto-char moves point past intangible text.
4924 ;; However, inhibit-point-motion-hooks controls both the
4925 ;; intangibility and the point-entered/point-left hooks. The
4926 ;; following hack avoids calling the point-* hooks
4927 ;; unnecessarily. Note that we move *forward* past intangible
4928 ;; text when the initial and final points are the same.
4929 (goto-char new)
4930 (let ((inhibit-point-motion-hooks nil))
4931 (goto-char new)
4933 ;; If intangibility moves us to a different (later) place
4934 ;; in the same line, use that as the destination.
4935 (if (<= (point) line-end)
4936 (setq new (point))
4937 ;; If that position is "too late",
4938 ;; try the previous allowable position.
4939 ;; See if it is ok.
4940 (backward-char)
4941 (if (if forward
4942 ;; If going forward, don't accept the previous
4943 ;; allowable position if it is before the target line.
4944 (< line-beg (point))
4945 ;; If going backward, don't accept the previous
4946 ;; allowable position if it is still after the target line.
4947 (<= (point) line-end))
4948 (setq new (point))
4949 ;; As a last resort, use the end of the line.
4950 (setq new line-end))))
4952 ;; Now move to the updated destination, processing fields
4953 ;; as well as intangibility.
4954 (goto-char opoint)
4955 (let ((inhibit-point-motion-hooks nil))
4956 (goto-char
4957 ;; Ignore field boundaries if the initial and final
4958 ;; positions have the same `field' property, even if the
4959 ;; fields are non-contiguous. This seems to be "nicer"
4960 ;; behavior in many situations.
4961 (if (eq (get-char-property new 'field)
4962 (get-char-property opoint 'field))
4963 new
4964 (constrain-to-field new opoint t t
4965 'inhibit-line-move-field-capture))))
4967 ;; If all this moved us to a different line,
4968 ;; retry everything within that new line.
4969 (when (or (< (point) line-beg) (> (point) line-end))
4970 ;; Repeat the intangibility and field processing.
4971 (setq repeat t))))))
4973 (defun line-move-to-column (col)
4974 "Try to find column COL, considering invisibility.
4975 This function works only in certain cases,
4976 because what we really need is for `move-to-column'
4977 and `current-column' to be able to ignore invisible text."
4978 (if (zerop col)
4979 (beginning-of-line)
4980 (move-to-column col))
4982 (when (and line-move-ignore-invisible
4983 (not (bolp)) (invisible-p (1- (point))))
4984 (let ((normal-location (point))
4985 (normal-column (current-column)))
4986 ;; If the following character is currently invisible,
4987 ;; skip all characters with that same `invisible' property value.
4988 (while (and (not (eobp))
4989 (invisible-p (point)))
4990 (goto-char (next-char-property-change (point))))
4991 ;; Have we advanced to a larger column position?
4992 (if (> (current-column) normal-column)
4993 ;; We have made some progress towards the desired column.
4994 ;; See if we can make any further progress.
4995 (line-move-to-column (+ (current-column) (- col normal-column)))
4996 ;; Otherwise, go to the place we originally found
4997 ;; and move back over invisible text.
4998 ;; that will get us to the same place on the screen
4999 ;; but with a more reasonable buffer position.
5000 (goto-char normal-location)
5001 (let ((line-beg (line-beginning-position)))
5002 (while (and (not (bolp)) (invisible-p (1- (point))))
5003 (goto-char (previous-char-property-change (point) line-beg))))))))
5005 (defun move-end-of-line (arg)
5006 "Move point to end of current line as displayed.
5007 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5008 If point reaches the beginning or end of buffer, it stops there.
5010 To ignore the effects of the `intangible' text or overlay
5011 property, bind `inhibit-point-motion-hooks' to t.
5012 If there is an image in the current line, this function
5013 disregards newlines that are part of the text on which the image
5014 rests."
5015 (interactive "^p")
5016 (or arg (setq arg 1))
5017 (let (done)
5018 (while (not done)
5019 (let ((newpos
5020 (save-excursion
5021 (let ((goal-column 0)
5022 (line-move-visual nil))
5023 (and (line-move arg t)
5024 ;; With bidi reordering, we may not be at bol,
5025 ;; so make sure we are.
5027 (not (bobp))
5028 (progn
5029 (while (and (not (bobp)) (invisible-p (1- (point))))
5030 (goto-char (previous-single-char-property-change
5031 (point) 'invisible)))
5032 (backward-char 1)))
5033 (point)))))
5034 (goto-char newpos)
5035 (if (and (> (point) newpos)
5037 (backward-char 1)
5038 (if (and (> (point) newpos) (not (eobp))
5040 ;; If we skipped something intangible and now we're not
5041 ;; really at eol, keep going.
5042 (setq arg 1)
5043 (setq done t)))))))
5045 (defun move-beginning-of-line (arg)
5046 "Move point to beginning of current line as displayed.
5047 \(If there's an image in the line, this disregards newlines
5048 which are part of the text that the image rests on.)
5050 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5051 If point reaches the beginning or end of buffer, it stops there.
5052 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5053 (interactive "^p")
5054 (or arg (setq arg 1))
5056 (let ((orig (point))
5057 first-vis first-vis-field-value)
5059 ;; Move by lines, if ARG is not 1 (the default).
5060 (if (/= arg 1)
5061 (let ((line-move-visual nil))
5062 (line-move (1- arg) t)))
5064 ;; Move to beginning-of-line, ignoring fields and invisible text.
5066 (while (and (not (bobp)) (invisible-p (1- (point))))
5067 (goto-char (previous-char-property-change (point)))
5070 ;; Now find first visible char in the line
5071 (while (and (not (eobp)) (invisible-p (point)))
5072 (goto-char (next-char-property-change (point))))
5073 (setq first-vis (point))
5075 ;; See if fields would stop us from reaching FIRST-VIS.
5076 (setq first-vis-field-value
5077 (constrain-to-field first-vis orig (/= arg 1) t nil))
5079 (goto-char (if (/= first-vis-field-value first-vis)
5080 ;; If yes, obey them.
5081 first-vis-field-value
5082 ;; Otherwise, move to START with attention to fields.
5083 ;; (It is possible that fields never matter in this case.)
5084 (constrain-to-field (point) orig
5085 (/= arg 1) t nil)))))
5088 ;; Many people have said they rarely use this feature, and often type
5089 ;; it by accident. Maybe it shouldn't even be on a key.
5090 (put 'set-goal-column 'disabled t)
5092 (defun set-goal-column (arg)
5094 Those commands will move to this position in the line moved to
5095 rather than trying to keep the same horizontal position.
5096 With a non-nil argument ARG, clears out the goal column
5098 The goal column is stored in the variable `goal-column'."
5099 (interactive "P")
5100 (if arg
5101 (progn
5102 (setq goal-column nil)
5103 (message "No goal column"))
5104 (setq goal-column (current-column))
5105 ;; The older method below can be erroneous if `set-goal-column' is bound
5106 ;; to a sequence containing %
5107 ;;(message (substitute-command-keys
5109 ;;goal-column)
5110 (message "%s"
5111 (concat
5112 (format "Goal column %d " goal-column)
5113 (substitute-command-keys
5116 )
5117 nil)
5118 \f
5119 ;;; Editing based on visual lines, as opposed to logical lines.
5121 (defun end-of-visual-line (&optional n)
5122 "Move point to end of current visual line.
5123 With argument N not nil or 1, move forward N - 1 visual lines first.
5124 If point reaches the beginning or end of buffer, it stops there.
5125 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5126 (interactive "^p")
5127 (or n (setq n 1))
5128 (if (/= n 1)
5129 (let ((line-move-visual t))
5130 (line-move (1- n) t)))
5131 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5132 ;; constrain to field boundaries, so we don't either.
5133 (vertical-motion (cons (window-width) 0)))
5135 (defun beginning-of-visual-line (&optional n)
5136 "Move point to beginning of current visual line.
5137 With argument N not nil or 1, move forward N - 1 visual lines first.
5138 If point reaches the beginning or end of buffer, it stops there.
5139 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5140 (interactive "^p")
5141 (or n (setq n 1))
5142 (let ((opoint (point)))
5143 (if (/= n 1)
5144 (let ((line-move-visual t))
5145 (line-move (1- n) t)))
5146 (vertical-motion 0)
5147 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5148 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5150 (defun kill-visual-line (&optional arg)
5151 "Kill the rest of the visual line.
5152 With prefix argument ARG, kill that many visual lines from point.
5153 If ARG is negative, kill visual lines backward.
5154 If ARG is zero, kill the text before point on the current visual
5155 line.
5157 If you want to append the killed line to the last killed text,
5160 If the buffer is read-only, Emacs will beep and refrain from deleting
5161 the line, but put the line in the kill ring anyway. This means that
5162 you can use this command to copy text from a read-only buffer.
5163 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5164 even beep.)"
5165 (interactive "P")
5166 ;; Like in `kill-line', it's better to move point to the other end
5167 ;; of the kill before killing.
5168 (let ((opoint (point))
5169 (kill-whole-line (and kill-whole-line (bolp))))
5170 (if arg
5171 (vertical-motion (prefix-numeric-value arg))
5172 (end-of-visual-line 1)
5173 (if (= (point) opoint)
5174 (vertical-motion 1)
5175 ;; Skip any trailing whitespace at the end of the visual line.
5176 ;; We used to do this only if `show-trailing-whitespace' is
5177 ;; nil, but that's wrong; the correct thing would be to check
5178 ;; whether the trailing whitespace is highlighted. But, it's
5179 ;; OK to just do this unconditionally.
5182 (1+ (point))
5183 (point)))))
5185 (defun next-logical-line (&optional arg try-vscroll)
5186 "Move cursor vertically down ARG lines.
5187 This is identical to `next-line', except that it always moves
5188 by logical lines instead of visual lines, ignoring the value of
5189 the variable `line-move-visual'."
5191 (let ((line-move-visual nil))
5192 (with-no-warnings
5193 (next-line arg try-vscroll))))
5195 (defun previous-logical-line (&optional arg try-vscroll)
5196 "Move cursor vertically up ARG lines.
5197 This is identical to `previous-line', except that it always moves
5198 by logical lines instead of visual lines, ignoring the value of
5199 the variable `line-move-visual'."
5201 (let ((line-move-visual nil))
5202 (with-no-warnings
5203 (previous-line arg try-vscroll))))
5205 (defgroup visual-line nil
5206 "Editing based on visual lines."
5207 :group 'convenience
5208 :version "23.1")
5210 (defvar visual-line-mode-map
5211 (let ((map (make-sparse-keymap)))
5212 (define-key map [remap kill-line] 'kill-visual-line)
5213 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5214 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5215 ;; These keybindings interfere with xterm function keys. Are
5216 ;; there any other suitable bindings?
5217 ;; (define-key map "\M-[" 'previous-logical-line)
5218 ;; (define-key map "\M-]" 'next-logical-line)
5219 map))
5221 (defcustom visual-line-fringe-indicators '(nil nil)
5222 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5223 The value should be a list of the form (LEFT RIGHT), where LEFT
5224 and RIGHT are symbols representing the bitmaps to display, to
5225 indicate wrapped lines, in the left and right fringes respectively.
5226 See also `fringe-indicator-alist'.
5227 The default is not to display fringe indicators for wrapped lines.
5228 This variable does not affect fringe indicators displayed for
5229 other purposes."
5230 :type '(list (choice (const :tag "Hide left indicator" nil)
5231 (const :tag "Left curly arrow" left-curly-arrow)
5232 (symbol :tag "Other bitmap"))
5233 (choice (const :tag "Hide right indicator" nil)
5234 (const :tag "Right curly arrow" right-curly-arrow)
5235 (symbol :tag "Other bitmap")))
5236 :set (lambda (symbol value)
5237 (dolist (buf (buffer-list))
5238 (with-current-buffer buf
5239 (when (and (boundp 'visual-line-mode)
5240 (symbol-value 'visual-line-mode))
5241 (setq fringe-indicator-alist
5242 (cons (cons 'continuation value)
5243 (assq-delete-all
5244 'continuation
5245 (copy-tree fringe-indicator-alist)))))))
5246 (set-default symbol value)))
5248 (defvar visual-line--saved-state nil)
5250 (define-minor-mode visual-line-mode
5251 "Toggle visual line based editing (Visual Line mode).
5252 With a prefix argument ARG, enable Visual Line mode if ARG is
5253 positive, and disable it otherwise. If called from Lisp, enable
5254 the mode if ARG is omitted or nil.
5256 When Visual Line mode is enabled, `word-wrap' is turned on in
5257 this buffer, and simple editing commands are redefined to act on
5258 visual lines, not logical lines. See Info node `Visual Line
5259 Mode' for details."
5260 :keymap visual-line-mode-map
5261 :group 'visual-line
5262 :lighter " Wrap"
5263 (if visual-line-mode
5264 (progn
5265 (set (make-local-variable 'visual-line--saved-state) nil)
5266 ;; Save the local values of some variables, to be restored if
5267 ;; visual-line-mode is turned off.
5268 (dolist (var '(line-move-visual truncate-lines
5269 truncate-partial-width-windows
5270 word-wrap fringe-indicator-alist))
5271 (if (local-variable-p var)
5272 (push (cons var (symbol-value var))
5273 visual-line--saved-state)))
5274 (set (make-local-variable 'line-move-visual) t)
5275 (set (make-local-variable 'truncate-partial-width-windows) nil)
5276 (setq truncate-lines nil
5277 word-wrap t
5278 fringe-indicator-alist
5279 (cons (cons 'continuation visual-line-fringe-indicators)
5280 fringe-indicator-alist)))
5281 (kill-local-variable 'line-move-visual)
5282 (kill-local-variable 'word-wrap)
5283 (kill-local-variable 'truncate-lines)
5284 (kill-local-variable 'truncate-partial-width-windows)
5285 (kill-local-variable 'fringe-indicator-alist)
5286 (dolist (saved visual-line--saved-state)
5287 (set (make-local-variable (car saved)) (cdr saved)))
5288 (kill-local-variable 'visual-line--saved-state)))
5290 (defun turn-on-visual-line-mode ()
5291 (visual-line-mode 1))
5293 (define-globalized-minor-mode global-visual-line-mode
5294 visual-line-mode turn-on-visual-line-mode
5295 :lighter " vl")
5297 \f
5298 (defun transpose-chars (arg)
5299 "Interchange characters around point, moving forward one character.
5300 With prefix arg ARG, effect is to take character before point
5301 and drag it forward past ARG other characters (backward if ARG negative).
5302 If no argument and at end of line, the previous two chars are exchanged."
5303 (interactive "*P")
5304 (and (null arg) (eolp) (forward-char -1))
5305 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5307 (defun transpose-words (arg)
5308 "Interchange words around point, leaving point at end of them.
5309 With prefix arg ARG, effect is to take word before or around point
5310 and drag it forward past ARG other words (backward if ARG negative).
5311 If ARG is zero, the words around or after point and around or after mark
5312 are interchanged."
5313 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5314 (interactive "*p")
5315 (transpose-subr 'forward-word arg))
5317 (defun transpose-sexps (arg)
5319 Does not work on a sexp that point is in the middle of
5320 if it is a list or string."
5321 (interactive "*p")
5322 (transpose-subr
5323 (lambda (arg)
5324 ;; Here we should try to simulate the behavior of
5325 ;; (cons (progn (forward-sexp x) (point))
5326 ;; (progn (forward-sexp (- x)) (point)))
5327 ;; Except that we don't want to rely on the second forward-sexp
5328 ;; putting us back to where we want to be, since forward-sexp-function
5329 ;; might do funny things like infix-precedence.
5330 (if (if (> arg 0)
5332 (and (not (bobp))
5334 ;; Jumping over a symbol. We might be inside it, mind you.
5335 (progn (funcall (if (> arg 0)
5336 'skip-syntax-backward 'skip-syntax-forward)
5337 "w_")
5338 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5339 ;; Otherwise, we're between sexps. Take a step back before jumping
5340 ;; to make sure we'll obey the same precedence no matter which direction
5341 ;; we're going.
5342 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5343 (cons (save-excursion (forward-sexp arg) (point))
5344 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5345 (not (zerop (funcall (if (> arg 0)
5346 'skip-syntax-forward
5347 'skip-syntax-backward)
5348 ".")))))
5349 (point)))))
5350 arg 'special))
5352 (defun transpose-lines (arg)
5353 "Exchange current line and previous line, leaving point after both.
5354 With argument ARG, takes previous line and moves it past ARG lines.
5355 With argument 0, interchanges line point is in with line mark is in."
5356 (interactive "*p")
5357 (transpose-subr (function
5358 (lambda (arg)
5359 (if (> arg 0)
5360 (progn
5361 ;; Move forward over ARG lines,
5362 ;; but create newlines if necessary.
5363 (setq arg (forward-line arg))
5365 (setq arg (1+ arg)))
5366 (if (> arg 0)
5367 (newline arg)))
5368 (forward-line arg))))
5369 arg))
5371 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5372 ;; which seems inconsistent with the ARG /= 0 case.
5373 ;; FIXME document SPECIAL.
5374 (defun transpose-subr (mover arg &optional special)
5375 "Subroutine to do the work of transposing objects.
5376 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5377 moves forward by units of the given object (e.g. forward-sentence,
5378 forward-paragraph). If ARG is zero, exchanges the current object
5379 with the one containing mark. If ARG is an integer, moves the
5380 current object past ARG following (if ARG is positive) or
5381 preceding (if ARG is negative) objects, leaving point after the
5382 current object."
5383 (let ((aux (if special mover
5384 (lambda (x)
5385 (cons (progn (funcall mover x) (point))
5386 (progn (funcall mover (- x)) (point))))))
5387 pos1 pos2)
5388 (cond
5389 ((= arg 0)
5390 (save-excursion
5391 (setq pos1 (funcall aux 1))
5392 (goto-char (or (mark) (error "No mark set in this buffer")))
5393 (setq pos2 (funcall aux 1))
5394 (transpose-subr-1 pos1 pos2))
5395 (exchange-point-and-mark))
5396 ((> arg 0)
5397 (setq pos1 (funcall aux -1))
5398 (setq pos2 (funcall aux arg))
5399 (transpose-subr-1 pos1 pos2)
5400 (goto-char (car pos2)))
5401 (t
5402 (setq pos1 (funcall aux -1))
5403 (goto-char (car pos1))
5404 (setq pos2 (funcall aux arg))
5405 (transpose-subr-1 pos1 pos2)))))
5407 (defun transpose-subr-1 (pos1 pos2)
5408 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5409 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5410 (when (> (car pos1) (car pos2))
5411 (let ((swap pos1))
5412 (setq pos1 pos2 pos2 swap)))
5413 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5414 (atomic-change-group
5415 ;; This sequence of insertions attempts to preserve marker
5416 ;; positions at the start and end of the transposed objects.
5417 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
5418 (len1 (- (cdr pos1) (car pos1)))
5419 (len2 (length word))
5420 (boundary (make-marker)))
5421 (set-marker boundary (car pos2))
5422 (goto-char (cdr pos1))
5423 (insert-before-markers word)
5424 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
5425 (goto-char boundary)
5426 (insert word)
5427 (goto-char (+ boundary len1))
5428 (delete-region (point) (+ (point) len2))
5429 (set-marker boundary nil))))
5430 \f
5431 (defun backward-word (&optional arg)
5432 "Move backward until encountering the beginning of a word.
5433 With argument ARG, do this that many times."
5434 (interactive "^p")
5435 (forward-word (- (or arg 1))))
5437 (defun mark-word (&optional arg allow-extend)
5438 "Set mark ARG words away from point.
5440 move to with the same argument.
5441 Interactively, if this command is repeated
5442 or (in Transient Mark mode) if the mark is active,
5443 it marks the next ARG words after the ones already marked."
5445 (cond ((and allow-extend
5446 (or (and (eq last-command this-command) (mark t))
5447 (region-active-p)))
5448 (setq arg (if arg (prefix-numeric-value arg)
5449 (if (< (mark) (point)) -1 1)))
5450 (set-mark
5451 (save-excursion
5452 (goto-char (mark))
5453 (forward-word arg)
5454 (point))))
5455 (t
5456 (push-mark
5457 (save-excursion
5458 (forward-word (prefix-numeric-value arg))
5459 (point))
5460 nil t))))
5462 (defun kill-word (arg)
5463 "Kill characters forward until encountering the end of a word.
5464 With argument ARG, do this that many times."
5465 (interactive "p")
5466 (kill-region (point) (progn (forward-word arg) (point))))
5468 (defun backward-kill-word (arg)
5469 "Kill characters backward until encountering the beginning of a word.
5470 With argument ARG, do this that many times."
5471 (interactive "p")
5472 (kill-word (- arg)))
5474 (defun current-word (&optional strict really-word)
5475 "Return the symbol or word that point is on (or a nearby one) as a string.
5476 The return value includes no text properties.
5477 If optional arg STRICT is non-nil, return nil unless point is within
5478 or adjacent to a symbol or word. In all cases the value can be nil
5479 if there is no word nearby.
5480 The function, belying its name, normally finds a symbol.
5481 If optional arg REALLY-WORD is non-nil, it finds just a word."
5482 (save-excursion
5483 (let* ((oldpoint (point)) (start (point)) (end (point))
5484 (syntaxes (if really-word "w" "w_"))
5485 (not-syntaxes (concat "^" syntaxes)))
5486 (skip-syntax-backward syntaxes) (setq start (point))
5487 (goto-char oldpoint)
5488 (skip-syntax-forward syntaxes) (setq end (point))
5489 (when (and (eq start oldpoint) (eq end oldpoint)
5490 ;; Point is neither within nor adjacent to a word.
5491 (not strict))
5492 ;; Look for preceding word in same line.
5493 (skip-syntax-backward not-syntaxes (line-beginning-position))
5494 (if (bolp)
5495 ;; No preceding word in same line.
5496 ;; Look for following word in same line.
5497 (progn
5498 (skip-syntax-forward not-syntaxes (line-end-position))
5499 (setq start (point))
5500 (skip-syntax-forward syntaxes)
5501 (setq end (point)))
5502 (setq end (point))
5503 (skip-syntax-backward syntaxes)
5504 (setq start (point))))
5505 ;; If we found something nonempty, return it as a string.
5506 (unless (= start end)
5507 (buffer-substring-no-properties start end)))))
5508 \f
5509 (defcustom fill-prefix nil
5510 "String for filling to insert at front of new line, or nil for none."
5511 :type '(choice (const :tag "None" nil)
5512 string)
5513 :group 'fill)
5514 (make-variable-buffer-local 'fill-prefix)
5515 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5517 (defcustom auto-fill-inhibit-regexp nil
5518 "Regexp to match lines which should not be auto-filled."
5519 :type '(choice (const :tag "None" nil)
5520 regexp)
5521 :group 'fill)
5523 (defun do-auto-fill ()
5524 "The default value for `normal-auto-fill-function'.
5525 This is the default auto-fill function, some major modes use a different one.
5526 Returns t if it really did any work."
5527 (let (fc justify give-up
5528 (fill-prefix fill-prefix))
5529 (if (or (not (setq justify (current-justification)))
5530 (null (setq fc (current-fill-column)))
5531 (and (eq justify 'left)
5532 (<= (current-column) fc))
5533 (and auto-fill-inhibit-regexp
5534 (save-excursion (beginning-of-line)
5535 (looking-at auto-fill-inhibit-regexp))))
5536 nil ;; Auto-filling not required
5537 (if (memq justify '(full center right))
5538 (save-excursion (unjustify-current-line)))
5540 ;; Choose a fill-prefix automatically.
5541 (when (and adaptive-fill-mode
5542 (or (null fill-prefix) (string= fill-prefix "")))
5543 (let ((prefix
5544 (fill-context-prefix
5545 (save-excursion (fill-forward-paragraph -1) (point))
5546 (save-excursion (fill-forward-paragraph 1) (point)))))
5547 (and prefix (not (equal prefix ""))
5548 ;; Use auto-indentation rather than a guessed empty prefix.
5549 (not (and fill-indent-according-to-mode
5551 (setq fill-prefix prefix))))
5553 (while (and (not give-up) (> (current-column) fc))
5554 ;; Determine where to split the line.
5555 (let* (after-prefix
5556 (fill-point
5557 (save-excursion
5558 (beginning-of-line)
5559 (setq after-prefix (point))
5560 (and fill-prefix
5561 (looking-at (regexp-quote fill-prefix))
5562 (setq after-prefix (match-end 0)))
5563 (move-to-column (1+ fc))
5564 (fill-move-to-break-point after-prefix)
5565 (point))))
5567 ;; See whether the place we found is any good.
5568 (if (save-excursion
5569 (goto-char fill-point)
5570 (or (bolp)
5571 ;; There is no use breaking at end of line.
5572 (save-excursion (skip-chars-forward " ") (eolp))
5573 ;; It is futile to split at the end of the prefix
5574 ;; since we would just insert the prefix again.
5575 (and after-prefix (<= (point) after-prefix))
5576 ;; Don't split right after a comment starter
5577 ;; since we would just make another comment starter.
5578 (and comment-start-skip
5579 (let ((limit (point)))
5580 (beginning-of-line)
5581 (and (re-search-forward comment-start-skip
5582 limit t)
5583 (eq (point) limit))))))
5584 ;; No good place to break => stop trying.
5585 (setq give-up t)
5586 ;; Ok, we have a useful place to break the line. Do it.
5587 (let ((prev-column (current-column)))
5588 ;; If point is at the fill-point, do not `save-excursion'.
5589 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5590 ;; point will end up before it rather than after it.
5591 (if (save-excursion
5593 (= (point) fill-point))
5594 (default-indent-new-line t)
5595 (save-excursion
5596 (goto-char fill-point)
5597 (default-indent-new-line t)))
5598 ;; Now do justification, if required
5599 (if (not (eq justify 'left))
5600 (save-excursion
5601 (end-of-line 0)
5602 (justify-current-line justify nil t)))
5603 ;; If making the new line didn't reduce the hpos of
5604 ;; the end of the line, then give up now;
5605 ;; trying again will not help.
5606 (if (>= (current-column) prev-column)
5607 (setq give-up t))))))
5608 ;; Justify last line.
5609 (justify-current-line justify t t)
5610 t)))
5612 (defvar comment-line-break-function 'comment-indent-new-line
5613 "Mode-specific function which line breaks and continues a comment.
5614 This function is called during auto-filling when a comment syntax
5615 is defined.
5616 The function should take a single optional argument, which is a flag
5617 indicating whether it should use soft newlines.")
5619 (defun default-indent-new-line (&optional soft)
5620 "Break line at point and indent.
5621 If a comment syntax is defined, call `comment-indent-new-line'.
5623 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5624 unless optional argument SOFT is non-nil."
5625 (interactive)
5626 (if comment-start
5627 (funcall comment-line-break-function soft)
5628 ;; Insert the newline before removing empty space so that markers
5629 ;; get preserved better.
5631 (save-excursion (forward-char -1) (delete-horizontal-space))
5632 (delete-horizontal-space)
5634 (if (and fill-prefix (not adaptive-fill-mode))
5635 ;; Blindly trust a non-adaptive fill-prefix.
5636 (progn
5637 (indent-to-left-margin)
5638 (insert-before-markers-and-inherit fill-prefix))
5640 (cond
5641 ;; If there's an adaptive prefix, use it unless we're inside
5642 ;; a comment and the prefix is not a comment starter.
5643 (fill-prefix
5644 (indent-to-left-margin)
5645 (insert-and-inherit fill-prefix))
5646 ;; If we're not inside a comment, just try to indent.
5647 (t (indent-according-to-mode))))))
5649 (defvar normal-auto-fill-function 'do-auto-fill
5650 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5651 Some major modes set this.")
5653 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5654 ;; `functions' and `hooks' are usually unsafe to set, but setting
5655 ;; auto-fill-function to nil in a file-local setting is safe and
5656 ;; can be useful to prevent auto-filling.
5657 (put 'auto-fill-function 'safe-local-variable 'null)
5659 (define-minor-mode auto-fill-mode
5660 "Toggle automatic line breaking (Auto Fill mode).
5661 With a prefix argument ARG, enable Auto Fill mode if ARG is
5662 positive, and disable it otherwise. If called from Lisp, enable
5663 the mode if ARG is omitted or nil.
5665 When Auto Fill mode is enabled, inserting a space at a column
5666 beyond `current-fill-column' automatically breaks the line at a
5667 previous space.
5669 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5670 non-`nil'.
5672 The value of `normal-auto-fill-function' specifies the function to use
5673 for `auto-fill-function' when turning Auto Fill mode on."
5674 :variable (auto-fill-function
5675 . (lambda (v) (setq auto-fill-function
5676 (if v normal-auto-fill-function)))))
5678 ;; This holds a document string used to document auto-fill-mode.
5679 (defun auto-fill-function ()
5680 "Automatically break line at a previous space, in insertion of text."
5681 nil)
5683 (defun turn-on-auto-fill ()
5684 "Unconditionally turn on Auto Fill mode."
5685 (auto-fill-mode 1))
5687 (defun turn-off-auto-fill ()
5688 "Unconditionally turn off Auto Fill mode."
5689 (auto-fill-mode -1))
5691 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5693 (defun set-fill-column (arg)
5694 "Set `fill-column' to specified argument.
5697 (interactive
5698 (list (or current-prefix-arg
5699 ;; We used to use current-column silently, but C-x f is too easily
5700 ;; typed as a typo for C-x C-f, so we turned it into an error and
5701 ;; now an interactive prompt.
5702 (read-number "Set fill-column to: " (current-column)))))
5703 (if (consp arg)
5704 (setq arg (current-column)))
5705 (if (not (integerp arg))
5706 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5707 (error "set-fill-column requires an explicit argument")
5708 (message "Fill column set to %d (was %d)" arg fill-column)
5709 (setq fill-column arg)))
5710 \f
5711 (defun set-selective-display (arg)
5712 "Set `selective-display' to ARG; clear it if no arg.
5713 When the value of `selective-display' is a number > 0,
5714 lines whose indentation is >= that value are not displayed.
5715 The variable `selective-display' has a separate value for each buffer."
5716 (interactive "P")
5717 (if (eq selective-display t)
5718 (error "selective-display already in use for marked lines"))
5719 (let ((current-vpos
5720 (save-restriction
5721 (narrow-to-region (point-min) (point))
5722 (goto-char (window-start))
5723 (vertical-motion (window-height)))))
5724 (setq selective-display
5725 (and arg (prefix-numeric-value arg)))
5726 (recenter current-vpos))
5727 (set-window-start (selected-window) (window-start (selected-window)))
5728 (princ "selective-display set to " t)
5729 (prin1 selective-display t)
5730 (princ "." t))
5732 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5734 (defun toggle-truncate-lines (&optional arg)
5735 "Toggle truncating of long lines for the current buffer.
5736 When truncating is off, long lines are folded.
5737 With prefix argument ARG, truncate long lines if ARG is positive,
5738 otherwise fold them. Note that in side-by-side windows, this
5739 command has no effect if `truncate-partial-width-windows' is
5740 non-nil."
5741 (interactive "P")
5742 (setq truncate-lines
5743 (if (null arg)
5744 (not truncate-lines)
5745 (> (prefix-numeric-value arg) 0)))
5746 (force-mode-line-update)
5747 (unless truncate-lines
5748 (let ((buffer (current-buffer)))
5749 (walk-windows (lambda (window)
5750 (if (eq buffer (window-buffer window))
5751 (set-window-hscroll window 0)))
5752 nil t)))
5753 (message "Truncate long lines %s"
5754 (if truncate-lines "enabled" "disabled")))
5756 (defun toggle-word-wrap (&optional arg)
5757 "Toggle whether to use word-wrapping for continuation lines.
5758 With prefix argument ARG, wrap continuation lines at word boundaries
5759 if ARG is positive, otherwise wrap them at the right screen edge.
5760 This command toggles the value of `word-wrap'. It has no effect
5761 if long lines are truncated."
5762 (interactive "P")
5763 (setq word-wrap
5764 (if (null arg)
5765 (not word-wrap)
5766 (> (prefix-numeric-value arg) 0)))
5767 (force-mode-line-update)
5768 (message "Word wrapping %s"
5769 (if word-wrap "enabled" "disabled")))
5771 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5772 "The string displayed in the mode line when in overwrite mode.")
5773 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5774 "The string displayed in the mode line when in binary overwrite mode.")
5776 (define-minor-mode overwrite-mode
5777 "Toggle Overwrite mode.
5778 With a prefix argument ARG, enable Overwrite mode if ARG is
5779 positive, and disable it otherwise. If called from Lisp, enable
5780 the mode if ARG is omitted or nil.
5782 When Overwrite mode is enabled, printing characters typed in
5783 replace existing text on a one-for-one basis, rather than pushing
5784 it to the right. At the end of a line, such characters extend
5785 the line. Before a tab, such characters insert until the tab is
5787 overwrite mode; this is supposed to make it easier to insert
5788 characters when necessary."
5789 :variable (overwrite-mode
5790 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5792 (define-minor-mode binary-overwrite-mode
5793 "Toggle Binary Overwrite mode.
5794 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5795 is positive, and disable it otherwise. If called from Lisp,
5796 enable the mode if ARG is omitted or nil.
5798 When Binary Overwrite mode is enabled, printing characters typed
5799 in replace existing text. Newlines are not treated specially, so
5800 typing at the end of a line joins the line to the next, with the
5801 typed character between them. Typing before a tab character
5802 simply replaces the tab with the character typed.
5804 ordinary typing characters do.
5806 Note that Binary Overwrite mode is not its own minor mode; it is
5807 a specialization of overwrite mode, entered by setting the
5808 `overwrite-mode' variable to `overwrite-mode-binary'."
5809 :variable (overwrite-mode
5810 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5812 (define-minor-mode line-number-mode
5813 "Toggle line number display in the mode line (Line Number mode).
5814 With a prefix argument ARG, enable Line Number mode if ARG is
5815 positive, and disable it otherwise. If called from Lisp, enable
5816 the mode if ARG is omitted or nil.
5818 Line numbers do not appear for very large buffers and buffers
5819 with very long lines; see variables `line-number-display-limit'
5820 and `line-number-display-limit-width'."
5821 :init-value t :global t :group 'mode-line)
5823 (define-minor-mode column-number-mode
5824 "Toggle column number display in the mode line (Column Number mode).
5825 With a prefix argument ARG, enable Column Number mode if ARG is
5826 positive, and disable it otherwise.
5828 If called from Lisp, enable the mode if ARG is omitted or nil."
5829 :global t :group 'mode-line)
5831 (define-minor-mode size-indication-mode
5832 "Toggle buffer size display in the mode line (Size Indication mode).
5833 With a prefix argument ARG, enable Size Indication mode if ARG is
5834 positive, and disable it otherwise.
5836 If called from Lisp, enable the mode if ARG is omitted or nil."
5837 :global t :group 'mode-line)
5839 (define-minor-mode auto-save-mode
5840 "Toggle auto-saving in the current buffer (Auto Save mode).
5841 With a prefix argument ARG, enable Auto Save mode if ARG is
5842 positive, and disable it otherwise.
5844 If called from Lisp, enable the mode if ARG is omitted or nil."
5845 :variable ((and buffer-auto-save-file-name
5846 ;; If auto-save is off because buffer has shrunk,
5847 ;; then toggling should turn it on.
5848 (>= buffer-saved-size 0))
5849 . (lambda (val)
5850 (setq buffer-auto-save-file-name
5851 (cond
5852 ((null val) nil)
5853 ((and buffer-file-name auto-save-visited-file-name
5854 (not buffer-read-only))
5855 buffer-file-name)
5856 (t (make-auto-save-file-name))))))
5857 ;; If -1 was stored here, to temporarily turn off saving,
5858 ;; turn it back on.
5859 (and (< buffer-saved-size 0)
5860 (setq buffer-saved-size 0)))
5861 \f
5862 (defgroup paren-blinking nil
5863 "Blinking matching of parens and expressions."
5864 :prefix "blink-matching-"
5865 :group 'paren-matching)
5867 (defcustom blink-matching-paren t
5868 "Non-nil means show matching open-paren when close-paren is inserted."
5869 :type 'boolean
5870 :group 'paren-blinking)
5872 (defcustom blink-matching-paren-on-screen t
5873 "Non-nil means show matching open-paren when it is on screen.
5874 If nil, don't show it (but the open-paren can still be shown
5875 when it is off screen).
5877 This variable has no effect if `blink-matching-paren' is nil.
5878 \(In that case, the open-paren is never shown.)
5879 It is also ignored if `show-paren-mode' is enabled."
5880 :type 'boolean
5881 :group 'paren-blinking)
5883 (defcustom blink-matching-paren-distance (* 100 1024)
5884 "If non-nil, maximum distance to search backwards for matching open-paren.
5885 If nil, search stops at the beginning of the accessible portion of the buffer."
5886 :version "23.2" ; 25->100k
5887 :type '(choice (const nil) integer)
5888 :group 'paren-blinking)
5890 (defcustom blink-matching-delay 1
5891 "Time in seconds to delay after showing a matching paren."
5892 :type 'number
5893 :group 'paren-blinking)
5895 (defcustom blink-matching-paren-dont-ignore-comments nil
5896 "If nil, `blink-matching-paren' ignores comments.
5897 More precisely, when looking for the matching parenthesis,
5898 it skips the contents of comments that end before point."
5899 :type 'boolean
5900 :group 'paren-blinking)
5902 (defun blink-matching-check-mismatch (start end)
5903 "Return whether or not START...END are matching parens.
5904 END is the current point and START is the blink position.
5905 START might be nil if no matching starter was found.
5906 Returns non-nil if we find there is a mismatch."
5907 (let* ((end-syntax (syntax-after (1- end)))
5908 (matching-paren (and (consp end-syntax)
5909 (eq (syntax-class end-syntax) 5)
5910 (cdr end-syntax))))
5911 ;; For self-matched chars like " and $, we can't know when they're
5912 ;; mismatched or unmatched, so we can only do it for parens.
5913 (when matching-paren
5914 (not (and start
5915 (or
5916 (eq (char-after start) matching-paren)
5917 ;; The cdr might hold a new paren-class info rather than
5918 ;; a matching-char info, in which case the two CDRs
5919 ;; should match.
5920 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5922 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5923 "Function to check parentheses mismatches.
5924 The function takes two arguments (START and END) where START is the
5925 position just before the opening token and END is the position right after.
5926 START can be nil, if it was not found.
5927 The function should return non-nil if the two tokens do not match.")
5929 (defun blink-matching-open ()
5930 "Move cursor momentarily to the beginning of the sexp before point."
5931 (interactive)
5932 (when (and (not (bobp))
5933 blink-matching-paren)
5934 (let* ((oldpos (point))
5935 (message-log-max nil) ; Don't log messages about paren matching.
5936 (blinkpos
5937 (save-excursion
5938 (save-restriction
5939 (if blink-matching-paren-distance
5940 (narrow-to-region
5941 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5942 (- (point) blink-matching-paren-distance))
5943 oldpos))
5944 (let ((parse-sexp-ignore-comments
5945 (and parse-sexp-ignore-comments
5946 (not blink-matching-paren-dont-ignore-comments))))
5947 (condition-case ()
5948 (progn
5949 (forward-sexp -1)
5950 ;; backward-sexp skips backward over prefix chars,
5951 ;; so move back to the matching paren.
5952 (while (and (< (point) (1- oldpos))
5953 (let ((code (syntax-after (point))))
5954 (or (eq (syntax-class code) 6)
5955 (eq (logand 1048576 (car code))
5956 1048576))))
5957 (forward-char 1))
5958 (point))
5959 (error nil))))))
5960 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5961 (cond
5962 (mismatch
5963 (if blinkpos
5964 (if (minibufferp)
5965 (minibuffer-message "Mismatched parentheses")
5966 (message "Mismatched parentheses"))
5967 (if (minibufferp)
5968 (minibuffer-message "No matching parenthesis found")
5969 (message "No matching parenthesis found"))))
5970 ((not blinkpos) nil)
5971 ((pos-visible-in-window-p blinkpos)
5972 ;; Matching open within window, temporarily move to blinkpos but only
5973 ;; if `blink-matching-paren-on-screen' is non-nil.
5974 (and blink-matching-paren-on-screen
5975 (not show-paren-mode)
5976 (save-excursion
5977 (goto-char blinkpos)
5978 (sit-for blink-matching-delay))))
5979 (t
5980 (save-excursion
5981 (goto-char blinkpos)
5982 (let ((open-paren-line-string
5983 ;; Show what precedes the open in its line, if anything.
5984 (cond
5986 (buffer-substring (line-beginning-position)
5987 (1+ blinkpos)))
5988 ;; Show what follows the open in its line, if anything.
5989 ((save-excursion
5990 (forward-char 1)
5992 (not (eolp)))
5993 (buffer-substring blinkpos
5994 (line-end-position)))
5995 ;; Otherwise show the previous nonblank line,
5996 ;; if there is one.
5998 (concat
5999 (buffer-substring (progn
6001 (line-beginning-position))
6002 (progn (end-of-line)
6004 (point)))
6005 ;; Replace the newline and other whitespace with `...'.
6006 "..."
6007 (buffer-substring blinkpos (1+ blinkpos))))
6008 ;; There is nothing to show except the char itself.
6009 (t (buffer-substring blinkpos (1+ blinkpos))))))
6010 (message "Matches %s"
6011 (substring-no-properties open-paren-line-string)))))))))
6013 (defvar blink-paren-function 'blink-matching-open
6014 "Function called, if non-nil, whenever a close parenthesis is inserted.
6015 More precisely, a char with closeparen syntax is self-inserted.")
6017 (defun blink-paren-post-self-insert-function ()
6018 (when (and (eq (char-before) last-command-event) ; Sanity check.
6019 (memq (char-syntax last-command-event) '(?\) ?\$))
6020 blink-paren-function
6021 (not executing-kbd-macro)
6022 (not noninteractive)
6023 ;; Verify an even number of quoting characters precede the close.
6024 (= 1 (logand 1 (- (point)
6025 (save-excursion
6026 (forward-char -1)
6028 (point))))))
6029 (funcall blink-paren-function)))
6031 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
6032 ;; Most likely, this hook is nil, so this arg doesn't matter,
6033 ;; but I use it as a reminder that this function usually
6034 ;; likes to be run after others since it does `sit-for'.
6035 'append)
6036 \f
6037 ;; This executes C-g typed while Emacs is waiting for a command.
6038 ;; Quitting out of a program does not go through here;
6039 ;; that happens in the QUIT macro at the C code level.
6040 (defun keyboard-quit ()
6041 "Signal a `quit' condition.
6042 During execution of Lisp code, this character causes a quit directly.
6043 At top-level, as an editor command, this simply beeps."
6044 (interactive)
6045 ;; Avoid adding the region to the window selection.
6046 (setq saved-region-selection nil)
6047 (let (select-active-regions)
6048 (deactivate-mark))
6049 (if (fboundp 'kmacro-keyboard-quit)
6050 (kmacro-keyboard-quit))
6051 (setq defining-kbd-macro nil)
6052 (let ((debug-on-quit nil))
6053 (signal 'quit nil)))
6055 (defvar buffer-quit-function nil
6058 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6060 (defun keyboard-escape-quit ()
6062 This command can exit an interactive command such as `query-replace',
6063 can clear out a prefix argument or a region,
6064 can get out of the minibuffer or other recursive edit,
6065 cancel the use of the current buffer (for special-purpose buffers),
6066 or go back to just one window (by deleting all but the selected window)."
6067 (interactive)
6068 (cond ((eq last-command 'mode-exited) nil)
6069 ((region-active-p)
6070 (deactivate-mark))
6071 ((> (minibuffer-depth) 0)
6072 (abort-recursive-edit))
6073 (current-prefix-arg
6074 nil)
6075 ((> (recursion-depth) 0)
6076 (exit-recursive-edit))
6077 (buffer-quit-function
6078 (funcall buffer-quit-function))
6079 ((not (one-window-p t))
6080 (delete-other-windows))
6082 (bury-buffer))))
6084 (defun play-sound-file (file &optional volume device)
6085 "Play sound stored in FILE.
6086 VOLUME and DEVICE correspond to the keywords of the sound
6087 specification for `play-sound'."
6088 (interactive "fPlay sound file: ")
6089 (let ((sound (list :file file)))
6090 (if volume
6091 (plist-put sound :volume volume))
6092 (if device
6093 (plist-put sound :device device))
6094 (push 'sound sound)
6095 (play-sound sound)))
6097 \f
6098 (defcustom read-mail-command 'rmail
6099 "Your preference for a mail reading package.
6100 This is used by some keybindings which support reading mail.
6101 See also `mail-user-agent' concerning sending mail."
6104 (function-item :tag "Emacs interface to MH"
6106 (function :tag "Other"))
6107 :version "21.1"
6108 :group 'mail)
6110 (defcustom mail-user-agent 'message-user-agent
6111 "Your preference for a mail composition package.
6112 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6113 outgoing email message. This variable lets you specify which
6114 mail-sending package you prefer.
6116 Valid values include:
6118 `message-user-agent' -- use the Message package.
6119 See Info node `(message)'.
6120 `sendmail-user-agent' -- use the Mail package.
6121 See Info node `(emacs)Sending Mail'.
6122 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6123 See Info node `(mh-e)'.
6124 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6125 paraphernalia if Gnus is running, particularly
6126 the Gcc: header for archiving.
6128 Additional valid symbols may be available; check with the author of
6129 your package for details. The function should return non-nil if it
6130 succeeds.
6132 See also `read-mail-command' concerning reading mail."
6133 :type '(radio (function-item :tag "Message package"
6135 message-user-agent)
6136 (function-item :tag "Mail package"
6138 sendmail-user-agent)
6139 (function-item :tag "Emacs interface to MH"
6141 mh-e-user-agent)
6142 (function-item :tag "Message with full Gnus features"
6144 gnus-user-agent)
6145 (function :tag "Other"))
6146 :version "23.2" ; sendmail->message
6147 :group 'mail)
6149 (defcustom compose-mail-user-agent-warnings t
6150 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6151 If the value of `mail-user-agent' is the default, and the user
6152 appears to have customizations applying to the old default,
6153 `compose-mail' issues a warning."
6154 :type 'boolean
6155 :version "23.2"
6156 :group 'mail)
6158 (defun rfc822-goto-eoh ()
6159 "If the buffer starts with a mail header, move point to the header's end.
6160 Otherwise, moves to `point-min'.
6161 The end of the header is the start of the next line, if there is one,
6162 else the end of the last line. This function obeys RFC822."
6163 (goto-char (point-min))
6164 (when (re-search-forward
6166 (goto-char (match-beginning 0))))
6168 ;; Used by Rmail (e.g., rmail-forward).
6169 (defvar mail-encode-mml nil
6170 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6171 the outgoing message before sending it.")
6173 (defun compose-mail (&optional to subject other-headers continue
6174 switch-function yank-action send-actions
6175 return-action)
6176 "Start composing a mail message to send.
6177 This uses the user's chosen mail composition package
6178 as selected with the variable `mail-user-agent'.
6179 The optional arguments TO and SUBJECT specify recipients
6180 and the initial Subject field, respectively.
6182 OTHER-HEADERS is an alist specifying additional
6183 header fields. Elements look like (HEADER . VALUE) where both
6184 HEADER and VALUE are strings.
6186 CONTINUE, if non-nil, says to continue editing a message already
6187 being composed. Interactively, CONTINUE is the prefix argument.
6189 SWITCH-FUNCTION, if non-nil, is a function to use to
6190 switch to and display the buffer used for mail composition.
6192 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6193 to insert the raw text of the message being replied to.
6194 It has the form (FUNCTION . ARGS). The user agent will apply
6195 FUNCTION to ARGS, to insert the raw text of the original message.
6196 \(The user agent will also run `mail-citation-hook', *after* the
6197 original text has been inserted in this way.)
6199 SEND-ACTIONS is a list of actions to call when the message is sent.
6200 Each action has the form (FUNCTION . ARGS).
6202 RETURN-ACTION, if non-nil, is an action for returning to the
6203 caller. It has the form (FUNCTION . ARGS). The function is
6204 called after the mail has been sent or put aside, and the mail
6205 buffer buried."
6206 (interactive
6207 (list nil nil nil current-prefix-arg))
6209 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6210 ;; from sendmail-user-agent to message-user-agent. Some users may
6211 ;; encounter incompatibilities. This hack tries to detect problems
6212 ;; and warn about them.
6213 (and compose-mail-user-agent-warnings
6214 (eq mail-user-agent 'message-user-agent)
6215 (let (warn-vars)
6216 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6217 mail-yank-hooks mail-archive-file-name
6218 mail-default-reply-to mail-mailing-lists
6219 mail-self-blind))
6220 (and (boundp var)
6221 (symbol-value var)
6222 (push var warn-vars)))
6223 (when warn-vars
6224 (display-warning 'mail
6225 (format "\
6226 The default mail mode is now Message mode.
6227 You have the following Mail mode variable%s customized:
6229 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6230 (if (> (length warn-vars) 1) "s" "")
6231 (mapconcat 'symbol-name
6232 warn-vars " "))))))
6234 (let ((function (get mail-user-agent 'composefunc)))
6235 (funcall function to subject other-headers continue switch-function
6236 yank-action send-actions return-action)))
6238 (defun compose-mail-other-window (&optional to subject other-headers continue
6239 yank-action send-actions
6240 return-action)
6242 (interactive (list nil nil nil current-prefix-arg))
6243 (compose-mail to subject other-headers continue
6244 'switch-to-buffer-other-window yank-action send-actions
6245 return-action))
6247 (defun compose-mail-other-frame (&optional to subject other-headers continue
6248 yank-action send-actions
6249 return-action)
6251 (interactive (list nil nil nil current-prefix-arg))
6252 (compose-mail to subject other-headers continue
6253 'switch-to-buffer-other-frame yank-action send-actions
6254 return-action))
6256 \f
6257 (defvar set-variable-value-history nil
6258 "History of values entered with `set-variable'.
6260 Maximum length of the history list is determined by the value
6261 of `history-length', which see.")
6263 (defun set-variable (variable value &optional make-local)
6264 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6265 VARIABLE should be a user option variable name, a Lisp variable
6266 meant to be customized by users. You should enter VALUE in Lisp syntax,
6267 so if you want VALUE to be a string, you must surround it with doublequotes.
6268 VALUE is used literally, not evaluated.
6270 If VARIABLE has a `variable-interactive' property, that is used as if
6271 it were the arg to `interactive' (which see) to interactively read VALUE.
6273 If VARIABLE has been defined with `defcustom', then the type information
6274 in the definition is used to check that VALUE is valid.
6276 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6277 (interactive
6278 (let* ((default-var (variable-at-point))
6279 (var (if (custom-variable-p default-var)
6280 (read-variable (format "Set variable (default %s): " default-var)
6281 default-var)
6282 (read-variable "Set variable: ")))
6283 (minibuffer-help-form '(describe-variable var))
6284 (prop (get var 'variable-interactive))
6285 (obsolete (car (get var 'byte-obsolete-variable)))
6286 (prompt (format "Set %s %s to value: " var
6287 (cond ((local-variable-p var)
6288 "(buffer-local)")
6289 ((or current-prefix-arg
6290 (local-variable-if-set-p var))
6291 "buffer-locally")
6292 (t "globally"))))
6293 (val (progn
6294 (when obsolete
6295 (message (concat "`%S' is obsolete; "
6296 (if (symbolp obsolete) "use `%S' instead" "%s"))
6297 var obsolete)
6298 (sit-for 3))
6299 (if prop
6300 ;; Use VAR's `variable-interactive' property
6301 ;; as an interactive spec for prompting.
6302 (call-interactively `(lambda (arg)
6303 (interactive ,prop)
6304 arg))
6305 (read
6306 (read-string prompt nil
6307 'set-variable-value-history
6308 (format "%S" (symbol-value var))))))))
6309 (list var val current-prefix-arg)))
6311 (and (custom-variable-p variable)
6312 (not (get variable 'custom-type))
6313 (custom-load-symbol variable))
6314 (let ((type (get variable 'custom-type)))
6315 (when type
6316 ;; Match with custom type.
6317 (require 'cus-edit)
6318 (setq type (widget-convert type))
6319 (unless (widget-apply type :match value)
6320 (error "Value `%S' does not match type %S of %S"
6321 value (car type) variable))))
6323 (if make-local
6324 (make-local-variable variable))
6326 (set variable value)
6328 ;; Force a thorough redisplay for the case that the variable
6329 ;; has an effect on the display, like `tab-width' has.
6330 (force-mode-line-update))
6331 \f
6332 ;; Define the major mode for lists of completions.
6334 (defvar completion-list-mode-map
6335 (let ((map (make-sparse-keymap)))
6336 (define-key map [mouse-2] 'mouse-choose-completion)
6337 (define-key map [follow-link] 'mouse-face)
6338 (define-key map [down-mouse-2] nil)
6339 (define-key map "\C-m" 'choose-completion)
6340 (define-key map "\e\e\e" 'delete-completion-window)
6341 (define-key map [left] 'previous-completion)
6342 (define-key map [right] 'next-completion)
6343 (define-key map "q" 'quit-window)
6344 (define-key map "z" 'kill-this-buffer)
6345 map)
6346 "Local map for completion list buffers.")
6348 ;; Completion mode is suitable only for specially formatted data.
6349 (put 'completion-list-mode 'mode-class 'special)
6351 (defvar completion-reference-buffer nil
6352 "Record the buffer that was current when the completion list was requested.
6353 This is a local variable in the completion list buffer.
6354 Initial value is nil to avoid some compiler warnings.")
6356 (defvar completion-no-auto-exit nil
6357 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6358 This also applies to other functions such as `choose-completion'.")
6360 (defvar completion-base-position nil
6361 "Position of the base of the text corresponding to the shown completions.
6362 This variable is used in the *Completions* buffers.
6363 Its value is a list of the form (START END) where START is the place
6364 where the completion should be inserted and END (if non-nil) is the end
6365 of the text to replace. If END is nil, point is used instead.")
6367 (defvar completion-list-insert-choice-function #'completion--replace
6368 "Function to use to insert the text chosen in *Completions*.
6369 Called with three arguments (BEG END TEXT), it should replace the text
6370 between BEG and END with TEXT. Expected to be set buffer-locally
6371 in the *Completions* buffer.")
6373 (defvar completion-base-size nil
6374 "Number of chars before point not involved in completion.
6375 This is a local variable in the completion list buffer.
6376 It refers to the chars in the minibuffer if completing in the
6377 minibuffer, or in `completion-reference-buffer' otherwise.
6378 Only characters in the field at point are included.
6380 If nil, Emacs determines which part of the tail end of the
6381 buffer's text is involved in completion by comparing the text
6382 directly.")
6383 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6385 (defun delete-completion-window ()
6386 "Delete the completion list window.
6387 Go to the window from which completion was requested."
6388 (interactive)
6389 (let ((buf completion-reference-buffer))
6390 (if (one-window-p t)
6391 (if (window-dedicated-p (selected-window))
6392 (delete-frame (selected-frame)))
6393 (delete-window (selected-window))
6394 (if (get-buffer-window buf)
6395 (select-window (get-buffer-window buf))))))
6397 (defun previous-completion (n)
6398 "Move to the previous item in the completion list."
6399 (interactive "p")
6400 (next-completion (- n)))
6402 (defun next-completion (n)
6403 "Move to the next item in the completion list.
6404 With prefix argument N, move N items (negative N means move backward)."
6405 (interactive "p")
6406 (let ((beg (point-min)) (end (point-max)))
6407 (while (and (> n 0) (not (eobp)))
6408 ;; If in a completion, move to the end of it.
6409 (when (get-text-property (point) 'mouse-face)
6410 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6411 ;; Move to start of next one.
6412 (unless (get-text-property (point) 'mouse-face)
6413 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6414 (setq n (1- n)))
6415 (while (and (< n 0) (not (bobp)))
6416 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6417 ;; If in a completion, move to the start of it.
6418 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6419 (goto-char (previous-single-property-change
6420 (point) 'mouse-face nil beg)))
6421 ;; Move to end of the previous completion.
6422 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6423 (goto-char (previous-single-property-change
6424 (point) 'mouse-face nil beg)))
6425 ;; Move to the start of that one.
6426 (goto-char (previous-single-property-change
6427 (point) 'mouse-face nil beg))
6428 (setq n (1+ n))))))
6430 (defun choose-completion (&optional event)
6431 "Choose the completion at point."
6432 (interactive (list last-nonmenu-event))
6433 ;; In case this is run via the mouse, give temporary modes such as
6434 ;; isearch a chance to turn off.
6435 (run-hooks 'mouse-leave-buffer-hook)
6436 (with-current-buffer (window-buffer (posn-window (event-start event)))
6437 (let ((buffer completion-reference-buffer)
6438 (base-size completion-base-size)
6439 (base-position completion-base-position)
6440 (insert-function completion-list-insert-choice-function)
6441 (choice
6442 (save-excursion
6443 (goto-char (posn-point (event-start event)))
6444 (let (beg end)
6445 (cond
6446 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6447 (setq end (point) beg (1+ (point))))
6448 ((and (not (bobp))
6449 (get-text-property (1- (point)) 'mouse-face))
6450 (setq end (1- (point)) beg (point)))
6451 (t (error "No completion here")))
6452 (setq beg (previous-single-property-change beg 'mouse-face))
6453 (setq end (or (next-single-property-change end 'mouse-face)
6454 (point-max)))
6455 (buffer-substring-no-properties beg end)))))
6457 (unless (buffer-live-p buffer)
6458 (error "Destination buffer is dead"))
6459 (quit-window nil (posn-window (event-start event)))
6461 (with-current-buffer buffer
6462 (choose-completion-string
6463 choice buffer
6464 (or base-position
6465 (when base-size
6466 ;; Someone's using old completion code that doesn't know
6467 ;; about base-position yet.
6468 (list (+ base-size (field-beginning))))
6469 ;; If all else fails, just guess.
6470 (list (choose-completion-guess-base-position choice)))
6471 insert-function)))))
6473 ;; Delete the longest partial match for STRING
6474 ;; that can be found before POINT.
6475 (defun choose-completion-guess-base-position (string)
6476 (save-excursion
6477 (let ((opoint (point))
6478 len)
6479 ;; Try moving back by the length of the string.
6480 (goto-char (max (- (point) (length string))
6481 (minibuffer-prompt-end)))
6482 ;; See how far back we were actually able to move. That is the
6483 ;; upper bound on how much we can match and delete.
6484 (setq len (- opoint (point)))
6485 (if completion-ignore-case
6486 (setq string (downcase string)))
6487 (while (and (> len 0)
6488 (let ((tail (buffer-substring (point) opoint)))
6489 (if completion-ignore-case
6490 (setq tail (downcase tail)))
6491 (not (string= tail (substring string 0 len)))))
6492 (setq len (1- len))
6493 (forward-char 1))
6494 (point))))
6496 (defun choose-completion-delete-max-match (string)
6497 (declare (obsolete choose-completion-guess-base-position "23.2"))
6498 (delete-region (choose-completion-guess-base-position string) (point)))
6500 (defvar choose-completion-string-functions nil
6501 "Functions that may override the normal insertion of a completion choice.
6502 These functions are called in order with four arguments:
6503 CHOICE - the string to insert in the buffer,
6504 BUFFER - the buffer in which the choice should be inserted,
6505 MINI-P - non-nil if BUFFER is a minibuffer, and
6506 BASE-SIZE - the number of characters in BUFFER before
6507 the string being completed.
6509 If a function in the list returns non-nil, that function is supposed
6510 to have inserted the CHOICE in the BUFFER, and possibly exited
6511 the minibuffer; no further functions will be called.
6513 If all functions in the list return nil, that means to use
6514 the default method of inserting the completion in BUFFER.")
6516 (defun choose-completion-string (choice &optional
6517 buffer base-position insert-function)
6518 "Switch to BUFFER and insert the completion choice CHOICE.
6519 BASE-POSITION, says where to insert the completion."
6521 ;; If BUFFER is the minibuffer, exit the minibuffer
6522 ;; unless it is reading a file name and CHOICE is a directory,
6523 ;; or completion-no-auto-exit is non-nil.
6525 ;; Some older code may call us passing `base-size' instead of
6526 ;; `base-position'. It's difficult to make any use of `base-size',
6527 ;; so we just ignore it.
6528 (unless (consp base-position)
6529 (message "Obsolete `base-size' passed to choose-completion-string")
6530 (setq base-position nil))
6532 (let* ((buffer (or buffer completion-reference-buffer))
6533 (mini-p (minibufferp buffer)))
6534 ;; If BUFFER is a minibuffer, barf unless it's the currently
6535 ;; active minibuffer.
6536 (if (and mini-p
6537 (not (and (active-minibuffer-window)
6538 (equal buffer
6539 (window-buffer (active-minibuffer-window))))))
6540 (error "Minibuffer is not active for completion")
6541 ;; Set buffer so buffer-local choose-completion-string-functions works.
6542 (set-buffer buffer)
6543 (unless (run-hook-with-args-until-success
6544 'choose-completion-string-functions
6545 ;; The fourth arg used to be `mini-p' but was useless
6546 ;; (since minibufferp can be used on the `buffer' arg)
6547 ;; and indeed unused. The last used to be `base-size', so we
6548 ;; keep it to try and avoid breaking old code.
6549 choice buffer base-position nil)
6550 ;; This remove-text-properties should be unnecessary since `choice'
6551 ;; comes from buffer-substring-no-properties.
6552 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6553 ;; Insert the completion into the buffer where it was requested.
6554 (funcall (or insert-function completion-list-insert-choice-function)
6555 (or (car base-position) (point))
6556 (or (cadr base-position) (point))
6557 choice)
6558 ;; Update point in the window that BUFFER is showing in.
6559 (let ((window (get-buffer-window buffer t)))
6560 (set-window-point window (point)))
6561 ;; If completing for the minibuffer, exit it with this choice.
6562 (and (not completion-no-auto-exit)
6563 (minibufferp buffer)
6564 minibuffer-completion-table
6565 ;; If this is reading a file name, and the file name chosen
6566 ;; is a directory, don't exit the minibuffer.
6567 (let* ((result (buffer-substring (field-beginning) (point)))
6568 (bounds
6569 (completion-boundaries result minibuffer-completion-table
6570 minibuffer-completion-predicate
6571 "")))
6572 (if (eq (car bounds) (length result))
6573 ;; The completion chosen leads to a new set of completions
6574 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6575 (let ((mini (active-minibuffer-window)))
6576 (select-window mini)
6577 (when minibuffer-auto-raise
6578 (raise-frame (window-frame mini))))
6579 (exit-minibuffer))))))))
6581 (define-derived-mode completion-list-mode nil "Completion List"
6582 "Major mode for buffers showing lists of possible completions.
6584 to select the completion near point.
6586 with the mouse.
6589 (set (make-local-variable 'completion-base-size) nil))
6591 (defun completion-list-mode-finish ()
6592 "Finish setup of the completions buffer.
6593 Called from `temp-buffer-show-hook'."
6594 (when (eq major-mode 'completion-list-mode)
6595 (setq buffer-read-only t)))
6597 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6600 ;; Variables and faces used in `completion-setup-function'.
6602 (defcustom completion-show-help t
6603 "Non-nil means show help message in *Completions* buffer."
6604 :type 'boolean
6605 :version "22.1"
6606 :group 'completion)
6608 ;; This function goes in completion-setup-hook, so that it is called
6609 ;; after the text of the completion list buffer is written.
6610 (defun completion-setup-function ()
6611 (let* ((mainbuf (current-buffer))
6612 (base-dir
6613 ;; When reading a file name in the minibuffer,
6614 ;; try and find the right default-directory to set in the
6615 ;; completion list buffer.
6616 ;; FIXME: Why do we do that, actually? --Stef
6617 (if minibuffer-completing-file-name
6618 (file-name-as-directory
6619 (expand-file-name
6620 (substring (minibuffer-completion-contents)
6621 0 (or completion-base-size 0)))))))
6622 (with-current-buffer standard-output
6623 (let ((base-size completion-base-size) ;Read before killing localvars.
6624 (base-position completion-base-position)
6625 (insert-fun completion-list-insert-choice-function))
6626 (completion-list-mode)
6627 (set (make-local-variable 'completion-base-size) base-size)
6628 (set (make-local-variable 'completion-base-position) base-position)
6629 (set (make-local-variable 'completion-list-insert-choice-function)
6630 insert-fun))
6631 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6632 (if base-dir (setq default-directory base-dir))
6633 ;; Maybe insert help string.
6634 (when completion-show-help
6635 (goto-char (point-min))
6636 (if (display-mouse-p)
6637 (insert (substitute-command-keys
6639 (insert (substitute-command-keys
6643 (add-hook 'completion-setup-hook 'completion-setup-function)
6645 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6646 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6648 (defun switch-to-completions ()
6649 "Select the completion list window."
6650 (interactive)
6651 (let ((window (or (get-buffer-window "*Completions*" 0)
6652 ;; Make sure we have a completions window.
6653 (progn (minibuffer-completion-help)
6654 (get-buffer-window "*Completions*" 0)))))
6655 (when window
6656 (select-window window)
6657 ;; In the new buffer, go to the first completion.
6658 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6659 (when (bobp)
6660 (next-completion 1)))))
6661 \f
6662 ;;; Support keyboard commands to turn on various modifiers.
6664 ;; These functions -- which are not commands -- each add one modifier
6665 ;; to the following event.
6667 (defun event-apply-alt-modifier (_ignore-prompt)
6670 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6671 (defun event-apply-super-modifier (_ignore-prompt)
6674 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6675 (defun event-apply-hyper-modifier (_ignore-prompt)
6678 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6679 (defun event-apply-shift-modifier (_ignore-prompt)
6682 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6683 (defun event-apply-control-modifier (_ignore-prompt)
6686 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6687 (defun event-apply-meta-modifier (_ignore-prompt)
6690 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6692 (defun event-apply-modifier (event symbol lshiftby prefix)
6693 "Apply a modifier flag to event EVENT.
6694 SYMBOL is the name of this modifier, as a symbol.
6695 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6696 PREFIX is the string that represents this modifier in an event type symbol."
6697 (if (numberp event)
6698 (cond ((eq symbol 'control)
6699 (if (and (<= (downcase event) ?z)
6700 (>= (downcase event) ?a))
6701 (- (downcase event) ?a -1)
6702 (if (and (<= (downcase event) ?Z)
6703 (>= (downcase event) ?A))
6704 (- (downcase event) ?A -1)
6705 (logior (lsh 1 lshiftby) event))))
6706 ((eq symbol 'shift)
6707 (if (and (<= (downcase event) ?z)
6708 (>= (downcase event) ?a))
6709 (upcase event)
6710 (logior (lsh 1 lshiftby) event)))
6711 (t
6712 (logior (lsh 1 lshiftby) event)))
6713 (if (memq symbol (event-modifiers event))
6714 event
6715 (let ((event-type (if (symbolp event) event (car event))))
6716 (setq event-type (intern (concat prefix (symbol-name event-type))))
6717 (if (symbolp event)
6718 event-type
6719 (cons event-type (cdr event)))))))
6721 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6722 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6723 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6724 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6725 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6726 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6727 \f
6728 ;;;; Keypad support.
6730 ;; Make the keypad keys act like ordinary typing keys. If people add
6731 ;; bindings for the function key symbols, then those bindings will
6732 ;; override these, so this shouldn't interfere with any existing
6733 ;; bindings.
6735 ;; Also tell read-char how to handle these keys.
6736 (mapc
6737 (lambda (keypad-normal)
6738 (let ((keypad (nth 0 keypad-normal))
6739 (normal (nth 1 keypad-normal)))
6740 (put keypad 'ascii-character normal)
6741 (define-key function-key-map (vector keypad) (vector normal))))
6742 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6743 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6744 (kp-space ?\s)
6747 (kp-multiply ?*)
6748 (kp-add ?+)
6749 (kp-separator ?,)
6750 (kp-subtract ?-)
6751 (kp-decimal ?.)
6752 (kp-divide ?/)
6753 (kp-equal ?=)
6754 ;; Do the same for various keys that are represented as symbols under
6755 ;; GUIs but naturally correspond to characters.
6756 (backspace 127)
6757 (delete 127)
6760 (clear ?\C-l)
6761 (return ?\C-m)
6762 (escape ?\e)
6763 ))
6764 \f
6765 ;;;;
6766 ;;;; forking a twin copy of a buffer.
6767 ;;;;
6769 (defvar clone-buffer-hook nil
6770 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6772 (defvar clone-indirect-buffer-hook nil
6773 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6775 (defun clone-process (process &optional newname)
6776 "Create a twin copy of PROCESS.
6777 If NEWNAME is nil, it defaults to PROCESS' name;
6778 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6779 If PROCESS is associated with a buffer, the new process will be associated
6780 with the current buffer instead.
6781 Returns nil if PROCESS has already terminated."
6782 (setq newname (or newname (process-name process)))
6784 (setq newname (substring newname 0 (match-beginning 0))))
6785 (when (memq (process-status process) '(run stop open))
6786 (let* ((process-connection-type (process-tty-name process))
6787 (new-process
6788 (if (memq (process-status process) '(open))
6789 (let ((args (process-contact process t)))
6790 (setq args (plist-put args :name newname))
6791 (setq args (plist-put args :buffer
6792 (if (process-buffer process)
6793 (current-buffer))))
6794 (apply 'make-network-process args))
6795 (apply 'start-process newname
6796 (if (process-buffer process) (current-buffer))
6797 (process-command process)))))
6798 (set-process-query-on-exit-flag
6799 new-process (process-query-on-exit-flag process))
6800 (set-process-inherit-coding-system-flag
6801 new-process (process-inherit-coding-system-flag process))
6802 (set-process-filter new-process (process-filter process))
6803 (set-process-sentinel new-process (process-sentinel process))
6804 (set-process-plist new-process (copy-sequence (process-plist process)))
6805 new-process)))
6807 ;; things to maybe add (currently partly covered by `funcall mode'):
6808 ;; - syntax-table
6809 ;; - overlays
6810 (defun clone-buffer (&optional newname display-flag)
6811 "Create and return a twin copy of the current buffer.
6812 Unlike an indirect buffer, the new buffer can be edited
6813 independently of the old one (if it is not read-only).
6814 NEWNAME is the name of the new buffer. It may be modified by
6815 adding or incrementing <N> at the end as necessary to create a
6816 unique buffer name. If nil, it defaults to the name of the
6817 current buffer, with the proper suffix. If DISPLAY-FLAG is
6818 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6819 clone a file-visiting buffer, or a buffer whose major mode symbol
6820 has a non-nil `no-clone' property, results in an error.
6822 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6823 current buffer with appropriate suffix. However, if a prefix
6824 argument is given, then the command prompts for NEWNAME in the
6825 minibuffer.
6827 This runs the normal hook `clone-buffer-hook' in the new buffer
6828 after it has been set up properly in other respects."
6829 (interactive
6830 (progn
6831 (if buffer-file-name
6832 (error "Cannot clone a file-visiting buffer"))
6833 (if (get major-mode 'no-clone)
6834 (error "Cannot clone a buffer in %s mode" mode-name))
6835 (list (if current-prefix-arg
6836 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6837 t)))
6838 (if buffer-file-name
6839 (error "Cannot clone a file-visiting buffer"))
6840 (if (get major-mode 'no-clone)
6841 (error "Cannot clone a buffer in %s mode" mode-name))
6842 (setq newname (or newname (buffer-name)))
6844 (setq newname (substring newname 0 (match-beginning 0))))
6845 (let ((buf (current-buffer))
6846 (ptmin (point-min))
6847 (ptmax (point-max))
6848 (pt (point))
6849 (mk (if mark-active (mark t)))
6850 (modified (buffer-modified-p))
6851 (mode major-mode)
6852 (lvars (buffer-local-variables))
6853 (process (get-buffer-process (current-buffer)))
6854 (new (generate-new-buffer (or newname (buffer-name)))))
6855 (save-restriction
6856 (widen)
6857 (with-current-buffer new
6858 (insert-buffer-substring buf)))
6859 (with-current-buffer new
6860 (narrow-to-region ptmin ptmax)
6861 (goto-char pt)
6862 (if mk (set-mark mk))
6863 (set-buffer-modified-p modified)
6865 ;; Clone the old buffer's process, if any.
6866 (when process (clone-process process))
6868 ;; Now set up the major mode.
6869 (funcall mode)
6871 ;; Set up other local variables.
6872 (mapc (lambda (v)
6873 (condition-case () ;in case var is read-only
6874 (if (symbolp v)
6875 (makunbound v)
6876 (set (make-local-variable (car v)) (cdr v)))
6877 (error nil)))
6878 lvars)
6880 ;; Run any hooks (typically set up by the major mode
6881 ;; for cloning to work properly).
6882 (run-hooks 'clone-buffer-hook))
6883 (if display-flag
6884 ;; Presumably the current buffer is shown in the selected frame, so
6885 ;; we want to display the clone elsewhere.
6886 (let ((same-window-regexps nil)
6887 (same-window-buffer-names))
6888 (pop-to-buffer new)))
6889 new))
6892 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6893 "Create an indirect buffer that is a twin copy of the current buffer.
6895 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6896 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6897 or if not called with a prefix arg, NEWNAME defaults to the current
6898 buffer's name. The name is modified by adding a `<N>' suffix to it
6899 or by incrementing the N in an existing suffix. Trying to clone a
6900 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6901 property results in an error.
6903 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6904 This is always done when called interactively.
6906 Optional third arg NORECORD non-nil means do not put this buffer at the
6907 front of the list of recently selected ones."
6908 (interactive
6909 (progn
6910 (if (get major-mode 'no-clone-indirect)
6911 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6912 (list (if current-prefix-arg
6913 (read-buffer "Name of indirect buffer: " (current-buffer)))
6914 t)))
6915 (if (get major-mode 'no-clone-indirect)
6916 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6917 (setq newname (or newname (buffer-name)))
6919 (setq newname (substring newname 0 (match-beginning 0))))
6920 (let* ((name (generate-new-buffer-name newname))
6921 (buffer (make-indirect-buffer (current-buffer) name t)))
6922 (with-current-buffer buffer
6923 (run-hooks 'clone-indirect-buffer-hook))
6924 (when display-flag
6925 (pop-to-buffer buffer norecord))
6926 buffer))
6929 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6930 "Like `clone-indirect-buffer' but display in another window."
6931 (interactive
6932 (progn
6933 (if (get major-mode 'no-clone-indirect)
6934 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6935 (list (if current-prefix-arg
6936 (read-buffer "Name of indirect buffer: " (current-buffer)))
6937 t)))
6938 (let ((pop-up-windows t))
6939 (clone-indirect-buffer newname display-flag norecord)))
6941 \f
6942 ;;; Handling of Backspace and Delete keys.
6944 (defcustom normal-erase-is-backspace 'maybe
6945 "Set the default behavior of the Delete and Backspace keys.
6947 If set to t, Delete key deletes forward and Backspace key deletes
6948 backward.
6950 If set to nil, both Delete and Backspace keys delete backward.
6952 If set to 'maybe (which is the default), Emacs automatically
6953 selects a behavior. On window systems, the behavior depends on
6954 the keyboard used. If the keyboard has both a Backspace key and
6955 a Delete key, and both are mapped to their usual meanings, the
6956 option's default value is set to t, so that Backspace can be used
6957 to delete backward, and Delete can be used to delete forward.
6959 If not running under a window system, customizing this option
6960 accomplishes a similar effect by mapping C-h, which is usually
6961 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6962 via `keyboard-translate'. The former functionality of C-h is
6963 available on the F1 key. You should probably not use this
6964 setting if you don't have both Backspace, Delete and F1 keys.
6966 Setting this variable with setq doesn't take effect. Programmatically,
6967 call `normal-erase-is-backspace-mode' (which see) instead."
6968 :type '(choice (const :tag "Off" nil)
6969 (const :tag "Maybe" maybe)
6970 (other :tag "On" t))
6971 :group 'editing-basics
6972 :version "21.1"
6973 :set (lambda (symbol value)
6974 ;; The fboundp is because of a problem with :set when
6975 ;; dumping Emacs. It doesn't really matter.
6976 (if (fboundp 'normal-erase-is-backspace-mode)
6977 (normal-erase-is-backspace-mode (or value 0))
6978 (set-default symbol value))))
6980 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6981 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6982 (unless frame (setq frame (selected-frame)))
6983 (with-selected-frame frame
6984 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6985 (normal-erase-is-backspace-mode
6986 (if (if (eq normal-erase-is-backspace 'maybe)
6987 (and (not noninteractive)
6988 (or (memq system-type '(ms-dos windows-nt))
6989 (memq window-system '(w32 ns))
6990 (and (memq window-system '(x))
6991 (fboundp 'x-backspace-delete-keys-p)
6992 (x-backspace-delete-keys-p))
6993 ;; If the terminal Emacs is running on has erase char
6994 ;; set to ^H, use the Backspace key for deleting
6995 ;; backward, and the Delete key for deleting forward.
6996 (and (null window-system)
6997 (eq tty-erase-char ?\^H))))
6998 normal-erase-is-backspace)
6999 1 0)))))
7001 (define-minor-mode normal-erase-is-backspace-mode
7002 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7003 With a prefix argument ARG, enable this feature if ARG is
7004 positive, and disable it otherwise. If called from Lisp, enable
7005 the mode if ARG is omitted or nil.
7007 On window systems, when this mode is on, Delete is mapped to C-d
7008 and Backspace is mapped to DEL; when this mode is off, both
7009 Delete and Backspace are mapped to DEL. (The remapping goes via
7010 `local-function-key-map', so binding Delete or Backspace in the
7011 global or local keymap will override that.)
7013 In addition, on window systems, the bindings of C-Delete, M-Delete,
7014 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7015 the global keymap in accordance with the functionality of Delete and
7016 Backspace. For example, if Delete is remapped to C-d, which deletes
7017 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7018 to DEL, which deletes backward, C-Delete is bound to
7019 `backward-kill-word'.
7021 If not running on a window system, a similar effect is accomplished by
7022 remapping C-h (normally produced by the Backspace key) and DEL via
7023 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7024 to C-d; if it's off, the keys are not remapped.
7026 When not running on a window system, and this mode is turned on, the
7027 former functionality of C-h is available on the F1 key. You should
7028 probably not turn on this mode on a text-only terminal if you don't
7029 have both Backspace, Delete and F1 keys.
7031 See also `normal-erase-is-backspace'."
7032 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7033 . (lambda (v)
7034 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7035 (if v 1 0))))
7036 (let ((enabled (eq 1 (terminal-parameter
7037 nil 'normal-erase-is-backspace))))
7039 (cond ((or (memq window-system '(x w32 ns pc))
7040 (memq system-type '(ms-dos windows-nt)))
7041 (let ((bindings
7042 `(([M-delete] [M-backspace])
7043 ([C-M-delete] [C-M-backspace])
7044 ([?\e C-delete] [?\e C-backspace]))))
7046 (if enabled
7047 (progn
7048 (define-key local-function-key-map [delete] [deletechar])
7049 (define-key local-function-key-map [kp-delete] [?\C-d])
7050 (define-key local-function-key-map [backspace] [?\C-?])
7051 (dolist (b bindings)
7052 ;; Not sure if input-decode-map is really right, but
7053 ;; keyboard-translate-table (used below) only works
7054 ;; for integer events, and key-translation-table is
7055 ;; global (like the global-map, used earlier).
7056 (define-key input-decode-map (car b) nil)
7057 (define-key input-decode-map (cadr b) nil)))
7058 (define-key local-function-key-map [delete] [?\C-?])
7059 (define-key local-function-key-map [kp-delete] [?\C-?])
7060 (define-key local-function-key-map [backspace] [?\C-?])
7061 (dolist (b bindings)
7062 (define-key input-decode-map (car b) (cadr b))
7063 (define-key input-decode-map (cadr b) (car b))))))
7064 (t
7065 (if enabled
7066 (progn
7067 (keyboard-translate ?\C-h ?\C-?)
7068 (keyboard-translate ?\C-? ?\C-d))
7069 (keyboard-translate ?\C-h ?\C-h)
7070 (keyboard-translate ?\C-? ?\C-?))))
7072 (if (called-interactively-p 'interactive)
7073 (message "Delete key deletes %s"
7074 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7075 "forward" "backward")))))
7076 \f
7077 (defvar vis-mode-saved-buffer-invisibility-spec nil
7078 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7080 (define-minor-mode read-only-mode
7081 "Change whether the current buffer is read-only.
7082 With prefix argument ARG, make the buffer read-only if ARG is
7083 positive, otherwise make it writable. If buffer is read-only
7084 and `view-read-only' is non-nil, enter view mode.
7086 Do not call this from a Lisp program unless you really intend to
7088 possibly enabling or disabling View mode. Also, note that this
7089 command works by setting the variable `buffer-read-only', which
7090 does not affect read-only regions caused by text properties. To
7091 ignore read-only status in a Lisp program (whether due to text
7092 properties or buffer state), bind `inhibit-read-only' temporarily
7093 to a non-nil value."
7094 :variable buffer-read-only
7095 (cond
7096 ((and (not buffer-read-only) view-mode)
7097 (View-exit-and-edit)
7098 (make-local-variable 'view-read-only)
7099 (setq view-read-only t)) ; Must leave view mode.
7100 ((and buffer-read-only view-read-only
7101 ;; If view-mode is already active, `view-mode-enter' is a nop.
7102 (not view-mode)
7103 (not (eq (get major-mode 'mode-class) 'special)))
7104 (view-mode-enter))))
7106 (define-minor-mode visible-mode
7107 "Toggle making all invisible text temporarily visible (Visible mode).
7108 With a prefix argument ARG, enable Visible mode if ARG is
7109 positive, and disable it otherwise. If called from Lisp, enable
7110 the mode if ARG is omitted or nil.
7112 This mode works by saving the value of `buffer-invisibility-spec'
7113 and setting it to nil."
7114 :lighter " Vis"
7115 :group 'editing-basics
7116 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7117 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7118 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7119 (when visible-mode
7120 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7121 buffer-invisibility-spec)
7122 (setq buffer-invisibility-spec nil)))
7123 \f
7124 ;; Minibuffer prompt stuff.
7126 ;;(defun minibuffer-prompt-modification (start end)
7127 ;; (error "You cannot modify the prompt"))
7128 ;;
7129 ;;
7130 ;;(defun minibuffer-prompt-insertion (start end)
7131 ;; (let ((inhibit-modification-hooks t))
7132 ;; (delete-region start end)
7133 ;; ;; Discard undo information for the text insertion itself
7134 ;; ;; and for the text deletion.above.
7135 ;; (when (consp buffer-undo-list)
7136 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7137 ;; (message "You cannot modify the prompt")))
7138 ;;
7139 ;;
7140 ;;(setq minibuffer-prompt-properties
7141 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7142 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7144 \f
7145 ;;;; Problematic external packages.
7147 ;; rms says this should be done by specifying symbols that define
7148 ;; versions together with bad values. This is therefore not as
7149 ;; flexible as it could be. See the thread:
7150 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7151 (defconst bad-packages-alist
7152 ;; Not sure exactly which semantic versions have problems.
7153 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7155 "The version of `semantic' loaded does not work in Emacs 22.
7156 It can cause constant high CPU load.
7157 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7158 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7159 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7160 ;; provided the `CUA-mode' feature. Since this is no longer true,
7161 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7162 (CUA-mode t nil
7163 "CUA-mode is now part of the standard GNU Emacs distribution,
7164 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7166 You have loaded an older version of CUA-mode which does not work
7167 correctly with this version of Emacs. You should remove the old
7168 version and use the one distributed with Emacs."))
7169 "Alist of packages known to cause problems in this version of Emacs.
7170 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7171 PACKAGE is either a regular expression to match file names, or a
7172 symbol (a feature name); see the documentation of
7173 `after-load-alist', to which this variable adds functions.
7174 SYMBOL is either the name of a string variable, or `t'. Upon
7175 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7176 warning using STRING as the message.")
7178 (defun bad-package-check (package)
7179 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7180 (condition-case nil
7181 (let* ((list (assoc package bad-packages-alist))
7182 (symbol (nth 1 list)))
7183 (and list
7184 (boundp symbol)
7185 (or (eq symbol t)
7186 (and (stringp (setq symbol (eval symbol)))
7187 (string-match-p (nth 2 list) symbol)))
7188 (display-warning package (nth 3 list) :warning)))
7189 (error nil)))
7191 (mapc (lambda (elem)
7192 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7193 bad-packages-alist)
7196 (provide 'simple)
7198 ;;; simple.el ends here