| blob | 18a360faa61baebc42339686df7190d714d67b5b |
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."
354 ;; 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.
385 When interactively called with prefix, indent the enclosing defun
386 instead."
397 "Major mode for editing programming language source code."
400 ;; Any programming language is always written left to right.
403 ;; Making and deleting lines.
409 "Insert a newline, and move to left margin of the new line if it's blank.
410 If option `use-hard-newlines' is non-nil, the newline is marked with the
411 text-property `hard'.
412 With ARG, insert that many newlines.
413 Call `auto-fill-function' if the current column number is greater
414 than the value of `fill-column' and ARG is nil."
417 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
418 ;; Set last-command-event to tell self-insert what to insert.
422 ;; Don't auto-fill if we have a numeric argument.
425 ;; Do the rest in post-self-insert-hook, because we want to do it
426 ;; *before* other functions on that hook.
428 ;; Mark the newline(s) `hard'.
432 ;; If the newline leaves the previous line blank, and we
433 ;; have a left margin, delete that from the blank line.
441 ;; Indent the line after the newline, except in one case:
442 ;; when we added the newline at the beginning of a line which
443 ;; starts a page.
450 ;; We first used let-binding to protect the hook, but that was naive
451 ;; since add-hook affects the symbol-default value of the variable,
452 ;; whereas the let-binding might only protect the buffer-local value.
454 nil)
459 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
465 "Insert a newline and leave point before it.
466 If there is a fill prefix and/or a `left-margin', insert them
467 on the new line if the line would have been blank.
468 With arg N, insert N newlines."
473 ;; Don't expand an abbrev before point.
487 "Split current line, moving portion beyond point vertically down.
488 If the current line starts with `fill-prefix', insert it on the new
489 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
491 When called from Lisp code, ARG may be a prefix string to copy."
496 ;; What prefix should we check for (nil means don't).
500 ;; Does this line start with it?
511 "Join this line to previous and fix up whitespace at join.
512 If there is a fill prefix, delete it from the beginning of this line.
513 With argument, join this line to following line."
520 ;; If the second line started with the fill prefix,
521 ;; delete the prefix.
533 "On blank line, delete all surrounding blank lines, leaving just one.
534 On isolated blank line, delete that one.
535 On nonblank line, delete any immediately following blank lines."
541 ;; Set singleblank if there is just one blank line here.
548 ;; Delete preceding blank lines, and this one too if it's the only one.
557 ;; Delete following blank lines, unless the current line is blank
558 ;; and there are no following blank lines.
567 ;; Handle the special case where point is followed by newline and eob.
568 ;; Delete the line, leaving point at eob.
574 Trailing lines are deleted only if `delete-trailing-whitespace'
575 is called on the entire buffer (rather than an active region)."
581 "Delete trailing whitespace between START and END.
582 If called interactively, START and END are the start/end of the
583 region if the mark is active, or of the buffer's accessible
584 portion if the mark is inactive.
586 This command deletes whitespace characters after the last
587 non-whitespace character in each line between START and END. It
588 does not consider formfeed characters to be whitespace.
590 If this command acts on the entire buffer (i.e. if called
591 interactively with the mark inactive, or called from Lisp with
592 END nil), it also deletes all trailing lines at the end of the
593 buffer if the variable `delete-trailing-lines' is non-nil."
606 ;; Don't delete formfeeds, even if they are considered whitespace.
610 ;; Delete trailing empty lines.
613 delete-trailing-lines
614 ;; Really the end of buffer.
619 ;; Return nil for the benefit of `write-file-functions'.
620 nil)
623 "Insert a newline, then indent according to major mode.
624 Indentation is done using the value of `indent-line-function'.
625 In programming language modes, this is the same as TAB.
626 In some text modes, where TAB inserts a tab, this command indents to the
627 column specified by the function `current-left-margin'."
634 "Reindent current line, insert newline, then indent the new line.
635 Indentation of both lines is done according to the current major mode,
636 which means calling the current value of `indent-line-function'.
637 In programming language modes, this is the same as TAB.
638 In some text modes, where TAB inserts a tab, this indents to the
639 column specified by the function `current-left-margin'."
642 ;; Be careful to insert the newline before indenting the line.
643 ;; Otherwise, the indentation might be wrong.
647 ;; We are at EOL before the call to indent-according-to-mode, and
648 ;; after it we usually are as well, but not always. We tried to
649 ;; address it with `save-excursion' but that uses a normal marker
650 ;; whereas we need `move after insertion', so we do the save/restore
651 ;; by hand.
655 ;; Remove the trailing white-space after indentation because
656 ;; indentation may introduce the whitespace.
661 "Read next input character and insert it.
662 This is useful for inserting control characters.
663 With argument, insert ARG copies of the character.
665 If the first character you type after this command is an octal digit,
666 you should type a sequence of octal digits which specify a character code.
667 Any nondigit terminates the sequence. If the terminator is a RET,
668 it is discarded; any other terminator is used itself as input.
669 The variable `read-quoted-char-radix' specifies the radix for this feature;
670 set it to 10 or 16 to use decimal or hex instead of octal.
672 In overwrite mode, this function inserts the character anyway, and
673 does not handle octal digits specially. This means that if you use
674 overwrite as your normal editing mode, you can use this function to
675 insert characters when necessary.
677 In binary overwrite mode, this function does overwrite, and octal
678 digits are interpreted as a character code. This is intended to be
679 useful for editing binary files."
682 ;; Avoid "obsolete" warnings for translation-table-for-input.
689 ;; This used to assume character codes 0240 - 0377 stand for
690 ;; characters in some single-byte character set, and converted them
691 ;; to Emacs characters. But in 23.1 this feature is deprecated
692 ;; in favor of inserting the corresponding Unicode characters.
693 ;; (if (and enable-multibyte-characters
694 ;; (>= char ?\240)
695 ;; (<= char ?\377))
696 ;; (setq char (unibyte-char-to-multibyte char)))
705 "Move forward ARG lines and position at first nonblank character."
711 "Move backward ARG lines and position at first nonblank character."
717 "Move point to the first non-whitespace character on this line."
721 ;; Move back over chars that have whitespace syntax but have the p flag.
725 "Fixup white space between objects around point.
726 Leave one space or none, according to the context."
733 nil
737 "Delete all spaces and tabs around point.
738 If BACKWARD-ONLY is non-nil, only delete them before point."
743 orig-pos
752 "Delete all spaces and tabs around point, leaving one space (or N spaces).
753 If N is negative, delete newlines as well, leaving -N spaces."
758 "Store context used in consecutive calls to `cycle-spacing' command.
759 The first time this function is run, it saves the original point
760 position and original spacing around the point in this
764 "Manipulate spaces around the point in a smart way.
766 When run as an interactive command, the first time it's called
767 in a sequence, deletes all spaces and tabs around point leaving
768 one (or N spaces). If this does not change content of the
769 buffer, skips to the second step:
771 When run for the second time in a sequence, deletes all the
772 spaces it has previously inserted.
774 When run for the third time, returns the whitespace and point in
775 a state encountered when it had been run for the first time.
778 point, calling `cycle-spacing' command will replace two spaces with
779 a single space, calling it again immediately after, will remove all
780 spaces, and calling it for the third time will bring two spaces back
781 together.
783 If N is negative, delete newlines as well. However, if
784 PRESERVE-NL-BACK is t new line characters prior to the point
785 won't be removed.
787 If SINGLE-SHOT is non-nil, will only perform the first step. In
788 other words, it will work just like `just-one-space' command."
796 ;; Command run for the first time or single-shot is non-nil.
807 ;; Special handling for case where there was no space at all.
810 ;; If this run causes no change in buffer content, delete all spaces,
811 ;; otherwise delete all excess spaces.
816 ;; Command run for the second time.
820 ;; Command run for the third time.
825 \f
827 "Move point to the beginning of the buffer.
828 With numeric arg N, put point N/10 of the way from the beginning.
829 If the buffer is narrowed, this command uses the beginning of the
830 accessible part of the buffer.
832 If Transient Mark mode is disabled, leave mark at previous
835 Don't use this command in Lisp programs!
836 \(goto-char (point-min)) is faster."
845 ;; Avoid overflow for large buffer sizes!
853 "Move point to the end of the buffer.
854 With numeric arg N, put point N/10 of the way from the end.
855 If the buffer is narrowed, this command uses the end of the
856 accessible part of the buffer.
858 If Transient Mark mode is disabled, leave mark at previous
861 Don't use this command in Lisp programs!
862 \(goto-char (point-max)) is faster."
869 ;; Avoid overflow for large buffer sizes!
874 ;; If we went to a place in the middle of the buffer,
875 ;; adjust it to the beginning of a line.
879 ;; If the end of the buffer is not already on the screen,
880 ;; then scroll specially to put it near, but not at, the bottom.
885 "Whether single-char deletion commands delete an active region.
886 This has an effect only if Transient Mark mode is enabled, and
887 affects `delete-forward-char' and `delete-backward-char', though
888 not `delete-char'.
890 If the value is the symbol `kill', the active region is killed
891 instead of deleted."
899 "Delete the previous N characters (following if N is negative).
900 If Transient Mark mode is enabled, the mark is active, and N is 1,
901 delete the text in the region and deactivate the mark instead.
902 To disable this, set option `delete-active-region' to nil.
904 Optional second arg KILLFLAG, if non-nil, means to kill (save in
905 kill ring) instead of delete. Interactively, N is the prefix
906 arg, and KILLFLAG is set if N is explicitly specified.
908 In Overwrite mode, single character backward deletion may replace
909 tabs with spaces so as to back over columns, unless point is at
910 the end of the line."
915 delete-active-region
917 ;; If a region is active, kill or delete it.
921 ;; In Overwrite mode, maybe untabify while deleting
931 ;; Otherwise, do simple deletion.
935 "Delete the following N characters (previous if N is negative).
936 If Transient Mark mode is enabled, the mark is active, and N is 1,
937 delete the text in the region and deactivate the mark instead.
938 To disable this, set variable `delete-active-region' to nil.
940 Optional second arg KILLFLAG non-nil means to kill (save in kill
941 ring) instead of delete. Interactively, N is the prefix arg, and
942 KILLFLAG is set if N was explicitly specified."
947 delete-active-region
949 ;; If a region is active, kill or delete it.
953 ;; Otherwise, do simple deletion.
957 "Put point at beginning and mark at end of buffer.
958 If narrowing is in effect, only uses the accessible part of the buffer.
959 You probably should not use this function in Lisp programs;
960 it is usually a mistake for a Lisp function to use any subroutine
961 that uses or sets the mark."
966 \f
968 ;; Counting lines, one way or another.
971 "Go to LINE, counting from line 1 at beginning of buffer.
972 If called interactively, a numeric prefix argument specifies
973 LINE; without a numeric prefix argument, read LINE from the
974 minibuffer.
976 If optional argument BUFFER is non-nil, switch to that buffer and
978 as argument, BUFFER is the most recently selected other buffer.
980 Prior to moving point, this function sets the mark (without
981 activating it), unless Transient Mark mode is enabled and the
982 mark is already active.
984 This function is usually the wrong thing to use in a Lisp program.
985 What you probably want instead is something like:
986 (goto-char (point-min))
987 (forward-line (1- N))
988 If at all possible, an even better solution is to use char counts
989 rather than line counts."
993 ;; Look for a default, a number in the buffer at point.
1003 ;; Decide if we're switching buffers.
1011 ;; Read the argument, offering that number (if any) as default.
1014 buffer))))
1015 ;; Switch to the desired buffer, one way or another.
1020 ;; Leave mark at previous position
1022 ;; Move to the specified line number in that buffer.
1031 "Count the number of words in the region.
1032 If called interactively, print a message reporting the number of
1033 lines, words, and characters in the region (whether or not the
1034 region is active); with prefix ARG, report for the entire buffer
1035 rather than the region.
1037 If called from Lisp, return the number of words between positions
1038 START and END."
1050 "Count words between START and END.
1051 If called interactively, START and END are normally the start and
1052 end of the buffer; but if the region is active, START and END are
1053 the start and end of the region. Print a message reporting the
1054 number of lines, words, and chars.
1056 If called from Lisp, return the number of words between START and
1057 END, without printing any message."
1067 words))
1083 str
1091 "Print the current buffer line number and narrowed line number of point."
1104 "Return number of lines between START and END.
1105 This is usually the number of newlines between them,
1106 but can be one more if START is not equal to END
1107 and the greater of them is not at the start of a line."
1123 done)))
1127 "Return (narrowed) buffer line number at position POS.
1128 If POS is nil, use current buffer location.
1129 Counting starts at (point-min), so the value refers
1130 to the contents of the accessible portion of the buffer."
1140 "Print info on cursor position (on screen and within buffer).
1141 Also describe the character after point, and give its character code
1142 in octal, decimal and hex.
1144 For a non-ASCII multibyte character, also give its encoding in the
1145 buffer's selected coding system if the coding system encodes the
1146 character safely. If the character is encoded into one byte, that
1147 code is shown in hex. If the character is encoded into more than one
1150 In addition, with prefix argument, show details about that character
1151 in *Help* buffer. See also the command `describe-char'."
1156 ;; If the character is one of LRE, LRO, RLE, RLO, it
1157 ;; will start a directional embedding, which could
1158 ;; completely disrupt the rest of the line (e.g., RLO
1159 ;; will display the rest of the line right-to-left).
1160 ;; So we put an invisible PDF character after these
1161 ;; characters, to end the embedding, which eliminates
1162 ;; any effects on the rest of the line.
1164 ;; Strong right-to-left characters cause reordering of
1165 ;; the following numerical characters which show the
1166 ;; codepoint, so append LRM to countermand that.
1176 ;; Avoid overflow from multiplying by 100!
1180 ""
1186 pos total percent beg end col hscroll)
1188 pos total col hscroll))
1190 encoded encoding-msg display-prop under-display)
1197 ;; Check if the character is displayed with some `display'
1198 ;; text property. In that case, set under-display to the
1199 ;; buffer substring covered by that property.
1210 under-display)))
1216 char char char under-display)
1218 char char char under-display display-prop))
1221 char char char
1223 "..."
1227 ;; We show the detailed information about CHAR.
1234 bidi-fixer
1235 encoding-msg pos total percent beg end col hscroll)
1242 bidi-fixer encoding-msg pos total percent col hscroll))))))
1243 \f
1244 ;; Initialize read-expression-map. It is defined at C level.
1248 ;; Might as well bind TAB to completion, since inserting a TAB char is
1249 ;; much too rarely useful.
1252 m))
1255 "Return a Lisp object read using the minibuffer, unevaluated.
1256 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1257 is a string to insert in the minibuffer before reading.
1258 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1259 Such arguments are used as in `read-from-minibuffer'.)"
1260 ;; Used for interactive spec `x'.
1262 t minibuffer-history))
1265 "Return value of Lisp expression read using the minibuffer.
1266 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1267 is a string to insert in the minibuffer before reading.
1268 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1269 Such arguments are used as in `read-from-minibuffer'.)"
1270 ;; Used for interactive spec `X'.
1278 "The current default value or list of default values in the minibuffer.
1279 The functions `read-from-minibuffer' and `completing-read' bind
1283 "Value for `print-level' while printing value in `eval-expression'.
1284 A value of nil means no limit."
1290 "Value for `print-length' while printing value in `eval-expression'.
1291 A value of nil means no limit."
1297 "If non-nil set `debug-on-error' to t in `eval-expression'.
1298 If nil, don't change the value of `debug-on-error'."
1304 "Format VALUE as a result of evaluated expression.
1305 Return a formatted string which is displayed in the echo area
1306 in addition to the value printed by prin1 in functions which
1307 display the result of expression evaluation."
1331 read-expression-map t
1334 ;; We define this, rather than making `eval' interactive,
1335 ;; for the sake of completion of names like eval-region, eval-buffer.
1337 "Evaluate EXP and print value in the echo area.
1338 When called interactively, read an Emacs Lisp expression and
1339 evaluate it.
1340 Value is also consed on to front of the variable `values'.
1341 Optional argument INSERT-VALUE non-nil (interactively,
1342 with prefix argument) means insert the result into the current buffer
1343 instead of printing it in the echo area. Truncates long output
1344 according to the value of the variables `eval-expression-print-length'
1345 and `eval-expression-print-level'.
1347 If `eval-expression-debug-on-error' is non-nil, which is the default,
1348 this command arranges for all errors to enter the debugger."
1351 current-prefix-arg))
1356 ;; Bind debug-on-error to something unique so that we can
1357 ;; detect when evalled code changes it.
1361 ;; If evalled code has changed the value of debug-on-error,
1362 ;; propagate that change to the global binding.
1379 "Prompting with PROMPT, let user edit COMMAND and eval result.
1380 COMMAND is a Lisp expression. Let user edit that expression in
1381 the minibuffer, then read and evaluate the result."
1388 read-expression-map t
1390 ;; If command was added to command-history as a string,
1391 ;; get rid of that. We want only evaluable expressions there.
1395 ;; If command to be redone does not match front of history,
1396 ;; add it to the history.
1402 "Edit and re-evaluate last complex command, or ARGth from last.
1403 A complex command is one which used the minibuffer.
1404 The command is placed in the minibuffer as a Lisp form for editing.
1405 The result is executed, repeating the command as changed.
1406 If the command has been changed or is not the most recent previous
1407 command it is added to the front of the command history.
1408 You can use the minibuffer history commands \
1410 to get different commands to edit and resubmit."
1413 newcmd)
1425 ;; If command was added to command-history as a
1426 ;; string, get rid of that. We want only
1427 ;; evaluable expressions there.
1431 ;; If command to be redone does not match front of history,
1432 ;; add it to the history.
1443 "Read command name to invoke in `execute-extended-command'."
1448 ;; Get a command name at point in the original buffer
1449 ;; to propose it after M-n.
1453 ;; Read a string, completing from and restricting to the set of
1454 ;; all defined commands. Don't provide any initial input.
1455 ;; Save the command read on the extended-command history list.
1466 ;; This isn't strictly correct if `execute-extended-command'
1467 ;; is bound to anything else (e.g. [menu]).
1468 ;; It could use (key-description (this-single-command-keys)),
1469 ;; but actually a prompt other than "M-x" would be confusing,
1470 ;; because "M-x" is a well-known prompt to read a command
1471 ;; and it serves as a shorthand for "Extended command: ".
1476 "Non-nil means show the equivalent key-binding when M-x command has one.
1477 The value can be a length of time to show the message for.
1478 If the value is non-nil and not a number, we wait 2 seconds."
1485 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1486 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1487 "Read function name, then read its arguments and call it.
1489 To pass a numeric argument to the command you are invoking, specify
1490 the numeric argument to this command.
1492 Noninteractively, the argument PREFIXARG is the prefix argument to
1493 give to the command you invoke, if it asks for an argument."
1495 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1506 ;; Normally `real-this-command' should never be changed, but here we really
1507 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1508 ;; binding" for <cmd>, so the command the user really wanted to run is
1509 ;; `function' and not `execute-extended-command'. The difference is
1510 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1514 ;; If enabled, show which key runs this command.
1516 ;; But first wait, and skip the message if there is input.
1518 ;; If this command displayed something in the echo area;
1519 ;; wait a few seconds, then display our suggestion message.
1529 suggest-key-bindings
1533 ;; BEWARE: Called directly from the C code.
1534 "Execute CMD as an editor command.
1535 CMD must be a symbol that satisfies the `commandp' predicate.
1536 Optional second arg RECORD-FLAG non-nil
1537 means unconditionally put this command in the variable `command-history'.
1538 Otherwise, that is done only if an arg is read using the minibuffer.
1539 The argument KEYS specifies the value to use instead of (this-command-keys)
1540 when reading the arguments; if it is nil, (this-command-keys) is used.
1541 The argument SPECIAL, if non-nil, means that this command is executing
1542 a special event, so ignore the prefix argument and don't clear it."
1550 ;; FIXME: Weird calling convention!
1560 ;; If requested, place the macro in the command history. For
1561 ;; other sorts of commands, call-interactively takes care of this.
1564 ;; Don't keep command history around forever.
1570 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1578 \f
1580 "Default minibuffer history list.
1581 This is used for all minibuffer input
1582 except when an alternate history list is specified.
1584 Maximum length of the history list is determined by the value
1587 "Control whether history list elements are expressions or strings.
1588 If the value of this variable equals current minibuffer depth,
1589 they are expressions; otherwise they are strings.
1590 \(That convention is designed to do the right thing for
1597 "Text that was in this minibuffer before any history commands.
1598 This is nil if there have not yet been any history commands
1607 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1611 "Minibuffer history variables for which matching should ignore case.
1612 If a history variable is a member of this list, then the
1614 commands ignore case when searching it, regardless of `case-fold-search'."
1619 "Find the previous history element that matches REGEXP.
1620 \(Previous history elements refer to earlier actions.)
1621 With prefix argument N, search for Nth previous match.
1622 If N is negative, find the next or Nth next match.
1623 Normally, history elements are matched case-insensitively if
1624 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1625 makes the search case-sensitive.
1626 See also `minibuffer-history-case-insensitive-variables'."
1630 nil
1631 minibuffer-local-map
1632 nil
1633 'minibuffer-history-search-history
1635 ;; Use the last regexp specified, by default, if input is empty.
1640 regexp)
1650 ;; On some systems, ignore case for file names.
1652 minibuffer-history-case-insensitive-variables)
1653 t
1654 ;; Respect the user's setting for case-fold-search:
1655 case-fold-search)
1656 nil))
1657 prevpos
1658 match-string
1659 match-offset
1666 "No later matching history item"
1687 next-matching-history-element))
1691 "Find the next history element that matches REGEXP.
1692 \(The next history element refers to a more recent action.)
1693 With prefix argument N, search for Nth next match.
1694 If N is negative, find the previous or Nth previous match.
1695 Normally, history elements are matched case-insensitively if
1696 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1697 makes the search case-sensitive."
1701 nil
1702 minibuffer-local-map
1703 nil
1704 'minibuffer-history-search-history
1706 ;; Use the last regexp specified, by default, if input is empty.
1711 regexp)
1718 "Function run by `goto-history-element' before consuming default values.
1719 This is useful to dynamically add more elements to the list of default values
1720 when `goto-history-element' reaches the end of this list.
1721 Before calling this function `goto-history-element' sets the variable
1722 `minibuffer-default-add-done' to t, so it will call this function only
1723 once. In special cases, when this function needs to be called more
1724 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1728 "When nil, add more elements to the end of the list of default values.
1729 The value nil causes `goto-history-element' to add more elements to
1730 the list of defaults when it reaches the end of this list. It does
1736 "Return a list of all completions without the default value.
1737 This function is used to add all elements of the completion table to
1738 the end of the list of defaults just after the default value."
1741 minibuffer-completion-table
1742 minibuffer-completion-predicate)))
1748 "Puts element of the minibuffer history in the minibuffer.
1749 The argument NABS specifies the absolute history position."
1763 elt minibuffer-returned-to-present)
1770 "End of defaults; no next item"
1775 previous-history-element))
1787 minibuffer-default)))
1799 elt))
1803 "Puts next element of the minibuffer history in the minibuffer.
1804 With argument N, it uses the Nth following element."
1810 "Puts previous element of the minibuffer history in the minibuffer.
1811 With argument N, it uses the Nth previous element."
1817 "Get next history element which completes the minibuffer before the point.
1818 The contents of the minibuffer after the point are deleted, and replaced
1819 by the new completion."
1825 n)
1826 ;; next-matching-history-element always puts us at (point-min).
1827 ;; Move to the position we were at before changing the buffer contents.
1828 ;; This is still sensible, because the text before point has not changed.
1832 "\
1833 Get previous history element which completes the minibuffer before the point.
1834 The contents of the minibuffer after the point are deleted, and replaced
1835 by the new completion."
1839 ;; For compatibility with the old subr of the same name.
1841 "Return the display width of the minibuffer prompt.
1842 Return 0 if current buffer is not a minibuffer."
1843 ;; Return the width of everything before the field at the end of
1844 ;; the buffer; this should be 0 for normal buffers.
1846 \f
1847 ;; isearch minibuffer history
1854 "Set up a minibuffer for using isearch to search the minibuffer history.
1855 Intended to be added to `minibuffer-setup-hook'."
1867 "Clean up the minibuffer after terminating isearch in the minibuffer."
1872 "Return the proper search function, for isearch in minibuffer history."
1875 ;; Use standard functions to search within minibuffer text
1877 found)
1878 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1879 ;; searching forward. Lazy-highlight calls this lambda with the
1880 ;; bound arg, so skip the minibuffer prompt.
1884 ;; 1. First try searching in the initial minibuffer text
1887 noerror)
1888 ;; 2. If the above search fails, start putting next/prev history
1889 ;; elements in the minibuffer successively, and search the string
1890 ;; in them. Do this only when bound is nil (i.e. not while
1891 ;; lazy-highlighting search strings in the current minibuffer text).
1903 ;; After putting the next/prev history element, search
1904 ;; the string in them again, until next-history-element
1905 ;; or previous-history-element raises an error at the
1906 ;; beginning/end of history.
1909 ;; For backward search, don't search
1910 ;; in the minibuffer prompt
1912 noerror)))
1913 ;; Return point of the new search result
1915 ;; Return nil when next(prev)-history-element fails
1919 "Display the minibuffer history search prompt.
1920 If there are no search errors, this function displays an overlay with
1921 the isearch prompt which replaces the original minibuffer prompt.
1922 Otherwise, it displays the standard isearch message returned from
1923 the function `isearch-message'."
1925 ;; Use standard function `isearch-message' when not in the minibuffer,
1926 ;; or search fails, or has an error (like incomplete regexp).
1927 ;; This function overwrites minibuffer text with isearch message,
1928 ;; so it's possible to see what is wrong in the search string.
1930 ;; Otherwise, put the overlay with the standard isearch prompt over
1931 ;; the initial minibuffer prompt.
1940 ;; And clear any previous isearch message.
1944 "Wrap the minibuffer history search when search fails.
1945 Move point to the first history element for a forward search,
1946 or to the last history element for a backward search."
1947 ;; When `minibuffer-history-isearch-search' fails on reaching the
1948 ;; beginning/end of the history, wrap the search to the first/last
1949 ;; minibuffer history element.
1957 "Save a function restoring the state of minibuffer history search.
1958 Save `minibuffer-history-position' to the additional state parameter
1959 in the search status stack."
1965 "Restore the minibuffer history search state.
1966 Go to the history element by the absolute history position HIST-POS."
1969 \f
1970 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1974 "Table mapping redo records to the corresponding undo one.
1975 A redo record for undo-in-region maps to t.
1985 "Within a run of consecutive undo commands, list remaining to be undone.
1989 "Undo some previous changes.
1990 Repeat this command to undo more changes.
1991 A numeric ARG serves as a repeat count.
1993 In Transient Mark mode when the mark is active, only undo changes within
1995 as an argument limits undo to changes within the current region."
1997 ;; Make last-command indicate for the next command that this was an undo.
1998 ;; That way, another undo will undo more.
1999 ;; If we get to the end of the undo history and get an error,
2000 ;; another undo command will find the undo history empty
2001 ;; and will get another error. To begin undoing the undos,
2002 ;; you must type some other command.
2004 ;; For an indirect buffer, look in the base buffer for the
2005 ;; auto-save data.
2009 message)
2010 ;; If we get an error in undo-start,
2011 ;; the next command should not be a "consecutive undo".
2012 ;; So set `this-command' to something other than `undo'.
2017 ;; If something (a timer or filter?) changed the buffer
2018 ;; since the previous command, don't continue the undo seq.
2022 ;; If the last undo record made was made by undo
2023 ;; it shows nothing else happened in between.
2030 ;; get rid of initial undo boundary
2032 ;; If we got this far, the next command should be a consecutive undo.
2034 ;; Check to see whether we're hitting a redo record, and if
2035 ;; so, ask the user whether she wants to skip the redo/undo pair.
2043 ;; The equiv entry might point to another redo record if we have done
2044 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2052 ;; Record the fact that the just-generated undo records come from an
2053 ;; undo operation--that is, they are redo records.
2054 ;; In the ordinary case (not within a region), map the redo
2055 ;; record to the following undos.
2056 ;; I don't know how to do that in the undo-in-region case.
2058 ;; Strip any leading undo boundaries there might be, like we do
2059 ;; above when checking.
2063 undo-equiv-table))
2064 ;; Don't specify a position in the undo record for the undo command.
2065 ;; Instead, undoing this should move point to where the change is.
2084 ;; Record what the current undo list says,
2085 ;; so the next command can tell if the buffer was modified in between.
2089 ;; Display a message announcing success.
2094 "Make BUFFER stop keeping undo information.
2095 No argument or nil as argument means do this for the current buffer."
2101 "Undo some previous changes.
2102 Repeat this command to undo more changes.
2103 A numeric ARG serves as a repeat count.
2104 Contrary to `undo', this will not redo a previous undo."
2109 "Non-nil while performing an undo.
2113 "Undo back N undo-boundaries beyond what was already undone recently.
2114 Call `undo-start' to get ready to undo recent changes,
2115 then call `undo-more' one or more times to undo them."
2120 ;; Note: The following, while pulling elements off
2121 ;; `pending-undo-list' will call primitive change functions which
2122 ;; will push more elements onto `buffer-undo-list'.
2128 "Undo N records from the front of the list LIST.
2129 Return what remains of the list."
2131 ;; This is a good feature, but would make undo-start
2132 ;; unable to do what is expected.
2133 ;;(when (null (car (list)))
2134 ;; ;; If the head of the list is a boundary, it is the boundary
2135 ;; ;; preceding this command. Get rid of it and don't count it.
2136 ;; (setq list (cdr list))))
2139 ;; In a writable buffer, enable undoing read-only text that is
2140 ;; so because of text properties.
2142 ;; Don't let `intangible' properties interfere with undo.
2144 ;; We use oldlist only to check for EQ. ++kfs
2150 ;; Handle an integer by setting point to that value.
2153 ;; Element (t . TIME) records previous modtime.
2154 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2155 ;; UNKNOWN_MODTIME_NSECS.
2157 ;; If this records an obsolete save
2158 ;; (not matching the actual disk file)
2159 ;; then don't mark unmodified.
2167 ;; Element (nil PROP VAL BEG . END) is property change.
2172 ;; Element (BEG . END) means range was inserted.
2174 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2175 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2178 ;; Set point first thing, so that undoing this undo
2179 ;; does not send point back to where it is now.
2182 ;; Element (apply FUN . ARGS) means call FUN to undo.
2186 ;; Long format: (apply DELTA START END FUN . ARGS).
2193 ;; Check that the function did what the entry
2194 ;; said it would do.
2204 ;; Element (STRING . POS) means STRING was deleted.
2214 ;; Now that we record marker adjustments
2215 ;; (caused by deletion) for undo,
2216 ;; we should always insert after markers,
2217 ;; so that undoing the marker adjustments
2218 ;; put the markers back in the right place.
2221 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2229 ;; Make sure an apply entry produces at least one undo entry,
2230 ;; so the test in `undo' for continuing an undo series
2231 ;; will work right.
2236 list)
2238 ;; Deep copy of a list
2240 "Make a copy of undo list LIST."
2246 elt))
2249 "Set `pending-undo-list' to the front of the undo list.
2250 The next call to `undo-more' will undo the most recently made change.
2251 If BEG and END are specified, then only undo elements
2252 that apply to text between BEG and END are used; other undo elements
2253 are ignored. If BEG and END are nil, all undo elements are used."
2259 buffer-undo-list)))
2264 "Return a list of undo elements for the region START to END.
2265 The elements come from `buffer-undo-list', but we keep only
2266 the elements inside this region, and discard those outside this region.
2267 If we find an element that crosses an edge of this region,
2268 we stop and ignore all further elements."
2271 undo-adjusted-markers
2272 some-rejected
2273 undo-elt temp-undo-list delta)
2278 ;; This is a "was unmodified" element.
2279 ;; Keep it if we have kept everything thus far.
2286 ;; Don't put two nils together in the list
2300 ;; Loop down the earlier events adjusting their buffer
2301 ;; positions to reflect the fact that a change to the buffer
2302 ;; isn't being undone. We only need to process those element
2303 ;; types which undo-elt-in-region will return as being in
2304 ;; the region since only those types can ever get into the
2305 ;; output
2314 ;; (TEXT . POSITION)
2321 ;; (BEGIN . END)
2326 ;; (nil PROPERTY VALUE BEG . END)
2336 "Determine whether UNDO-ELT falls inside the region START ... END.
2337 If it crosses the edge, we return nil."
2342 t)
2344 nil)
2346 ;; (TEXT . POSITION)
2350 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2351 ;; See if MARKER is inside the region.
2362 ;; (nil PROPERTY VALUE BEG . END)
2367 ;; (BEGIN . END)
2372 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2373 This assumes we have already decided that UNDO-ELT
2374 is not *inside* the region START...END."
2377 ;; (nil PROPERTY VALUE BEG . END)
2382 ;; (BEGIN . END)
2386 ;; Return the first affected buffer position and the delta for an undo element
2387 ;; delta is defined as the change in subsequent buffer positions if we *did*
2388 ;; the undo.
2392 ;; (TEXT . POSITION)
2395 ;; (BEGIN . END)
2402 "If non-nil ask about discarding undo info for the current command.
2403 Normally, Emacs discards the undo info for the current command if
2404 it exceeds `undo-outer-limit'. But if you set this option
2405 non-nil, it asks in the echo area whether to discard the info.
2406 If you answer no, there is a slight risk that Emacs might crash, so
2407 only do it if you really want to undo the command.
2409 This option is mainly intended for debugging. You have to be
2410 careful if you use it for other purposes. Garbage collection is
2411 inhibited while the question is asked, meaning that Emacs might
2412 leak memory. So you should make sure that you do not wait
2413 excessively long before answering the question."
2419 "If non-nil, an extra level of size that's ok in an undo item.
2420 We don't ask the user about truncating the undo list until the
2421 current item gets bigger than this amount.
2426 ;; When the first undo batch in an undo list is longer than
2427 ;; undo-outer-limit, this function gets called to warn the user that
2428 ;; the undo info for the current command was discarded. Garbage
2429 ;; collection is inhibited around the call, so it had better not do a
2430 ;; lot of consing.
2436 ;; Don't ask the question again unless it gets even bigger.
2437 ;; This applies, in particular, if the user quits from the question.
2438 ;; Such a quit quits out of GC, but something else will call GC
2439 ;; again momentarily. It will call this function again,
2440 ;; but we don't want to ask the question again.
2447 t)
2448 nil))
2453 "The undo info was discarded because it exceeded \
2454 `undo-outer-limit'.
2456 This is normal if you executed a command that made a huge change
2457 to the buffer. In that case, to prevent similar problems in the
2458 future, set `undo-outer-limit' to a value that is large enough to
2459 cover the maximum size of normal changes you expect a single
2460 command to make, but not so large that it might exceed the
2461 maximum memory allotted to Emacs.
2463 If you did not execute any such command, the situation is
2464 probably due to a bug and you should report it.
2466 You can disable the popping up of this buffer by adding the entry
2467 \(undo discard-info) to the user option `warning-suppress-types',
2471 t))
2472 \f
2474 "History list for some commands that read shell commands.
2476 Maximum length of the history list is determined by the value
2483 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2484 This buffer is used when `shell-command' or `shell-command-on-region'
2485 is run interactively. A value of nil means that output to stderr and
2492 "Return a list of all commands associated with the current file.
2493 This function is used to add all related commands retrieved by `mailcap'
2494 to the end of the list of defaults just after the default value."
2498 minibuffer-default))
2503 commands))
2514 map)
2518 "Read a shell command from the minibuffer.
2519 The arguments are the same as the ones of `read-from-minibuffer',
2520 except READ and KEYMAP are missing and HIST defaults
2521 to `shell-command-history'."
2529 minibuffer-local-shell-command-map
2530 nil
2532 args)))
2535 "What to do when the output buffer is used by another shell command.
2536 This option specifies how to resolve the conflict where a new command
2537 wants to direct its output to the buffer `*Async Shell Command*',
2538 but this buffer is already taken by another running shell command.
2540 The value `confirm-kill-process' is used to ask for confirmation before
2541 killing the already running process and running a new process
2542 in the same buffer, `confirm-new-buffer' for confirmation before running
2543 the command in a new buffer with a name other than the default buffer name,
2544 `new-buffer' for doing the same without confirmation,
2545 `confirm-rename-buffer' for confirmation before renaming the existing
2546 output buffer and running a new command in the default buffer,
2547 `rename-buffer' for doing the same without confirmation."
2549 confirm-kill-process)
2551 confirm-new-buffer)
2553 new-buffer)
2555 confirm-rename-buffer)
2557 rename-buffer))
2562 "Execute string COMMAND asynchronously in background.
2564 Like `shell-command', but adds `&' at the end of COMMAND
2565 to execute it asynchronously.
2567 The output appears in the buffer `*Async Shell Command*'.
2568 That buffer is in shell mode.
2570 In Elisp, you will often be better served by calling `start-process'
2571 directly, since it offers more control and does not impose the use of a
2572 shell (with its need to quote arguments)."
2582 current-prefix-arg
2583 shell-command-default-error-buffer))
2589 "Execute string COMMAND in inferior shell; display output, if any.
2590 With prefix argument, insert the COMMAND's output at point.
2592 If COMMAND ends in `&', execute it asynchronously.
2593 The output appears in the buffer `*Async Shell Command*'.
2594 That buffer is in shell mode. You can also use
2595 `async-shell-command' that automatically adds `&'.
2597 Otherwise, COMMAND is executed synchronously. The output appears in
2598 the buffer `*Shell Command Output*'. If the output is short enough to
2599 display in the echo area (which is determined by the variables
2600 `resize-mini-windows' and `max-mini-window-height'), it is shown
2601 there, but it is nonetheless available in buffer `*Shell Command
2602 Output*' even though that buffer is not automatically displayed.
2604 To specify a coding system for converting non-ASCII characters
2606 before this command.
2608 Noninteractive callers can specify coding systems by binding
2609 `coding-system-for-read' and `coding-system-for-write'.
2611 The optional second argument OUTPUT-BUFFER, if non-nil,
2612 says to put the output in some other buffer.
2613 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2614 If OUTPUT-BUFFER is not a buffer and not nil,
2615 insert output in current buffer. (This cannot be done asynchronously.)
2616 In either case, the buffer is first erased, and the output is
2617 inserted after point (leaving mark after it).
2619 If the command terminates without error, but generates output,
2621 the output can be displayed in the echo area or in its buffer.
2622 If the output is short enough to display in the echo area
2623 \(determined by the variable `max-mini-window-height' if
2624 `resize-mini-windows' is non-nil), it is shown there.
2625 Otherwise,the buffer containing the output is displayed.
2629 of the output.
2631 If there is no output, or if output is inserted in the current buffer,
2632 then `*Shell Command Output*' is deleted.
2634 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2635 or buffer name to which to direct the command's standard error output.
2636 If it is nil, error output is mingled with regular output.
2637 In an interactive call, the variable `shell-command-default-error-buffer'
2638 specifies the value of ERROR-BUFFER.
2640 In Elisp, you will often be better served by calling `call-process' or
2641 `start-process' directly, since it offers more control and does not impose
2642 the use of a shell (with its need to quote arguments)."
2653 current-prefix-arg
2654 shell-command-default-error-buffer))
2655 ;; Look for a handler in case default-directory is a remote file name.
2663 ;; Output goes in current buffer.
2669 temporary-file-directory)))
2670 nil)))
2673 ;; We do not use -f for csh; we will not support broken use of
2674 ;; .cshrcs. Even the BSD csh manual says to use
2675 ;; "if ($?prompt) exit" before things which are not useful
2676 ;; non-interactively. Besides, if someone wants their other
2677 ;; aliases for shell commands then they can still have them.
2681 t)
2682 nil shell-command-switch command)
2689 ;; Do no formatting while reading error file,
2690 ;; because that can run a shell command, and we
2691 ;; don't want that to cause an infinite recursion.
2693 ;; Put point after the inserted errors.
2697 ;; This is like exchange-point-and-mark, but doesn't
2698 ;; activate the mark. It is cleaner to avoid activation,
2699 ;; even though the command loop would deactivate the mark
2700 ;; because we inserted text.
2704 ;; Output goes in a separate buffer.
2705 ;; Preserve the match data in case called from a program.
2708 ;; Command ending with ampersand means asynchronous.
2712 proc)
2713 ;; Remove the ampersand.
2715 ;; Ask the user what to do with already running process.
2720 ;; If will kill a process, query first.
2725 ;; If will create a new buffer, query first.
2731 ;; It will create a new buffer.
2735 ;; If will rename the buffer, query first.
2744 ;; It will rename the buffer.
2751 ;; Setting buffer-read-only to nil doesn't suffice
2752 ;; if some text has a non-nil read-only property,
2753 ;; which comint sometimes adds for prompts.
2759 shell-command-switch command))
2763 ;; Use the comint filter for proper handling of carriage motion
2764 ;; (see `comint-inhibit-carriage-motion'),.
2766 ))
2767 ;; Otherwise, command is executed synchronously.
2769 output-buffer nil error-buffer)))))))
2773 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2774 MESSAGE may be either a string or a buffer.
2776 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2777 the maximum height of the echo area, as defined by `max-mini-window-height'
2778 if `resize-mini-windows' is non-nil.
2780 Returns either the string shown in the echo area, or when a pop-up
2781 buffer is used, the window used to display it.
2783 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2784 name of the buffer used to display it in the case where a pop-up buffer
2785 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2786 string and it is displayed in the echo area, it is not specified whether
2787 the contents are inserted into the buffer anyway.
2789 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2790 and only used if a buffer is displayed."
2792 ;; Trivial case where we can use the echo area
2796 ;; Trivial case where we can just remove single trailing newline
2799 ;; General case
2802 message
2811 0
2815 (<= lines
2819 max-mini-window-height))
2821 max-mini-window-height)
2825 ;; Don't use the echo area if the output buffer is
2826 ;; already displayed in the selected frame.
2828 ;; Echo area
2834 ;; Buffer
2837 not-this-window frame))))))))
2840 ;; We have a sentinel to prevent insertion of a termination message
2841 ;; in the buffer itself.
2849 &optional output-buffer replace
2850 error-buffer display-error-buffer)
2851 "Execute string COMMAND in inferior shell with region as input.
2852 Normally display output (if any) in temp buffer `*Shell Command Output*';
2853 Prefix arg means replace the region with it. Return the exit code of
2854 COMMAND.
2856 To specify a coding system for converting non-ASCII characters
2858 before this command. By default, the input (from the current buffer)
2859 is encoded using coding-system specified by `process-coding-system-alist',
2860 falling back to `default-process-coding-system' if no match for COMMAND
2861 is found in `process-coding-system-alist'.
2863 Noninteractive callers can specify coding systems by binding
2864 `coding-system-for-read' and `coding-system-for-write'.
2866 If the command generates output, the output may be displayed
2867 in the echo area or in a buffer.
2868 If the output is short enough to display in the echo area
2869 \(determined by the variable `max-mini-window-height' if
2870 `resize-mini-windows' is non-nil), it is shown there.
2871 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2872 The output is available in that buffer in both cases.
2874 If there is output and an error, a message about the error
2875 appears at the end of the output. If there is no output, or if
2876 output is inserted in the current buffer, the buffer `*Shell
2877 Command Output*' is deleted.
2879 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2880 command's output. If the value is a buffer or buffer name, put
2881 the output there. Any other value, excluding nil, means to
2882 insert the output in the current buffer. In either case, the
2883 output is inserted after point (leaving mark after it).
2885 Optional fifth arg REPLACE, if non-nil, means to insert the
2886 output in place of text from START to END, putting point and mark
2887 around it.
2889 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2890 or buffer name to which to direct the command's standard error
2891 output. If nil, error output is mingled with regular output.
2892 When called interactively, `shell-command-default-error-buffer'
2893 is used for ERROR-BUFFER.
2895 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2896 display the error buffer if there were any errors. When called
2897 interactively, this is t."
2901 ;; Do this before calling region-beginning
2902 ;; and region-end, in case subprocess output
2903 ;; relocates them while we are in the minibuffer.
2905 ;; call-interactively recognizes region-beginning and
2906 ;; region-end specially, leaving them in the history.
2908 string
2909 current-prefix-arg
2910 current-prefix-arg
2911 shell-command-default-error-buffer
2912 t)))
2918 temporary-file-directory)))
2919 nil))
2920 exit-status)
2924 ;; Replace specified region with output from command.
2926 ;; Don't muck with mark unless REPLACE says we should.
2933 t)
2934 nil shell-command-switch command))
2935 ;; It is rude to delete a buffer which the command is not using.
2936 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2937 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2938 ;; (kill-buffer shell-buffer)))
2939 ;; Don't muck with mark unless REPLACE says we should.
2941 ;; No prefix argument: put the output in a temp buffer,
2942 ;; replacing its entire contents.
2947 ;; If the input is the same buffer as the output,
2948 ;; delete everything but the specified region,
2949 ;; then replace that region with the output.
2955 shell-file-name t
2958 t)
2959 nil shell-command-switch
2960 command)))
2961 ;; Clear the output buffer, then run the command with
2962 ;; output there.
2973 buffer)
2974 nil shell-command-switch command)))
2975 ;; Report the output.
2985 ;; There's some output, display it
2987 ;; No output; error?
2994 shell-command-default-error-buffer)
3001 output))
3004 exit-status))
3007 exit-status output))))
3008 ;; Don't kill: there might be useful info in the undo-log.
3009 ;; (kill-buffer buffer)
3010 ))))
3018 ;; Do no formatting while reading error file,
3019 ;; because that can run a shell command, and we
3020 ;; don't want that to cause an infinite recursion.
3022 ;; Put point after the inserted errors.
3027 exit-status))
3030 "Execute shell command COMMAND and return its output as a string."
3033 standard-output
3037 "Process files synchronously in a separate process.
3038 Similar to `call-process', but may invoke a file handler based on
3039 `default-directory'. The current working directory of the
3040 subprocess is `default-directory'.
3042 File names in INFILE and BUFFER are handled normally, but file
3043 names in ARGS should be relative to `default-directory', as they
3044 are passed to the process verbatim. \(This is a difference to
3045 `call-process' which does not support file handlers for INFILE
3046 and BUFFER.\)
3048 Some file handlers might not support all variants, for example
3049 they might behave as if DISPLAY was nil, regardless of the actual
3050 value passed."
3052 lc stderr-file)
3062 display args)
3068 "Whether a call of `process-file' changes remote files.
3070 By default, this variable is always set to `t', meaning that a
3071 call of `process-file' could potentially change any file on a
3072 remote host. When set to `nil', a file handler could optimize
3073 its behavior with respect to remote file attribute caching.
3075 You should only ever change this variable with a let-binding;
3079 "Start a program in a subprocess. Return the process object for it.
3081 Similar to `start-process', but may invoke a file handler based on
3082 `default-directory'. See Info node `(elisp)Magic File Names'.
3084 This handler ought to run PROGRAM, perhaps on the local host,
3085 perhaps on a remote host that corresponds to `default-directory'.
3086 In the latter case, the local part of `default-directory' becomes
3087 the working directory of the process.
3089 PROGRAM and PROGRAM-ARGS might be file names. They are not
3090 objects of file handler invocation. File handlers might not
3091 support pty association, if PROGRAM is nil."
3095 \f
3096 ;;;; Process menu
3108 "Major mode for listing the processes called by Emacs."
3120 "Recompute the list of processes for the Process List buffer.
3121 Also, delete any process that is exited or signaled."
3134 face link
3137 follow-link t
3138 process-buffer ,buf
3139 action process-menu-visit-buffer)
3148 "datagram"
3165 tabulated-list-entries))))))
3171 "Display a list of all processes.
3172 If optional argument QUERY-ONLY is non-nil, only processes with
3173 the query-on-exit flag set are listed.
3174 Any process listed as exited or signaled is actually eliminated
3175 after the listing is made.
3176 Optional argument BUFFER specifies a buffer to use, instead of
3178 The return value is always nil."
3190 nil)
3191 \f
3195 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
3196 (define-key map [switch-frame] nil)
3197 (define-key map [?\C-u] 'universal-argument-more)
3198 (define-key map [?-] 'universal-argument-minus)
3199 (define-key map [?0] 'digit-argument)
3200 (define-key map [?1] 'digit-argument)
3201 (define-key map [?2] 'digit-argument)
3202 (define-key map [?3] 'digit-argument)
3203 (define-key map [?4] 'digit-argument)
3204 (define-key map [?5] 'digit-argument)
3205 (define-key map [?6] 'digit-argument)
3206 (define-key map [?7] 'digit-argument)
3207 (define-key map [?8] 'digit-argument)
3208 (define-key map [?9] 'digit-argument)
3209 (define-key map [kp-0] 'digit-argument)
3210 (define-key map [kp-1] 'digit-argument)
3211 (define-key map [kp-2] 'digit-argument)
3212 (define-key map [kp-3] 'digit-argument)
3213 (define-key map [kp-4] 'digit-argument)
3214 (define-key map [kp-5] 'digit-argument)
3215 (define-key map [kp-6] 'digit-argument)
3216 (define-key map [kp-7] 'digit-argument)
3217 (define-key map [kp-8] 'digit-argument)
3218 (define-key map [kp-9] 'digit-argument)
3219 (define-key map [kp-subtract] 'universal-argument-minus)
3220 map)
3223 (defvar universal-argument-num-events nil
3224 "Number of argument-specifying events read by `universal-argument'.
3225 `universal-argument-other-key' uses this to discard those events
3226 from (this-command-keys), and reread only the final command.")
3228 (defvar saved-overriding-map t
3229 "The saved value of `overriding-terminal-local-map'.
3233 (defun save&set-overriding-map (map)
3234 "Set `overriding-terminal-local-map' to MAP."
3235 (when (eq saved-overriding-map t)
3236 (setq saved-overriding-map overriding-terminal-local-map)
3237 (setq overriding-terminal-local-map map)))
3239 (defun restore-overriding-map ()
3240 "Restore `overriding-terminal-local-map' to its saved value."
3241 (setq overriding-terminal-local-map saved-overriding-map)
3242 (setq saved-overriding-map t))
3244 (defun universal-argument ()
3245 "Begin a numeric argument for the following command.
3250 multiplies the argument by 4 each time.
3252 which is different in effect from any particular numeric argument.
3254 (interactive)
3255 (setq prefix-arg (list 4))
3256 (setq universal-argument-num-events (length (this-command-keys)))
3257 (save&set-overriding-map universal-argument-map))
3259 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3260 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3261 (defun universal-argument-more (arg)
3262 (interactive "P")
3263 (if (consp arg)
3264 (setq prefix-arg (list (* 4 (car arg))))
3265 (if (eq arg '-)
3266 (setq prefix-arg (list -4))
3267 (setq prefix-arg arg)
3268 (restore-overriding-map)))
3269 (setq universal-argument-num-events (length (this-command-keys))))
3271 (defun negative-argument (arg)
3272 "Begin a negative numeric argument for the next command.
3274 (interactive "P")
3275 (cond ((integerp arg)
3276 (setq prefix-arg (- arg)))
3277 ((eq arg '-)
3278 (setq prefix-arg nil))
3279 (t
3280 (setq prefix-arg '-)))
3281 (setq universal-argument-num-events (length (this-command-keys)))
3282 (save&set-overriding-map universal-argument-map))
3284 (defun digit-argument (arg)
3285 "Part of the numeric argument for the next command.
3287 (interactive "P")
3288 (let* ((char (if (integerp last-command-event)
3289 last-command-event
3290 (get last-command-event 'ascii-character)))
3292 (cond ((integerp arg)
3293 (setq prefix-arg (+ (* arg 10)
3294 (if (< arg 0) (- digit) digit))))
3295 ((eq arg '-)
3296 ;; Treat -0 as just -, so that -01 will work.
3297 (setq prefix-arg (if (zerop digit) '- (- digit))))
3298 (t
3299 (setq prefix-arg digit))))
3300 (setq universal-argument-num-events (length (this-command-keys)))
3301 (save&set-overriding-map universal-argument-map))
3303 ;; For backward compatibility, minus with no modifiers is an ordinary
3304 ;; command if digits have already been entered.
3305 (defun universal-argument-minus (arg)
3306 (interactive "P")
3307 (if (integerp arg)
3308 (universal-argument-other-key arg)
3309 (negative-argument arg)))
3311 ;; Anything else terminates the argument and is left in the queue to be
3312 ;; executed as a command.
3313 (defun universal-argument-other-key (arg)
3314 (interactive "P")
3315 (setq prefix-arg arg)
3316 (let* ((key (this-command-keys))
3317 (keylist (listify-key-sequence key)))
3318 (setq unread-command-events
3319 (append (nthcdr universal-argument-num-events keylist)
3320 unread-command-events)))
3321 (reset-this-command-lengths)
3322 (restore-overriding-map))
3323 \f
3325 (defvar filter-buffer-substring-functions nil
3326 "This variable is a wrapper hook around `filter-buffer-substring'.")
3327 (make-obsolete-variable 'filter-buffer-substring-functions
3328 'filter-buffer-substring-function "24.4")
3330 (defvar filter-buffer-substring-function #'buffer-substring--filter
3331 "Function to perform the filtering in `filter-buffer-substring'.
3332 The function is called with 3 arguments:
3333 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3334 as those of `filter-buffer-substring' in each case.
3335 It should return the buffer substring between BEG and END, after filtering.")
3337 (defvar buffer-substring-filters nil
3338 "List of filter functions for `filter-buffer-substring'.
3339 Each function must accept a single argument, a string, and return
3340 a string. The buffer substring is passed to the first function
3341 in the list, and the return value of each function is passed to
3342 the next.
3343 As a special convention, point is set to the start of the buffer text
3344 being operated on (i.e., the first argument of `filter-buffer-substring')
3345 before these functions are called.")
3346 (make-obsolete-variable 'buffer-substring-filters
3347 'filter-buffer-substring-function "24.1")
3349 (defun filter-buffer-substring (beg end &optional delete)
3350 "Return the buffer substring between BEG and END, after filtering.
3351 The hook `filter-buffer-substring-function' performs the actual filtering.
3352 By default, no filtering is done.
3354 If DELETE is non-nil, the text between BEG and END is deleted
3355 from the buffer.
3357 This function should be used instead of `buffer-substring',
3358 `buffer-substring-no-properties', or `delete-and-extract-region'
3359 when you want to allow filtering to take place. For example,
3360 major or minor modes can use `filter-buffer-substring-function' to
3361 extract characters that are special to a buffer, and should not
3362 be copied into other buffers."
3363 (funcall filter-buffer-substring-function beg end delete))
3365 (defun buffer-substring--filter (beg end &optional delete)
3366 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3367 (cond
3368 ((or delete buffer-substring-filters)
3369 (save-excursion
3370 (goto-char beg)
3371 (let ((string (if delete (delete-and-extract-region beg end)
3372 (buffer-substring beg end))))
3373 (dolist (filter buffer-substring-filters)
3374 (setq string (funcall filter string)))
3375 string)))
3376 (t
3377 (buffer-substring beg end)))))
3380 ;;;; Window system cut and paste hooks.
3382 (defvar interprogram-cut-function nil
3383 "Function to call to make a killed region available to other programs.
3384 Most window systems provide a facility for cutting and pasting
3385 text between different programs, such as the clipboard on X and
3386 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3388 This variable holds a function that Emacs calls whenever text is
3389 put in the kill ring, to make the new kill available to other
3390 programs. The function takes one argument, TEXT, which is a
3391 string containing the text which should be made available.")
3393 (defvar interprogram-paste-function nil
3394 "Function to call to get text cut from other programs.
3395 Most window systems provide a facility for cutting and pasting
3396 text between different programs, such as the clipboard on X and
3397 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3399 This variable holds a function that Emacs calls to obtain text
3400 that other programs have provided for pasting. The function is
3401 called with no arguments. If no other program has provided text
3402 to paste, the function should return nil (in which case the
3403 caller, usually `current-kill', should use the top of the Emacs
3404 kill ring). If another program has provided text to paste, the
3405 function should return that text as a string (in which case the
3406 caller should put this string in the kill ring as the latest
3407 kill).
3409 The function may also return a list of strings if the window
3410 system supports multiple selections. The first string will be
3411 used as the pasted text, but the other will be placed in the kill
3412 ring for easy access via `yank-pop'.
3414 Note that the function should return a string only if a program
3415 other than Emacs has provided a string for pasting; if Emacs
3416 provided the most recent string, the function should return nil.
3417 If it is difficult to tell whether Emacs or some other program
3418 provided the current string, it is probably good enough to return
3419 nil if the string is equal (according to `string=') to the last
3420 text Emacs provided.")
3421 \f
3424 ;;;; The kill ring data structure.
3426 (defvar kill-ring nil
3427 "List of killed text sequences.
3428 Since the kill ring is supposed to interact nicely with cut-and-paste
3429 facilities offered by window systems, use of this variable should
3430 interact nicely with `interprogram-cut-function' and
3431 `interprogram-paste-function'. The functions `kill-new',
3432 `kill-append', and `current-kill' are supposed to implement this
3433 interaction; you may want to use them instead of manipulating the kill
3434 ring directly.")
3436 (defcustom kill-ring-max 60
3437 "Maximum length of kill ring before oldest elements are thrown away."
3438 :type 'integer
3439 :group 'killing)
3441 (defvar kill-ring-yank-pointer nil
3442 "The tail of the kill ring whose car is the last thing yanked.")
3444 (defcustom save-interprogram-paste-before-kill nil
3445 "Save clipboard strings into kill ring before replacing them.
3446 When one selects something in another program to paste it into Emacs,
3447 but kills something in Emacs before actually pasting it,
3448 this selection is gone unless this variable is non-nil,
3449 in which case the other program's selection is saved in the `kill-ring'
3451 :type 'boolean
3452 :group 'killing
3453 :version "23.2")
3455 (defcustom kill-do-not-save-duplicates nil
3456 "Do not add a new string to `kill-ring' if it duplicates the last one.
3457 The comparison is done using `equal-including-properties'."
3458 :type 'boolean
3459 :group 'killing
3460 :version "23.2")
3462 (defun kill-new (string &optional replace yank-handler)
3463 "Make STRING the latest kill in the kill ring.
3464 Set `kill-ring-yank-pointer' to point to it.
3465 If `interprogram-cut-function' is non-nil, apply it to STRING.
3466 Optional second argument REPLACE non-nil means that STRING will replace
3467 the front of the kill ring, rather than being added to the list.
3469 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3470 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3471 STRING.
3473 When the yank handler has a non-nil PARAM element, the original STRING
3474 argument is not used by `insert-for-yank'. However, since Lisp code
3475 may access and use elements from the kill ring directly, the STRING
3477 (if (> (length string) 0)
3478 (if yank-handler
3479 (put-text-property 0 (length string)
3480 'yank-handler yank-handler string))
3481 (if yank-handler
3482 (signal 'args-out-of-range
3483 (list string "yank-handler specified for empty string"))))
3484 (unless (and kill-do-not-save-duplicates
3485 ;; Due to text properties such as 'yank-handler that
3486 ;; can alter the contents to yank, comparison using
3487 ;; `equal' is unsafe.
3488 (equal-including-properties string (car kill-ring)))
3489 (if (fboundp 'menu-bar-update-yank-menu)
3490 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3491 (when save-interprogram-paste-before-kill
3492 (let ((interprogram-paste (and interprogram-paste-function
3493 (funcall interprogram-paste-function))))
3494 (when interprogram-paste
3495 (dolist (s (if (listp interprogram-paste)
3496 (nreverse interprogram-paste)
3497 (list interprogram-paste)))
3498 (unless (and kill-do-not-save-duplicates
3499 (equal-including-properties s (car kill-ring)))
3500 (push s kill-ring))))))
3501 (unless (and kill-do-not-save-duplicates
3502 (equal-including-properties string (car kill-ring)))
3503 (if (and replace kill-ring)
3504 (setcar kill-ring string)
3505 (push string kill-ring)
3506 (if (> (length kill-ring) kill-ring-max)
3507 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3508 (setq kill-ring-yank-pointer kill-ring)
3509 (if interprogram-cut-function
3510 (funcall interprogram-cut-function string)))
3511 (set-advertised-calling-convention
3512 'kill-new '(string &optional replace) "23.3")
3514 (defun kill-append (string before-p &optional yank-handler)
3515 "Append STRING to the end of the latest kill in the kill ring.
3516 If BEFORE-P is non-nil, prepend STRING to the kill.
3517 If `interprogram-cut-function' is set, pass the resulting kill to it."
3518 (let* ((cur (car kill-ring)))
3519 (kill-new (if before-p (concat string cur) (concat cur string))
3520 (or (= (length cur) 0)
3521 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3522 yank-handler)))
3523 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3525 (defcustom yank-pop-change-selection nil
3526 "Whether rotating the kill ring changes the window system selection.
3527 If non-nil, whenever the kill ring is rotated (usually via the
3528 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3529 to copy the new kill to the window system selection."
3530 :type 'boolean
3531 :group 'killing
3532 :version "23.1")
3534 (defun current-kill (n &optional do-not-move)
3535 "Rotate the yanking point by N places, and then return that kill.
3536 If N is zero and `interprogram-paste-function' is set to a
3537 function that returns a string or a list of strings, and if that
3538 function doesn't return nil, then that string (or list) is added
3539 to the front of the kill ring and the string (or first string in
3540 the list) is returned as the latest kill.
3542 If N is not zero, and if `yank-pop-change-selection' is
3543 non-nil, use `interprogram-cut-function' to transfer the
3544 kill at the new yank point into the window system selection.
3546 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3547 move the yanking point; just return the Nth kill forward."
3549 (let ((interprogram-paste (and (= n 0)
3550 interprogram-paste-function
3551 (funcall interprogram-paste-function))))
3552 (if interprogram-paste
3553 (progn
3554 ;; Disable the interprogram cut function when we add the new
3555 ;; text to the kill ring, so Emacs doesn't try to own the
3556 ;; selection, with identical text.
3557 (let ((interprogram-cut-function nil))
3558 (if (listp interprogram-paste)
3559 (mapc 'kill-new (nreverse interprogram-paste))
3560 (kill-new interprogram-paste)))
3561 (car kill-ring))
3562 (or kill-ring (error "Kill ring is empty"))
3563 (let ((ARGth-kill-element
3564 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3565 (length kill-ring))
3566 kill-ring)))
3567 (unless do-not-move
3568 (setq kill-ring-yank-pointer ARGth-kill-element)
3569 (when (and yank-pop-change-selection
3570 (> n 0)
3571 interprogram-cut-function)
3572 (funcall interprogram-cut-function (car ARGth-kill-element))))
3573 (car ARGth-kill-element)))))
3577 ;;;; Commands for manipulating the kill ring.
3579 (defcustom kill-read-only-ok nil
3580 "Non-nil means don't signal an error for killing read-only text."
3581 :type 'boolean
3582 :group 'killing)
3584 (defun kill-region (beg end &optional yank-handler)
3586 This deletes the text from the buffer and saves it in the kill ring.
3590 If you want to append the killed region to the last killed text,
3593 If the buffer is read-only, Emacs will beep and refrain from deleting
3594 the text, but put the text in the kill ring anyway. This means that
3595 you can use the killing commands to copy text from a read-only buffer.
3597 Lisp programs should use this function for killing text.
3598 (To delete text, use `delete-region'.)
3599 Supply two arguments, character positions indicating the stretch of text
3600 to be killed.
3602 If the previous command was also a kill command,
3603 the text killed this time appends to the text killed last time
3604 to make one entry in the kill ring."
3605 ;; Pass point first, then mark, because the order matters
3606 ;; when calling kill-append.
3607 (interactive (list (point) (mark)))
3608 (unless (and beg end)
3609 (error "The mark is not set now, so there is no region"))
3610 (condition-case nil
3611 (let ((string (filter-buffer-substring beg end t)))
3612 (when string ;STRING is nil if BEG = END
3613 ;; Add that string to the kill ring, one way or another.
3614 (if (eq last-command 'kill-region)
3615 (kill-append string (< end beg) yank-handler)
3616 (kill-new string nil yank-handler)))
3617 (when (or string (eq last-command 'kill-region))
3618 (setq this-command 'kill-region))
3619 (setq deactivate-mark t)
3620 nil)
3621 ((buffer-read-only text-read-only)
3622 ;; The code above failed because the buffer, or some of the characters
3623 ;; in the region, are read-only.
3624 ;; We should beep, in case the user just isn't aware of this.
3625 ;; However, there's no harm in putting
3626 ;; the region's text in the kill ring, anyway.
3627 (copy-region-as-kill beg end)
3628 ;; Set this-command now, so it will be set even if we get an error.
3629 (setq this-command 'kill-region)
3630 ;; This should barf, if appropriate, and give us the correct error.
3631 (if kill-read-only-ok
3632 (progn (message "Read only text copied to kill ring") nil)
3633 ;; Signal an error if the buffer is read-only.
3634 (barf-if-buffer-read-only)
3635 ;; If the buffer isn't read-only, the text is.
3636 (signal 'text-read-only (list (current-buffer)))))))
3637 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3639 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3640 ;; to get two copies of the text when the user accidentally types M-w and
3641 ;; then corrects it with the intended C-w.
3642 (defun copy-region-as-kill (beg end)
3643 "Save the region as if killed, but don't kill it.
3644 In Transient Mark mode, deactivate the mark.
3645 If `interprogram-cut-function' is non-nil, also save the text for a window
3646 system cut and paste.
3648 This command's old key binding has been given to `kill-ring-save'."
3649 (interactive "r")
3650 (if (eq last-command 'kill-region)
3651 (kill-append (filter-buffer-substring beg end) (< end beg))
3652 (kill-new (filter-buffer-substring beg end)))
3653 (setq deactivate-mark t)
3654 nil)
3656 (defun kill-ring-save (beg end)
3657 "Save the region as if killed, but don't kill it.
3658 In Transient Mark mode, deactivate the mark.
3659 If `interprogram-cut-function' is non-nil, also save the text for a window
3660 system cut and paste.
3662 If you want to append the killed line to the last killed text,
3665 This command is similar to `copy-region-as-kill', except that it gives
3666 visual feedback indicating the extent of the region being copied."
3667 (interactive "r")
3668 (copy-region-as-kill beg end)
3669 ;; This use of called-interactively-p is correct because the code it
3670 ;; controls just gives the user visual feedback.
3671 (if (called-interactively-p 'interactive)
3672 (indicate-copied-region)))
3674 (defun indicate-copied-region (&optional message-len)
3675 "Indicate that the region text has been copied interactively.
3676 If the mark is visible in the selected window, blink the cursor
3677 between point and mark if there is currently no active region
3678 highlighting.
3680 If the mark lies outside the selected window, display an
3681 informative message containing a sample of the copied text. The
3682 optional argument MESSAGE-LEN, if non-nil, specifies the length
3683 of this sample text; it defaults to 40."
3684 (let ((mark (mark t))
3685 (point (point))
3686 ;; Inhibit quitting so we can make a quit here
3687 ;; look like a C-g typed as a command.
3688 (inhibit-quit t))
3689 (if (pos-visible-in-window-p mark (selected-window))
3690 ;; Swap point-and-mark quickly so as to show the region that
3691 ;; was selected. Don't do it if the region is highlighted.
3692 (unless (and (region-active-p)
3693 (face-background 'region))
3694 ;; Swap point and mark.
3695 (set-marker (mark-marker) (point) (current-buffer))
3696 (goto-char mark)
3697 (sit-for blink-matching-delay)
3698 ;; Swap back.
3699 (set-marker (mark-marker) mark (current-buffer))
3700 (goto-char point)
3701 ;; If user quit, deactivate the mark
3702 ;; as C-g would as a command.
3703 (and quit-flag mark-active
3704 (deactivate-mark)))
3705 (let ((len (min (abs (- mark point))
3706 (or message-len 40))))
3707 (if (< point mark)
3708 ;; Don't say "killed"; that is misleading.
3710 (buffer-substring-no-properties (- mark len) mark))
3712 (buffer-substring-no-properties mark (+ mark len))))))))
3714 (defun append-next-kill (&optional interactive)
3715 "Cause following command, if it kills, to append to previous kill.
3716 The argument is used for internal purposes; do not supply one."
3717 (interactive "p")
3718 ;; We don't use (interactive-p), since that breaks kbd macros.
3719 (if interactive
3720 (progn
3721 (setq this-command 'kill-region)
3722 (message "If the next command is a kill, it will append"))
3723 (setq last-command 'kill-region)))
3724 \f
3725 ;; Yanking.
3727 (defcustom yank-handled-properties
3728 '((font-lock-face . yank-handle-font-lock-face-property)
3729 (category . yank-handle-category-property))
3730 "List of special text property handling conditions for yanking.
3731 Each element should have the form (PROP . FUN), where PROP is a
3732 property symbol and FUN is a function. When the `yank' command
3733 inserts text into the buffer, it scans the inserted text for
3734 stretches of text that have `eq' values of the text property
3735 PROP; for each such stretch of text, FUN is called with three
3736 arguments: the property's value in that text, and the start and
3737 end positions of the text.
3739 This is done prior to removing the properties specified by
3740 `yank-excluded-properties'."
3741 :group 'killing
3742 :version "24.3")
3744 ;; This is actually used in subr.el but defcustom does not work there.
3745 (defcustom yank-excluded-properties
3746 '(category field follow-link fontified font-lock-face help-echo
3747 intangible invisible keymap local-map mouse-face read-only
3748 yank-handler)
3749 "Text properties to discard when yanking.
3750 The value should be a list of text properties to discard or t,
3751 which means to discard all text properties.
3753 See also `yank-handled-properties'."
3754 :type '(choice (const :tag "All" t) (repeat symbol))
3755 :group 'killing
3756 :version "24.3")
3758 (defvar yank-window-start nil)
3759 (defvar yank-undo-function nil
3760 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3761 Function is called with two parameters, START and END corresponding to
3762 the value of the mark and point; it is guaranteed that START <= END.
3763 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3765 (defun yank-pop (&optional arg)
3766 "Replace just-yanked stretch of killed text with a different stretch.
3767 This command is allowed only immediately after a `yank' or a `yank-pop'.
3768 At such a time, the region contains a stretch of reinserted
3769 previously-killed text. `yank-pop' deletes that text and inserts in its
3770 place a different stretch of killed text.
3772 With no argument, the previous kill is inserted.
3773 With argument N, insert the Nth previous kill.
3774 If N is negative, this is a more recent kill.
3776 The sequence of kills wraps around, so that after the oldest one
3777 comes the newest one.
3779 When this command inserts killed text into the buffer, it honors
3780 `yank-excluded-properties' and `yank-handler' as described in the
3781 doc string for `insert-for-yank-1', which see."
3782 (interactive "*p")
3783 (if (not (eq last-command 'yank))
3784 (error "Previous command was not a yank"))
3785 (setq this-command 'yank)
3786 (unless arg (setq arg 1))
3787 (let ((inhibit-read-only t)
3788 (before (< (point) (mark t))))
3789 (if before
3790 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3791 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3792 (setq yank-undo-function nil)
3793 (set-marker (mark-marker) (point) (current-buffer))
3794 (insert-for-yank (current-kill arg))
3795 ;; Set the window start back where it was in the yank command,
3796 ;; if possible.
3797 (set-window-start (selected-window) yank-window-start t)
3798 (if before
3799 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3800 ;; It is cleaner to avoid activation, even though the command
3801 ;; loop would deactivate the mark because we inserted text.
3802 (goto-char (prog1 (mark t)
3803 (set-marker (mark-marker) (point) (current-buffer))))))
3804 nil)
3806 (defun yank (&optional arg)
3808 More precisely, reinsert the most recent kill, which is the
3809 stretch of killed text most recently killed OR yanked. Put point
3810 at the end, and set mark at the beginning without activating it.
3812 With argument N, reinsert the Nth most recent kill.
3814 When this command inserts text into the buffer, it honors the
3815 `yank-handled-properties' and `yank-excluded-properties'
3816 variables, and the `yank-handler' text property. See
3817 `insert-for-yank-1' for details.
3820 (interactive "*P")
3821 (setq yank-window-start (window-start))
3822 ;; If we don't get all the way thru, make last-command indicate that
3823 ;; for the following command.
3824 (setq this-command t)
3825 (push-mark (point))
3826 (insert-for-yank (current-kill (cond
3827 ((listp arg) 0)
3828 ((eq arg '-) -2)
3829 (t (1- arg)))))
3830 (if (consp arg)
3831 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3832 ;; It is cleaner to avoid activation, even though the command
3833 ;; loop would deactivate the mark because we inserted text.
3834 (goto-char (prog1 (mark t)
3835 (set-marker (mark-marker) (point) (current-buffer)))))
3836 ;; If we do get all the way thru, make this-command indicate that.
3837 (if (eq this-command t)
3838 (setq this-command 'yank))
3839 nil)
3841 (defun rotate-yank-pointer (arg)
3842 "Rotate the yanking point in the kill ring.
3843 With ARG, rotate that many kills forward (or backward, if negative)."
3844 (interactive "p")
3845 (current-kill arg))
3846 \f
3847 ;; Some kill commands.
3849 ;; Internal subroutine of delete-char
3850 (defun kill-forward-chars (arg)
3851 (if (listp arg) (setq arg (car arg)))
3852 (if (eq arg '-) (setq arg -1))
3853 (kill-region (point) (+ (point) arg)))
3855 ;; Internal subroutine of backward-delete-char
3856 (defun kill-backward-chars (arg)
3857 (if (listp arg) (setq arg (car arg)))
3858 (if (eq arg '-) (setq arg -1))
3859 (kill-region (point) (- (point) arg)))
3861 (defcustom backward-delete-char-untabify-method 'untabify
3862 "The method for untabifying when deleting backward.
3863 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3864 `hungry' -- delete all whitespace, both tabs and spaces;
3865 `all' -- delete all whitespace, including tabs, spaces and newlines;
3866 nil -- just delete one character."
3867 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3868 :version "20.3"
3869 :group 'killing)
3871 (defun backward-delete-char-untabify (arg &optional killp)
3872 "Delete characters backward, changing tabs into spaces.
3873 The exact behavior depends on `backward-delete-char-untabify-method'.
3874 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3875 Interactively, ARG is the prefix arg (default 1)
3876 and KILLP is t if a prefix arg was specified."
3878 (when (eq backward-delete-char-untabify-method 'untabify)
3879 (let ((count arg))
3880 (save-excursion
3881 (while (and (> count 0) (not (bobp)))
3883 (let ((col (current-column)))
3884 (forward-char -1)
3885 (setq col (- col (current-column)))
3886 (insert-char ?\s col)
3887 (delete-char 1)))
3888 (forward-char -1)
3889 (setq count (1- count))))))
3891 ((eq backward-delete-char-untabify-method 'all)
3893 (n (if skip
3894 (let* ((oldpt (point))
3895 (wh (- oldpt (save-excursion
3896 (skip-chars-backward skip)
3897 (constrain-to-field nil oldpt)))))
3898 (+ arg (if (zerop wh) 0 (1- wh))))
3899 arg)))
3900 ;; Avoid warning about delete-backward-char
3901 (with-no-warnings (delete-backward-char n killp))))
3903 (defun zap-to-char (arg char)
3904 "Kill up to and including ARGth occurrence of CHAR.
3905 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3906 Goes backward if ARG is negative; error if CHAR not found."
3907 (interactive (list (prefix-numeric-value current-prefix-arg)
3908 (read-char "Zap to char: " t)))
3909 ;; Avoid "obsolete" warnings for translation-table-for-input.
3910 (with-no-warnings
3911 (if (char-table-p translation-table-for-input)
3912 (setq char (or (aref translation-table-for-input char) char))))
3913 (kill-region (point) (progn
3914 (search-forward (char-to-string char) nil nil arg)
3915 (point))))
3917 ;; kill-line and its subroutines.
3919 (defcustom kill-whole-line nil
3920 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3921 :type 'boolean
3922 :group 'killing)
3924 (defun kill-line (&optional arg)
3925 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3926 With prefix argument ARG, kill that many lines from point.
3927 Negative arguments kill lines backward.
3928 With zero argument, kills the text before point on the current line.
3931 a number counts as a prefix arg.
3933 To kill a whole line, when point is not at the beginning, type \
3936 If `show-trailing-whitespace' is non-nil, this command will just
3937 kill the rest of the current line, even if there are only
3938 nonblanks there.
3940 If option `kill-whole-line' is non-nil, then this command kills the whole line
3941 including its terminating newline, when used at the beginning of a line
3942 with no argument. As a consequence, you can always kill a whole line
3945 If you want to append the killed line to the last killed text,
3948 If the buffer is read-only, Emacs will beep and refrain from deleting
3949 the line, but put the line in the kill ring anyway. This means that
3950 you can use this command to copy text from a read-only buffer.
3951 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3952 even beep.)"
3953 (interactive "P")
3954 (kill-region (point)
3955 ;; It is better to move point to the other end of the kill
3956 ;; before killing. That way, in a read-only buffer, point
3957 ;; moves across the text that is copied to the kill ring.
3958 ;; The choice has no effect on undo now that undo records
3959 ;; the value of point from before the command was run.
3960 (progn
3961 (if arg
3962 (forward-visible-line (prefix-numeric-value arg))
3963 (if (eobp)
3964 (signal 'end-of-buffer nil))
3965 (let ((end
3966 (save-excursion
3967 (end-of-visible-line) (point))))
3968 (if (or (save-excursion
3969 ;; If trailing whitespace is visible,
3970 ;; don't treat it as nothing.
3971 (unless show-trailing-whitespace
3973 (= (point) end))
3974 (and kill-whole-line (bolp)))
3975 (forward-visible-line 1)
3976 (goto-char end))))
3977 (point))))
3979 (defun kill-whole-line (&optional arg)
3980 "Kill current line.
3981 With prefix ARG, kill that many lines starting from the current line.
3982 If ARG is negative, kill backward. Also kill the preceding newline.
3984 If ARG is zero, kill current line but exclude the trailing newline."
3985 (interactive "p")
3986 (or arg (setq arg 1))
3987 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3988 (signal 'end-of-buffer nil))
3989 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3990 (signal 'beginning-of-buffer nil))
3991 (unless (eq last-command 'kill-region)
3992 (kill-new "")
3993 (setq last-command 'kill-region))
3994 (cond ((zerop arg)
3995 ;; We need to kill in two steps, because the previous command
3996 ;; could have been a kill command, in which case the text
3997 ;; before point needs to be prepended to the current kill
3998 ;; ring entry and the text after point appended. Also, we
3999 ;; need to use save-excursion to avoid copying the same text
4000 ;; twice to the kill ring in read-only buffers.
4001 (save-excursion
4002 (kill-region (point) (progn (forward-visible-line 0) (point))))
4003 (kill-region (point) (progn (end-of-visible-line) (point))))
4004 ((< arg 0)
4005 (save-excursion
4006 (kill-region (point) (progn (end-of-visible-line) (point))))
4007 (kill-region (point)
4008 (progn (forward-visible-line (1+ arg))
4009 (unless (bobp) (backward-char))
4010 (point))))
4011 (t
4012 (save-excursion
4013 (kill-region (point) (progn (forward-visible-line 0) (point))))
4014 (kill-region (point)
4015 (progn (forward-visible-line arg) (point))))))
4017 (defun forward-visible-line (arg)
4018 "Move forward by ARG lines, ignoring currently invisible newlines only.
4019 If ARG is negative, move backward -ARG lines.
4020 If ARG is zero, move to the beginning of the current line."
4021 (condition-case nil
4022 (if (> arg 0)
4023 (progn
4024 (while (> arg 0)
4025 (or (zerop (forward-line 1))
4026 (signal 'end-of-buffer nil))
4027 ;; If the newline we just skipped is invisible,
4028 ;; don't count it.
4029 (let ((prop
4030 (get-char-property (1- (point)) 'invisible)))
4031 (if (if (eq buffer-invisibility-spec t)
4032 prop
4033 (or (memq prop buffer-invisibility-spec)
4034 (assq prop buffer-invisibility-spec)))
4035 (setq arg (1+ arg))))
4036 (setq arg (1- arg)))
4037 ;; If invisible text follows, and it is a number of complete lines,
4038 ;; skip it.
4039 (let ((opoint (point)))
4040 (while (and (not (eobp))
4041 (let ((prop
4042 (get-char-property (point) 'invisible)))
4043 (if (eq buffer-invisibility-spec t)
4044 prop
4045 (or (memq prop buffer-invisibility-spec)
4046 (assq prop buffer-invisibility-spec)))))
4047 (goto-char
4048 (if (get-text-property (point) 'invisible)
4049 (or (next-single-property-change (point) 'invisible)
4050 (point-max))
4051 (next-overlay-change (point)))))
4052 (unless (bolp)
4053 (goto-char opoint))))
4054 (let ((first t))
4055 (while (or first (<= arg 0))
4056 (if first
4057 (beginning-of-line)
4058 (or (zerop (forward-line -1))
4059 (signal 'beginning-of-buffer nil)))
4060 ;; If the newline we just moved to is invisible,
4061 ;; don't count it.
4062 (unless (bobp)
4063 (let ((prop
4064 (get-char-property (1- (point)) 'invisible)))
4065 (unless (if (eq buffer-invisibility-spec t)
4066 prop
4067 (or (memq prop buffer-invisibility-spec)
4068 (assq prop buffer-invisibility-spec)))
4069 (setq arg (1+ arg)))))
4070 (setq first nil))
4071 ;; If invisible text follows, and it is a number of complete lines,
4072 ;; skip it.
4073 (let ((opoint (point)))
4074 (while (and (not (bobp))
4075 (let ((prop
4076 (get-char-property (1- (point)) 'invisible)))
4077 (if (eq buffer-invisibility-spec t)
4078 prop
4079 (or (memq prop buffer-invisibility-spec)
4080 (assq prop buffer-invisibility-spec)))))
4081 (goto-char
4082 (if (get-text-property (1- (point)) 'invisible)
4083 (or (previous-single-property-change (point) 'invisible)
4084 (point-min))
4085 (previous-overlay-change (point)))))
4086 (unless (bolp)
4087 (goto-char opoint)))))
4088 ((beginning-of-buffer end-of-buffer)
4089 nil)))
4091 (defun end-of-visible-line ()
4092 "Move to end of current visible line."
4093 (end-of-line)
4094 ;; If the following character is currently invisible,
4095 ;; skip all characters with that same `invisible' property value,
4096 ;; then find the next newline.
4097 (while (and (not (eobp))
4098 (save-excursion
4100 (let ((prop
4101 (get-char-property (point) 'invisible)))
4102 (if (eq buffer-invisibility-spec t)
4103 prop
4104 (or (memq prop buffer-invisibility-spec)
4105 (assq prop buffer-invisibility-spec))))))
4107 (if (get-text-property (point) 'invisible)
4108 (goto-char (or (next-single-property-change (point) 'invisible)
4109 (point-max)))
4110 (goto-char (next-overlay-change (point))))
4111 (end-of-line)))
4112 \f
4113 (defun insert-buffer (buffer)
4114 "Insert after point the contents of BUFFER.
4115 Puts mark after the inserted text.
4116 BUFFER may be a buffer or a buffer name.
4118 This function is meant for the user to run interactively.
4119 Don't call it from programs: use `insert-buffer-substring' instead!"
4120 (interactive
4121 (list
4122 (progn
4123 (barf-if-buffer-read-only)
4124 (read-buffer "Insert buffer: "
4125 (if (eq (selected-window) (next-window (selected-window)))
4126 (other-buffer (current-buffer))
4127 (window-buffer (next-window (selected-window))))
4128 t))))
4129 (push-mark
4130 (save-excursion
4131 (insert-buffer-substring (get-buffer buffer))
4132 (point)))
4133 nil)
4135 (defun append-to-buffer (buffer start end)
4136 "Append to specified buffer the text of the region.
4137 It is inserted into that buffer before its point.
4139 When calling from a program, give three arguments:
4140 BUFFER (or buffer name), START and END.
4141 START and END specify the portion of the current buffer to be copied."
4142 (interactive
4143 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4144 (region-beginning) (region-end)))
4145 (let* ((oldbuf (current-buffer))
4146 (append-to (get-buffer-create buffer))
4147 (windows (get-buffer-window-list append-to t t))
4148 point)
4149 (save-excursion
4150 (with-current-buffer append-to
4151 (setq point (point))
4152 (barf-if-buffer-read-only)
4153 (insert-buffer-substring oldbuf start end)
4154 (dolist (window windows)
4155 (when (= (window-point window) point)
4156 (set-window-point window (point))))))))
4158 (defun prepend-to-buffer (buffer start end)
4159 "Prepend to specified buffer the text of the region.
4160 It is inserted into that buffer after its point.
4162 When calling from a program, give three arguments:
4163 BUFFER (or buffer name), START and END.
4164 START and END specify the portion of the current buffer to be copied."
4166 (let ((oldbuf (current-buffer)))
4167 (with-current-buffer (get-buffer-create buffer)
4168 (barf-if-buffer-read-only)
4169 (save-excursion
4170 (insert-buffer-substring oldbuf start end)))))
4172 (defun copy-to-buffer (buffer start end)
4173 "Copy to specified buffer the text of the region.
4174 It is inserted into that buffer, replacing existing text there.
4176 When calling from a program, give three arguments:
4177 BUFFER (or buffer name), START and END.
4178 START and END specify the portion of the current buffer to be copied."
4180 (let ((oldbuf (current-buffer)))
4181 (with-current-buffer (get-buffer-create buffer)
4182 (barf-if-buffer-read-only)
4183 (erase-buffer)
4184 (save-excursion
4185 (insert-buffer-substring oldbuf start end)))))
4186 \f
4187 (put 'mark-inactive 'error-conditions '(mark-inactive error))
4188 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
4190 (defvar activate-mark-hook nil
4191 "Hook run when the mark becomes active.
4192 It is also run at the end of a command, if the mark is active and
4193 it is possible that the region may have changed.")
4195 (defvar deactivate-mark-hook nil
4196 "Hook run when the mark becomes inactive.")
4198 (defun mark (&optional force)
4199 "Return this buffer's mark value as integer, or nil if never set.
4201 In Transient Mark mode, this function signals an error if
4202 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4203 or the argument FORCE is non-nil, it disregards whether the mark
4204 is active, and returns an integer or nil in the usual way.
4206 If you are using this in an editing command, you are most likely making
4207 a mistake; see the documentation of `set-mark'."
4208 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4209 (marker-position (mark-marker))
4210 (signal 'mark-inactive nil)))
4212 (defun deactivate-mark (&optional force)
4213 "Deactivate the mark.
4214 If Transient Mark mode is disabled, this function normally does
4215 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4217 Deactivating the mark sets `mark-active' to nil, updates the
4218 primary selection according to `select-active-regions', and runs
4219 `deactivate-mark-hook'.
4221 If Transient Mark mode was temporarily enabled, reset the value
4222 of the variable `transient-mark-mode'; if this causes Transient
4223 Mark mode to be disabled, don't change `mark-active' to nil or
4224 run `deactivate-mark-hook'."
4225 (when (or transient-mark-mode force)
4226 (when (and (if (eq select-active-regions 'only)
4227 (eq (car-safe transient-mark-mode) 'only)
4228 select-active-regions)
4229 (region-active-p)
4230 (display-selections-p))
4231 ;; The var `saved-region-selection', if non-nil, is the text in
4232 ;; the region prior to the last command modifying the buffer.
4233 ;; Set the selection to that, or to the current region.
4234 (cond (saved-region-selection
4235 (x-set-selection 'PRIMARY saved-region-selection)
4236 (setq saved-region-selection nil))
4237 ;; If another program has acquired the selection, region
4238 ;; deactivation should not clobber it (Bug#11772).
4239 ((and (/= (region-beginning) (region-end))
4240 (or (x-selection-owner-p 'PRIMARY)
4241 (null (x-selection-exists-p 'PRIMARY))))
4242 (x-set-selection 'PRIMARY
4243 (buffer-substring (region-beginning)
4244 (region-end))))))
4245 (if (and (null force)
4246 (or (eq transient-mark-mode 'lambda)
4247 (and (eq (car-safe transient-mark-mode) 'only)
4248 (null (cdr transient-mark-mode)))))
4249 ;; When deactivating a temporary region, don't change
4250 ;; `mark-active' or run `deactivate-mark-hook'.
4251 (setq transient-mark-mode nil)
4252 (if (eq (car-safe transient-mark-mode) 'only)
4253 (setq transient-mark-mode (cdr transient-mark-mode)))
4254 (setq mark-active nil)
4255 (run-hooks 'deactivate-mark-hook))))
4257 (defun activate-mark ()
4258 "Activate the mark."
4259 (when (mark t)
4260 (setq mark-active t)
4261 (unless transient-mark-mode
4262 (setq transient-mark-mode 'lambda))
4263 (run-hooks 'activate-mark-hook)))
4265 (defun set-mark (pos)
4266 "Set this buffer's mark to POS. Don't use this function!
4267 That is to say, don't use this function unless you want
4268 the user to see that the mark has moved, and you want the previous
4269 mark position to be lost.
4271 Normally, when a new mark is set, the old one should go on the stack.
4272 This is why most applications should use `push-mark', not `set-mark'.
4274 Novice Emacs Lisp programmers often try to use the mark for the wrong
4275 purposes. The mark saves a location for the user's convenience.
4276 Most editing commands should not alter the mark.
4277 To remember a location for internal use in the Lisp program,
4278 store it in a Lisp variable. Example:
4280 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4282 (if pos
4283 (progn
4284 (setq mark-active t)
4285 (run-hooks 'activate-mark-hook)
4286 (set-marker (mark-marker) pos (current-buffer)))
4287 ;; Normally we never clear mark-active except in Transient Mark mode.
4288 ;; But when we actually clear out the mark value too, we must
4289 ;; clear mark-active in any mode.
4290 (deactivate-mark t)
4291 (set-marker (mark-marker) nil)))
4293 (defcustom use-empty-active-region nil
4295 If nil, region-aware commands treat empty regions as inactive.
4296 If non-nil, region-aware commands treat the region as active as
4297 long as the mark is active, even if the region is empty.
4299 Region-aware commands are those that act on the region if it is
4300 active and Transient Mark mode is enabled, and on the text near
4301 point otherwise."
4302 :type 'boolean
4303 :version "23.1"
4304 :group 'editing-basics)
4306 (defun use-region-p ()
4307 "Return t if the region is active and it is appropriate to act on it.
4308 This is used by commands that act specially on the region under
4309 Transient Mark mode.
4311 The return value is t if Transient Mark mode is enabled and the
4312 mark is active; furthermore, if `use-empty-active-region' is nil,
4313 the region must not be empty. Otherwise, the return value is nil.
4315 For some commands, it may be appropriate to ignore the value of
4316 `use-empty-active-region'; in that case, use `region-active-p'."
4317 (and (region-active-p)
4318 (or use-empty-active-region (> (region-end) (region-beginning)))))
4320 (defun region-active-p ()
4321 "Return t if Transient Mark mode is enabled and the mark is active.
4323 Some commands act specially on the region when Transient Mark
4324 mode is enabled. Usually, such commands should use
4325 `use-region-p' instead of this function, because `use-region-p'
4326 also checks the value of `use-empty-active-region'."
4327 (and transient-mark-mode mark-active))
4329 (defvar mark-ring nil
4330 "The list of former marks of the current buffer, most recent first.")
4331 (make-variable-buffer-local 'mark-ring)
4332 (put 'mark-ring 'permanent-local t)
4334 (defcustom mark-ring-max 16
4335 "Maximum size of mark ring. Start discarding off end if gets this big."
4336 :type 'integer
4337 :group 'editing-basics)
4339 (defvar global-mark-ring nil
4340 "The list of saved global marks, most recent first.")
4342 (defcustom global-mark-ring-max 16
4343 "Maximum size of global mark ring. \
4344 Start discarding off end if gets this big."
4345 :type 'integer
4346 :group 'editing-basics)
4348 (defun pop-to-mark-command ()
4349 "Jump to mark, and pop a new position for mark off the ring.
4350 \(Does not affect global mark ring\)."
4351 (interactive)
4352 (if (null (mark t))
4353 (error "No mark set in this buffer")
4354 (if (= (point) (mark t))
4355 (message "Mark popped"))
4356 (goto-char (mark t))
4357 (pop-mark)))
4359 (defun push-mark-command (arg &optional nomsg)
4360 "Set mark at where point is.
4361 If no prefix ARG and mark is already set there, just activate it.
4362 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4363 (interactive "P")
4364 (let ((mark (marker-position (mark-marker))))
4365 (if (or arg (null mark) (/= mark (point)))
4366 (push-mark nil nomsg t)
4367 (setq mark-active t)
4368 (run-hooks 'activate-mark-hook)
4369 (unless nomsg
4370 (message "Mark activated")))))
4372 (defcustom set-mark-command-repeat-pop nil
4375 will pop the mark twice, and
4377 will pop the mark three times.
4381 :type 'boolean
4382 :group 'editing-basics)
4384 (defun set-mark-command (arg)
4385 "Set the mark where point is, or jump to the mark.
4386 Setting the mark also alters the region, which is the text
4387 between point and mark; this is the closest equivalent in
4390 With no prefix argument, set the mark at point, and push the
4391 old mark position on local mark ring. Also push the old mark on
4392 global mark ring, if the previous mark was set in another buffer.
4394 When Transient Mark Mode is off, immediately repeating this
4395 command activates `transient-mark-mode' temporarily.
4398 jump to the mark, and set the mark from
4399 position popped off the local mark ring \(this does not affect the global
4401 mark ring \(see `pop-global-mark'\).
4403 If `set-mark-command-repeat-pop' is non-nil, repeating
4405 off the local (or global) mark ring and jumps there.
4408 argument, unconditionally set mark where point is, even if
4409 `set-mark-command-repeat-pop' is non-nil.
4411 Novice Emacs Lisp programmers often try to use the mark for the wrong
4412 purposes. See the documentation of `set-mark' for more information."
4413 (interactive "P")
4414 (cond ((eq transient-mark-mode 'lambda)
4415 (setq transient-mark-mode nil))
4416 ((eq (car-safe transient-mark-mode) 'only)
4417 (deactivate-mark)))
4418 (cond
4419 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4420 (push-mark-command nil))
4421 ((not (eq this-command 'set-mark-command))
4422 (if arg
4423 (pop-to-mark-command)
4424 (push-mark-command t)))
4425 ((and set-mark-command-repeat-pop
4426 (eq last-command 'pop-to-mark-command))
4427 (setq this-command 'pop-to-mark-command)
4428 (pop-to-mark-command))
4429 ((and set-mark-command-repeat-pop
4430 (eq last-command 'pop-global-mark)
4431 (not arg))
4432 (setq this-command 'pop-global-mark)
4433 (pop-global-mark))
4434 (arg
4435 (setq this-command 'pop-to-mark-command)
4436 (pop-to-mark-command))
4437 ((eq last-command 'set-mark-command)
4438 (if (region-active-p)
4439 (progn
4440 (deactivate-mark)
4441 (message "Mark deactivated"))
4442 (activate-mark)
4443 (message "Mark activated")))
4444 (t
4445 (push-mark-command nil))))
4447 (defun push-mark (&optional location nomsg activate)
4448 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4449 If the last global mark pushed was not in the current buffer,
4450 also push LOCATION on the global mark ring.
4451 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4453 Novice Emacs Lisp programmers often try to use the mark for the wrong
4454 purposes. See the documentation of `set-mark' for more information.
4456 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4457 (unless (null (mark t))
4458 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4459 (when (> (length mark-ring) mark-ring-max)
4460 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4461 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4462 (set-marker (mark-marker) (or location (point)) (current-buffer))
4463 ;; Now push the mark on the global mark ring.
4464 (if (and global-mark-ring
4465 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4466 ;; The last global mark pushed was in this same buffer.
4467 ;; Don't push another one.
4468 nil
4469 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4470 (when (> (length global-mark-ring) global-mark-ring-max)
4471 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4472 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4473 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4474 (message "Mark set"))
4475 (if (or activate (not transient-mark-mode))
4476 (set-mark (mark t)))
4477 nil)
4479 (defun pop-mark ()
4480 "Pop off mark ring into the buffer's actual mark.
4481 Does not set point. Does nothing if mark ring is empty."
4482 (when mark-ring
4483 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4484 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4485 (move-marker (car mark-ring) nil)
4486 (if (null (mark t)) (ding))
4487 (setq mark-ring (cdr mark-ring)))
4488 (deactivate-mark))
4490 (define-obsolete-function-alias
4491 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4492 (defun exchange-point-and-mark (&optional arg)
4493 "Put the mark where point is now, and point where the mark is now.
4494 This command works even when the mark is not active,
4495 and it reactivates the mark.
4497 If Transient Mark mode is on, a prefix ARG deactivates the mark
4498 if it is active, and otherwise avoids reactivating it. If
4499 Transient Mark mode is off, a prefix ARG enables Transient Mark
4500 mode temporarily."
4501 (interactive "P")
4502 (let ((omark (mark t))
4503 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4504 (if (null omark)
4505 (error "No mark set in this buffer"))
4506 (deactivate-mark)
4507 (set-mark (point))
4508 (goto-char omark)
4509 (cond (temp-highlight
4510 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4511 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4512 (not (or arg (region-active-p))))
4513 (deactivate-mark))
4514 (t (activate-mark)))
4515 nil))
4517 (defcustom shift-select-mode t
4518 "When non-nil, shifted motion keys activate the mark momentarily.
4520 While the mark is activated in this way, any shift-translated point
4521 motion key extends the region, and if Transient Mark mode was off, it
4522 is temporarily turned on. Furthermore, the mark will be deactivated
4523 by any subsequent point motion key that was not shift-translated, or
4524 by any action that normally deactivates the mark in Transient Mark mode.
4526 See `this-command-keys-shift-translated' for the meaning of
4527 shift-translation."
4528 :type 'boolean
4529 :group 'editing-basics)
4531 (defun handle-shift-selection ()
4532 "Activate/deactivate mark depending on invocation thru shift translation.
4533 This function is called by `call-interactively' when a command
4534 with a `^' character in its `interactive' spec is invoked, before
4535 running the command itself.
4537 If `shift-select-mode' is enabled and the command was invoked
4538 through shift translation, set the mark and activate the region
4539 temporarily, unless it was already set in this way. See
4540 `this-command-keys-shift-translated' for the meaning of shift
4541 translation.
4543 Otherwise, if the region has been activated temporarily,
4544 deactivate it, and restore the variable `transient-mark-mode' to
4545 its earlier value."
4546 (cond ((and shift-select-mode this-command-keys-shift-translated)
4547 (unless (and mark-active
4548 (eq (car-safe transient-mark-mode) 'only))
4549 (setq transient-mark-mode
4550 (cons 'only
4551 (unless (eq transient-mark-mode 'lambda)
4552 transient-mark-mode)))
4553 (push-mark nil nil t)))
4554 ((eq (car-safe transient-mark-mode) 'only)
4555 (setq transient-mark-mode (cdr transient-mark-mode))
4556 (deactivate-mark))))
4558 (define-minor-mode transient-mark-mode
4559 "Toggle Transient Mark mode.
4560 With a prefix argument ARG, enable Transient Mark mode if ARG is
4561 positive, and disable it otherwise. If called from Lisp, enable
4562 Transient Mark mode if ARG is omitted or nil.
4564 Transient Mark mode is a global minor mode. When enabled, the
4565 region is highlighted whenever the mark is active. The mark is
4567 operations that set the mark but whose main purpose is something
4573 Many commands change their behavior when Transient Mark mode is
4574 in effect and the mark is active, by acting on the region instead
4575 of their usual default part of the buffer's text. Examples of
4578 To see the documentation of commands which are sensitive to the
4581 :global t
4582 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4583 :variable transient-mark-mode)
4585 (defvar widen-automatically t
4586 "Non-nil means it is ok for commands to call `widen' when they want to.
4587 Some commands will do this in order to go to positions outside
4588 the current accessible part of the buffer.
4590 If `widen-automatically' is nil, these commands will do something else
4591 as a fallback, and won't change the buffer bounds.")
4593 (defvar non-essential nil
4594 "Whether the currently executing code is performing an essential task.
4595 This variable should be non-nil only when running code which should not
4596 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4597 user for a password when we are simply scanning a set of files in the
4598 background or displaying possible completions before the user even asked
4599 for it.")
4601 (defun pop-global-mark ()
4602 "Pop off global mark ring and jump to the top location."
4603 (interactive)
4604 ;; Pop entries which refer to non-existent buffers.
4605 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4606 (setq global-mark-ring (cdr global-mark-ring)))
4607 (or global-mark-ring
4608 (error "No global mark set"))
4609 (let* ((marker (car global-mark-ring))
4610 (buffer (marker-buffer marker))
4611 (position (marker-position marker)))
4612 (setq global-mark-ring (nconc (cdr global-mark-ring)
4613 (list (car global-mark-ring))))
4614 (set-buffer buffer)
4615 (or (and (>= position (point-min))
4616 (<= position (point-max)))
4617 (if widen-automatically
4618 (widen)
4619 (error "Global mark position is outside accessible part of buffer")))
4620 (goto-char position)
4621 (switch-to-buffer buffer)))
4622 \f
4623 (defcustom next-line-add-newlines nil
4624 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4625 :type 'boolean
4626 :version "21.1"
4627 :group 'editing-basics)
4629 (defun next-line (&optional arg try-vscroll)
4630 "Move cursor vertically down ARG lines.
4631 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4632 If there is no character in the target line exactly under the current column,
4633 the cursor is positioned after the character in that line which spans this
4634 column, or at the end of the line if it is not long enough.
4635 If there is no line in the buffer after this one, behavior depends on the
4636 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4637 to create a line, and moves the cursor to that line. Otherwise it moves the
4638 cursor to the end of the buffer.
4640 If the variable `line-move-visual' is non-nil, this command moves
4641 by display lines. Otherwise, it moves by buffer lines, without
4642 taking variable-width characters or continued lines into account.
4645 a semipermanent goal column for this command.
4646 Then instead of trying to move exactly vertically (or as close as possible),
4647 this command moves to the specified goal column (or as close as possible).
4648 The goal column is stored in the variable `goal-column', which is nil
4649 when there is no goal column. Note that setting `goal-column'
4650 overrides `line-move-visual' and causes this command to move by buffer
4651 lines rather than by display lines.
4653 If you are thinking of using this in a Lisp program, consider
4654 using `forward-line' instead. It is usually easier to use
4655 and more reliable (no dependence on goal column, etc.)."
4657 (or arg (setq arg 1))
4658 (if (and next-line-add-newlines (= arg 1))
4659 (if (save-excursion (end-of-line) (eobp))
4660 ;; When adding a newline, don't expand an abbrev.
4661 (let ((abbrev-mode nil))
4662 (end-of-line)
4664 (line-move arg nil nil try-vscroll))
4665 (if (called-interactively-p 'interactive)
4666 (condition-case err
4667 (line-move arg nil nil try-vscroll)
4668 ((beginning-of-buffer end-of-buffer)
4669 (signal (car err) (cdr err))))
4670 (line-move arg nil nil try-vscroll)))
4671 nil)
4673 (defun previous-line (&optional arg try-vscroll)
4674 "Move cursor vertically up ARG lines.
4675 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4676 If there is no character in the target line exactly over the current column,
4677 the cursor is positioned after the character in that line which spans this
4678 column, or at the end of the line if it is not long enough.
4680 If the variable `line-move-visual' is non-nil, this command moves
4681 by display lines. Otherwise, it moves by buffer lines, without
4682 taking variable-width characters or continued lines into account.
4685 a semipermanent goal column for this command.
4686 Then instead of trying to move exactly vertically (or as close as possible),
4687 this command moves to the specified goal column (or as close as possible).
4688 The goal column is stored in the variable `goal-column', which is nil
4689 when there is no goal column. Note that setting `goal-column'
4690 overrides `line-move-visual' and causes this command to move by buffer
4691 lines rather than by display lines.
4693 If you are thinking of using this in a Lisp program, consider using
4694 `forward-line' with a negative argument instead. It is usually easier
4695 to use and more reliable (no dependence on goal column, etc.)."
4697 (or arg (setq arg 1))
4698 (if (called-interactively-p 'interactive)
4699 (condition-case err
4700 (line-move (- arg) nil nil try-vscroll)
4701 ((beginning-of-buffer end-of-buffer)
4702 (signal (car err) (cdr err))))
4703 (line-move (- arg) nil nil try-vscroll))
4704 nil)
4706 (defcustom track-eol nil
4707 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4708 This means moving to the end of each line moved onto.
4709 The beginning of a blank line does not count as the end of a line.
4710 This has no effect when the variable `line-move-visual' is non-nil."
4711 :type 'boolean
4712 :group 'editing-basics)
4714 (defcustom goal-column nil
4716 A non-nil setting overrides the variable `line-move-visual', which see."
4717 :type '(choice integer
4718 (const :tag "None" nil))
4719 :group 'editing-basics)
4720 (make-variable-buffer-local 'goal-column)
4722 (defvar temporary-goal-column 0
4723 "Current goal column for vertical motion.
4724 It is the column where point was at the start of the current run
4725 of vertical motion commands.
4727 When moving by visual lines via the function `line-move-visual', it is a cons
4728 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4729 divided by the default column width, and HSCROLL is the number of
4730 columns by which window is scrolled from left margin.
4732 When the `track-eol' feature is doing its job, the value is
4733 `most-positive-fixnum'.")
4735 (defcustom line-move-ignore-invisible t
4737 Outline mode sets this."
4738 :type 'boolean
4739 :group 'editing-basics)
4741 (defcustom line-move-visual t
4742 "When non-nil, `line-move' moves point by visual lines.
4743 This movement is based on where the cursor is displayed on the
4744 screen, instead of relying on buffer contents alone. It takes
4745 into account variable-width characters and line continuation.
4746 If nil, `line-move' moves point by logical lines.
4747 A non-nil setting of `goal-column' overrides the value of this variable
4748 and forces movement by logical lines.
4749 A window that is horizontally scrolled also forces movement by logical
4750 lines."
4751 :type 'boolean
4752 :group 'editing-basics
4753 :version "23.1")
4755 ;; Returns non-nil if partial move was done.
4756 (defun line-move-partial (arg noerror to-end)
4757 (if (< arg 0)
4758 ;; Move backward (up).
4759 ;; If already vscrolled, reduce vscroll
4760 (let ((vs (window-vscroll nil t)))
4761 (when (> vs (frame-char-height))
4762 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4764 ;; Move forward (down).
4765 (let* ((lh (window-line-height -1))
4766 (vpos (nth 1 lh))
4767 (ypos (nth 2 lh))
4768 (rbot (nth 3 lh))
4769 py vs)
4770 (when (or (null lh)
4771 (>= rbot (frame-char-height))
4772 (<= ypos (- (frame-char-height))))
4773 (unless lh
4774 (let ((wend (pos-visible-in-window-p t nil t)))
4775 (setq rbot (nth 3 wend)
4776 vpos (nth 5 wend))))
4777 (cond
4778 ;; If last line of window is fully visible, move forward.
4779 ((or (null rbot) (= rbot 0))
4780 nil)
4781 ;; If cursor is not in the bottom scroll margin, move forward.
4782 ((and (> vpos 0)
4783 (< (setq py
4784 (or (nth 1 (window-line-height))
4785 (let ((ppos (posn-at-point)))
4786 (cdr (or (posn-actual-col-row ppos)
4787 (posn-col-row ppos))))))
4788 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4789 nil)
4790 ;; When already vscrolled, we vscroll some more if we can,
4791 ;; or clear vscroll and move forward at end of tall image.
4792 ((> (setq vs (window-vscroll nil t)) 0)
4793 (when (> rbot 0)
4794 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4795 ;; If cursor just entered the bottom scroll margin, move forward,
4796 ;; but also vscroll one line so redisplay won't recenter.
4797 ((and (> vpos 0)
4798 (= py (min (- (window-text-height) scroll-margin 1)
4799 (1- vpos))))
4800 (set-window-vscroll nil (frame-char-height) t)
4801 (line-move-1 arg noerror to-end)
4802 t)
4803 ;; If there are lines above the last line, scroll-up one line.
4804 ((> vpos 0)
4805 (scroll-up 1)
4806 t)
4807 ;; Finally, start vscroll.
4808 (t
4809 (set-window-vscroll nil (frame-char-height) t)))))))
4812 ;; This is like line-move-1 except that it also performs
4813 ;; vertical scrolling of tall images if appropriate.
4814 ;; That is not really a clean thing to do, since it mixes
4815 ;; scrolling with cursor motion. But so far we don't have
4816 ;; a cleaner solution to the problem of making C-n do something
4817 ;; useful given a tall image.
4818 (defun line-move (arg &optional noerror to-end try-vscroll)
4819 (if noninteractive
4820 (forward-line arg)
4821 (unless (and auto-window-vscroll try-vscroll
4822 ;; Only vscroll for single line moves
4823 (= (abs arg) 1)
4824 ;; Under scroll-conservatively, the display engine
4825 ;; does this better.
4826 (zerop scroll-conservatively)
4827 ;; But don't vscroll in a keyboard macro.
4828 (not defining-kbd-macro)
4829 (not executing-kbd-macro)
4830 (line-move-partial arg noerror to-end))
4831 (set-window-vscroll nil 0 t)
4832 (if (and line-move-visual
4833 ;; Display-based column are incompatible with goal-column.
4834 (not goal-column)
4835 ;; When the text in the window is scrolled to the left,
4836 ;; display-based motion doesn't make sense (because each
4837 ;; logical line occupies exactly one screen line).
4838 (not (> (window-hscroll) 0)))
4839 (line-move-visual arg noerror)
4840 (line-move-1 arg noerror to-end)))))
4842 ;; Display-based alternative to line-move-1.
4843 ;; Arg says how many lines to move. The value is t if we can move the
4844 ;; specified number of lines.
4845 (defun line-move-visual (arg &optional noerror)
4846 (let ((opoint (point))
4847 (hscroll (window-hscroll))
4848 target-hscroll)
4849 ;; Check if the previous command was a line-motion command, or if
4850 ;; we were called from some other command.
4851 (if (and (consp temporary-goal-column)
4852 (memq last-command `(next-line previous-line ,this-command)))
4853 ;; If so, there's no need to reset `temporary-goal-column',
4854 ;; but we may need to hscroll.
4855 (if (or (/= (cdr temporary-goal-column) hscroll)
4856 (> (cdr temporary-goal-column) 0))
4857 (setq target-hscroll (cdr temporary-goal-column)))
4858 ;; Otherwise, we should reset `temporary-goal-column'.
4859 (let ((posn (posn-at-point)))
4860 (cond
4861 ;; Handle the `overflow-newline-into-fringe' case:
4862 ((eq (nth 1 posn) 'right-fringe)
4863 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4864 ((car (posn-x-y posn))
4865 (setq temporary-goal-column
4866 (cons (/ (float (car (posn-x-y posn)))
4867 (frame-char-width)) hscroll))))))
4868 (if target-hscroll
4869 (set-window-hscroll (selected-window) target-hscroll))
4870 ;; vertical-motion can move more than it was asked to if it moves
4871 ;; across display strings with newlines. We don't want to ring
4872 ;; the bell and announce beginning/end of buffer in that case.
4873 (or (and (or (and (>= arg 0)
4874 (>= (vertical-motion
4875 (cons (or goal-column
4876 (if (consp temporary-goal-column)
4877 (car temporary-goal-column)
4878 temporary-goal-column))
4879 arg))
4880 arg))
4881 (and (< arg 0)
4882 (<= (vertical-motion
4883 (cons (or goal-column
4884 (if (consp temporary-goal-column)
4885 (car temporary-goal-column)
4886 temporary-goal-column))
4887 arg))
4888 arg)))
4889 (or (>= arg 0)
4890 (/= (point) opoint)
4891 ;; If the goal column lies on a display string,
4892 ;; `vertical-motion' advances the cursor to the end
4893 ;; of the string. For arg < 0, this can cause the
4894 ;; cursor to get stuck. (Bug#3020).
4895 (= (vertical-motion arg) arg)))
4896 (unless noerror
4897 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4898 nil)))))
4900 ;; This is the guts of next-line and previous-line.
4901 ;; Arg says how many lines to move.
4902 ;; The value is t if we can move the specified number of lines.
4903 (defun line-move-1 (arg &optional noerror _to-end)
4904 ;; Don't run any point-motion hooks, and disregard intangibility,
4905 ;; for intermediate positions.
4906 (let ((inhibit-point-motion-hooks t)
4907 (opoint (point))
4908 (orig-arg arg))
4909 (if (consp temporary-goal-column)
4910 (setq temporary-goal-column (+ (car temporary-goal-column)
4911 (cdr temporary-goal-column))))
4912 (unwind-protect
4913 (progn
4914 (if (not (memq last-command '(next-line previous-line)))
4915 (setq temporary-goal-column
4916 (if (and track-eol (eolp)
4917 ;; Don't count beg of empty line as end of line
4918 ;; unless we just did explicit end-of-line.
4919 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4920 most-positive-fixnum
4921 (current-column))))
4923 (if (not (or (integerp selective-display)
4924 line-move-ignore-invisible))
4925 ;; Use just newline characters.
4926 ;; Set ARG to 0 if we move as many lines as requested.
4927 (or (if (> arg 0)
4928 (progn (if (> arg 1) (forward-line (1- arg)))
4929 ;; This way of moving forward ARG lines
4930 ;; verifies that we have a newline after the last one.
4931 ;; It doesn't get confused by intangible text.
4932 (end-of-line)
4933 (if (zerop (forward-line 1))
4934 (setq arg 0)))
4935 (and (zerop (forward-line arg))
4936 (bolp)
4937 (setq arg 0)))
4938 (unless noerror
4939 (signal (if (< arg 0)
4940 'beginning-of-buffer
4941 'end-of-buffer)
4942 nil)))
4943 ;; Move by arg lines, but ignore invisible ones.
4944 (let (done)
4945 (while (and (> arg 0) (not done))
4946 ;; If the following character is currently invisible,
4947 ;; skip all characters with that same `invisible' property value.
4948 (while (and (not (eobp)) (invisible-p (point)))
4949 (goto-char (next-char-property-change (point))))
4950 ;; Move a line.
4951 ;; We don't use `end-of-line', since we want to escape
4952 ;; from field boundaries occurring exactly at point.
4953 (goto-char (constrain-to-field
4954 (let ((inhibit-field-text-motion t))
4955 (line-end-position))
4956 (point) t t
4957 'inhibit-line-move-field-capture))
4958 ;; If there's no invisibility here, move over the newline.
4959 (cond
4960 ((eobp)
4961 (if (not noerror)
4962 (signal 'end-of-buffer nil)
4963 (setq done t)))
4964 ((and (> arg 1) ;; Use vertical-motion for last move
4965 (not (integerp selective-display))
4966 (not (invisible-p (point))))
4967 ;; We avoid vertical-motion when possible
4968 ;; because that has to fontify.
4969 (forward-line 1))
4970 ;; Otherwise move a more sophisticated way.
4971 ((zerop (vertical-motion 1))
4972 (if (not noerror)
4973 (signal 'end-of-buffer nil)
4974 (setq done t))))
4975 (unless done
4976 (setq arg (1- arg))))
4977 ;; The logic of this is the same as the loop above,
4978 ;; it just goes in the other direction.
4979 (while (and (< arg 0) (not done))
4980 ;; For completely consistency with the forward-motion
4981 ;; case, we should call beginning-of-line here.
4982 ;; However, if point is inside a field and on a
4983 ;; continued line, the call to (vertical-motion -1)
4984 ;; below won't move us back far enough; then we return
4985 ;; to the same column in line-move-finish, and point
4986 ;; gets stuck -- cyd
4987 (forward-line 0)
4988 (cond
4989 ((bobp)
4990 (if (not noerror)
4991 (signal 'beginning-of-buffer nil)
4992 (setq done t)))
4993 ((and (< arg -1) ;; Use vertical-motion for last move
4994 (not (integerp selective-display))
4995 (not (invisible-p (1- (point)))))
4996 (forward-line -1))
4997 ((zerop (vertical-motion -1))
4998 (if (not noerror)
4999 (signal 'beginning-of-buffer nil)
5000 (setq done t))))
5001 (unless done
5002 (setq arg (1+ arg))
5003 (while (and ;; Don't move over previous invis lines
5004 ;; if our target is the middle of this line.
5005 (or (zerop (or goal-column temporary-goal-column))
5006 (< arg 0))
5007 (not (bobp)) (invisible-p (1- (point))))
5008 (goto-char (previous-char-property-change (point))))))))
5009 ;; This is the value the function returns.
5010 (= arg 0))
5012 (cond ((> arg 0)
5013 ;; If we did not move down as far as desired, at least go
5014 ;; to end of line. Be sure to call point-entered and
5015 ;; point-left-hooks.
5016 (let* ((npoint (prog1 (line-end-position)
5017 (goto-char opoint)))
5018 (inhibit-point-motion-hooks nil))
5019 (goto-char npoint)))
5020 ((< arg 0)
5021 ;; If we did not move up as far as desired,
5022 ;; at least go to beginning of line.
5023 (let* ((npoint (prog1 (line-beginning-position)
5024 (goto-char opoint)))
5025 (inhibit-point-motion-hooks nil))
5026 (goto-char npoint)))
5027 (t
5028 (line-move-finish (or goal-column temporary-goal-column)
5029 opoint (> orig-arg 0)))))))
5031 (defun line-move-finish (column opoint forward)
5032 (let ((repeat t))
5033 (while repeat
5034 ;; Set REPEAT to t to repeat the whole thing.
5035 (setq repeat nil)
5037 (let (new
5038 (old (point))
5039 (line-beg (line-beginning-position))
5040 (line-end
5041 ;; Compute the end of the line
5042 ;; ignoring effectively invisible newlines.
5043 (save-excursion
5044 ;; Like end-of-line but ignores fields.
5046 (while (and (not (eobp)) (invisible-p (point)))
5047 (goto-char (next-char-property-change (point)))
5049 (point))))
5051 ;; Move to the desired column.
5052 (line-move-to-column (truncate column))
5054 ;; Corner case: suppose we start out in a field boundary in
5055 ;; the middle of a continued line. When we get to
5056 ;; line-move-finish, point is at the start of a new *screen*
5057 ;; line but the same text line; then line-move-to-column would
5058 ;; move us backwards. Test using C-n with point on the "x" in
5059 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5060 (and forward
5061 (< (point) old)
5062 (goto-char old))
5064 (setq new (point))
5066 ;; Process intangibility within a line.
5067 ;; With inhibit-point-motion-hooks bound to nil, a call to
5068 ;; goto-char moves point past intangible text.
5070 ;; However, inhibit-point-motion-hooks controls both the
5071 ;; intangibility and the point-entered/point-left hooks. The
5072 ;; following hack avoids calling the point-* hooks
5073 ;; unnecessarily. Note that we move *forward* past intangible
5074 ;; text when the initial and final points are the same.
5075 (goto-char new)
5076 (let ((inhibit-point-motion-hooks nil))
5077 (goto-char new)
5079 ;; If intangibility moves us to a different (later) place
5080 ;; in the same line, use that as the destination.
5081 (if (<= (point) line-end)
5082 (setq new (point))
5083 ;; If that position is "too late",
5084 ;; try the previous allowable position.
5085 ;; See if it is ok.
5086 (backward-char)
5087 (if (if forward
5088 ;; If going forward, don't accept the previous
5089 ;; allowable position if it is before the target line.
5090 (< line-beg (point))
5091 ;; If going backward, don't accept the previous
5092 ;; allowable position if it is still after the target line.
5093 (<= (point) line-end))
5094 (setq new (point))
5095 ;; As a last resort, use the end of the line.
5096 (setq new line-end))))
5098 ;; Now move to the updated destination, processing fields
5099 ;; as well as intangibility.
5100 (goto-char opoint)
5101 (let ((inhibit-point-motion-hooks nil))
5102 (goto-char
5103 ;; Ignore field boundaries if the initial and final
5104 ;; positions have the same `field' property, even if the
5105 ;; fields are non-contiguous. This seems to be "nicer"
5106 ;; behavior in many situations.
5107 (if (eq (get-char-property new 'field)
5108 (get-char-property opoint 'field))
5109 new
5110 (constrain-to-field new opoint t t
5111 'inhibit-line-move-field-capture))))
5113 ;; If all this moved us to a different line,
5114 ;; retry everything within that new line.
5115 (when (or (< (point) line-beg) (> (point) line-end))
5116 ;; Repeat the intangibility and field processing.
5117 (setq repeat t))))))
5119 (defun line-move-to-column (col)
5120 "Try to find column COL, considering invisibility.
5121 This function works only in certain cases,
5122 because what we really need is for `move-to-column'
5123 and `current-column' to be able to ignore invisible text."
5124 (if (zerop col)
5125 (beginning-of-line)
5126 (move-to-column col))
5128 (when (and line-move-ignore-invisible
5129 (not (bolp)) (invisible-p (1- (point))))
5130 (let ((normal-location (point))
5131 (normal-column (current-column)))
5132 ;; If the following character is currently invisible,
5133 ;; skip all characters with that same `invisible' property value.
5134 (while (and (not (eobp))
5135 (invisible-p (point)))
5136 (goto-char (next-char-property-change (point))))
5137 ;; Have we advanced to a larger column position?
5138 (if (> (current-column) normal-column)
5139 ;; We have made some progress towards the desired column.
5140 ;; See if we can make any further progress.
5141 (line-move-to-column (+ (current-column) (- col normal-column)))
5142 ;; Otherwise, go to the place we originally found
5143 ;; and move back over invisible text.
5144 ;; that will get us to the same place on the screen
5145 ;; but with a more reasonable buffer position.
5146 (goto-char normal-location)
5147 (let ((line-beg (line-beginning-position)))
5148 (while (and (not (bolp)) (invisible-p (1- (point))))
5149 (goto-char (previous-char-property-change (point) line-beg))))))))
5151 (defun move-end-of-line (arg)
5152 "Move point to end of current line as displayed.
5153 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5154 If point reaches the beginning or end of buffer, it stops there.
5156 To ignore the effects of the `intangible' text or overlay
5157 property, bind `inhibit-point-motion-hooks' to t.
5158 If there is an image in the current line, this function
5159 disregards newlines that are part of the text on which the image
5160 rests."
5161 (interactive "^p")
5162 (or arg (setq arg 1))
5163 (let (done)
5164 (while (not done)
5165 (let ((newpos
5166 (save-excursion
5167 (let ((goal-column 0)
5168 (line-move-visual nil))
5169 (and (line-move arg t)
5170 ;; With bidi reordering, we may not be at bol,
5171 ;; so make sure we are.
5173 (not (bobp))
5174 (progn
5175 (while (and (not (bobp)) (invisible-p (1- (point))))
5176 (goto-char (previous-single-char-property-change
5177 (point) 'invisible)))
5178 (backward-char 1)))
5179 (point)))))
5180 (goto-char newpos)
5181 (if (and (> (point) newpos)
5183 (backward-char 1)
5184 (if (and (> (point) newpos) (not (eobp))
5186 ;; If we skipped something intangible and now we're not
5187 ;; really at eol, keep going.
5188 (setq arg 1)
5189 (setq done t)))))))
5191 (defun move-beginning-of-line (arg)
5192 "Move point to beginning of current line as displayed.
5193 \(If there's an image in the line, this disregards newlines
5194 which are part of the text that the image rests on.)
5196 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5197 If point reaches the beginning or end of buffer, it stops there.
5198 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5199 (interactive "^p")
5200 (or arg (setq arg 1))
5202 (let ((orig (point))
5203 first-vis first-vis-field-value)
5205 ;; Move by lines, if ARG is not 1 (the default).
5206 (if (/= arg 1)
5207 (let ((line-move-visual nil))
5208 (line-move (1- arg) t)))
5210 ;; Move to beginning-of-line, ignoring fields and invisible text.
5212 (while (and (not (bobp)) (invisible-p (1- (point))))
5213 (goto-char (previous-char-property-change (point)))
5216 ;; Now find first visible char in the line
5217 (while (and (not (eobp)) (invisible-p (point)))
5218 (goto-char (next-char-property-change (point))))
5219 (setq first-vis (point))
5221 ;; See if fields would stop us from reaching FIRST-VIS.
5222 (setq first-vis-field-value
5223 (constrain-to-field first-vis orig (/= arg 1) t nil))
5225 (goto-char (if (/= first-vis-field-value first-vis)
5226 ;; If yes, obey them.
5227 first-vis-field-value
5228 ;; Otherwise, move to START with attention to fields.
5229 ;; (It is possible that fields never matter in this case.)
5230 (constrain-to-field (point) orig
5231 (/= arg 1) t nil)))))
5234 ;; Many people have said they rarely use this feature, and often type
5235 ;; it by accident. Maybe it shouldn't even be on a key.
5236 (put 'set-goal-column 'disabled t)
5238 (defun set-goal-column (arg)
5240 Those commands will move to this position in the line moved to
5241 rather than trying to keep the same horizontal position.
5242 With a non-nil argument ARG, clears out the goal column
5244 The goal column is stored in the variable `goal-column'."
5245 (interactive "P")
5246 (if arg
5247 (progn
5248 (setq goal-column nil)
5249 (message "No goal column"))
5250 (setq goal-column (current-column))
5251 ;; The older method below can be erroneous if `set-goal-column' is bound
5252 ;; to a sequence containing %
5253 ;;(message (substitute-command-keys
5255 ;;goal-column)
5256 (message "%s"
5257 (concat
5258 (format "Goal column %d " goal-column)
5259 (substitute-command-keys
5262 )
5263 nil)
5264 \f
5265 ;;; Editing based on visual lines, as opposed to logical lines.
5267 (defun end-of-visual-line (&optional n)
5268 "Move point to end of current visual line.
5269 With argument N not nil or 1, move forward N - 1 visual lines first.
5270 If point reaches the beginning or end of buffer, it stops there.
5271 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5272 (interactive "^p")
5273 (or n (setq n 1))
5274 (if (/= n 1)
5275 (let ((line-move-visual t))
5276 (line-move (1- n) t)))
5277 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5278 ;; constrain to field boundaries, so we don't either.
5279 (vertical-motion (cons (window-width) 0)))
5281 (defun beginning-of-visual-line (&optional n)
5282 "Move point to beginning of current visual line.
5283 With argument N not nil or 1, move forward N - 1 visual lines first.
5284 If point reaches the beginning or end of buffer, it stops there.
5285 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5286 (interactive "^p")
5287 (or n (setq n 1))
5288 (let ((opoint (point)))
5289 (if (/= n 1)
5290 (let ((line-move-visual t))
5291 (line-move (1- n) t)))
5292 (vertical-motion 0)
5293 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5294 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5296 (defun kill-visual-line (&optional arg)
5297 "Kill the rest of the visual line.
5298 With prefix argument ARG, kill that many visual lines from point.
5299 If ARG is negative, kill visual lines backward.
5300 If ARG is zero, kill the text before point on the current visual
5301 line.
5303 If you want to append the killed line to the last killed text,
5306 If the buffer is read-only, Emacs will beep and refrain from deleting
5307 the line, but put the line in the kill ring anyway. This means that
5308 you can use this command to copy text from a read-only buffer.
5309 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5310 even beep.)"
5311 (interactive "P")
5312 ;; Like in `kill-line', it's better to move point to the other end
5313 ;; of the kill before killing.
5314 (let ((opoint (point))
5315 (kill-whole-line (and kill-whole-line (bolp))))
5316 (if arg
5317 (vertical-motion (prefix-numeric-value arg))
5318 (end-of-visual-line 1)
5319 (if (= (point) opoint)
5320 (vertical-motion 1)
5321 ;; Skip any trailing whitespace at the end of the visual line.
5322 ;; We used to do this only if `show-trailing-whitespace' is
5323 ;; nil, but that's wrong; the correct thing would be to check
5324 ;; whether the trailing whitespace is highlighted. But, it's
5325 ;; OK to just do this unconditionally.
5328 (1+ (point))
5329 (point)))))
5331 (defun next-logical-line (&optional arg try-vscroll)
5332 "Move cursor vertically down ARG lines.
5333 This is identical to `next-line', except that it always moves
5334 by logical lines instead of visual lines, ignoring the value of
5335 the variable `line-move-visual'."
5337 (let ((line-move-visual nil))
5338 (with-no-warnings
5339 (next-line arg try-vscroll))))
5341 (defun previous-logical-line (&optional arg try-vscroll)
5342 "Move cursor vertically up ARG lines.
5343 This is identical to `previous-line', except that it always moves
5344 by logical lines instead of visual lines, ignoring the value of
5345 the variable `line-move-visual'."
5347 (let ((line-move-visual nil))
5348 (with-no-warnings
5349 (previous-line arg try-vscroll))))
5351 (defgroup visual-line nil
5352 "Editing based on visual lines."
5353 :group 'convenience
5354 :version "23.1")
5356 (defvar visual-line-mode-map
5357 (let ((map (make-sparse-keymap)))
5358 (define-key map [remap kill-line] 'kill-visual-line)
5359 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5360 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5361 ;; These keybindings interfere with xterm function keys. Are
5362 ;; there any other suitable bindings?
5363 ;; (define-key map "\M-[" 'previous-logical-line)
5364 ;; (define-key map "\M-]" 'next-logical-line)
5365 map))
5367 (defcustom visual-line-fringe-indicators '(nil nil)
5368 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5369 The value should be a list of the form (LEFT RIGHT), where LEFT
5370 and RIGHT are symbols representing the bitmaps to display, to
5371 indicate wrapped lines, in the left and right fringes respectively.
5372 See also `fringe-indicator-alist'.
5373 The default is not to display fringe indicators for wrapped lines.
5374 This variable does not affect fringe indicators displayed for
5375 other purposes."
5376 :type '(list (choice (const :tag "Hide left indicator" nil)
5377 (const :tag "Left curly arrow" left-curly-arrow)
5378 (symbol :tag "Other bitmap"))
5379 (choice (const :tag "Hide right indicator" nil)
5380 (const :tag "Right curly arrow" right-curly-arrow)
5381 (symbol :tag "Other bitmap")))
5382 :set (lambda (symbol value)
5383 (dolist (buf (buffer-list))
5384 (with-current-buffer buf
5385 (when (and (boundp 'visual-line-mode)
5386 (symbol-value 'visual-line-mode))
5387 (setq fringe-indicator-alist
5388 (cons (cons 'continuation value)
5389 (assq-delete-all
5390 'continuation
5391 (copy-tree fringe-indicator-alist)))))))
5392 (set-default symbol value)))
5394 (defvar visual-line--saved-state nil)
5396 (define-minor-mode visual-line-mode
5397 "Toggle visual line based editing (Visual Line mode).
5398 With a prefix argument ARG, enable Visual Line mode if ARG is
5399 positive, and disable it otherwise. If called from Lisp, enable
5400 the mode if ARG is omitted or nil.
5402 When Visual Line mode is enabled, `word-wrap' is turned on in
5403 this buffer, and simple editing commands are redefined to act on
5404 visual lines, not logical lines. See Info node `Visual Line
5405 Mode' for details."
5406 :keymap visual-line-mode-map
5407 :group 'visual-line
5408 :lighter " Wrap"
5409 (if visual-line-mode
5410 (progn
5411 (set (make-local-variable 'visual-line--saved-state) nil)
5412 ;; Save the local values of some variables, to be restored if
5413 ;; visual-line-mode is turned off.
5414 (dolist (var '(line-move-visual truncate-lines
5415 truncate-partial-width-windows
5416 word-wrap fringe-indicator-alist))
5417 (if (local-variable-p var)
5418 (push (cons var (symbol-value var))
5419 visual-line--saved-state)))
5420 (set (make-local-variable 'line-move-visual) t)
5421 (set (make-local-variable 'truncate-partial-width-windows) nil)
5422 (setq truncate-lines nil
5423 word-wrap t
5424 fringe-indicator-alist
5425 (cons (cons 'continuation visual-line-fringe-indicators)
5426 fringe-indicator-alist)))
5427 (kill-local-variable 'line-move-visual)
5428 (kill-local-variable 'word-wrap)
5429 (kill-local-variable 'truncate-lines)
5430 (kill-local-variable 'truncate-partial-width-windows)
5431 (kill-local-variable 'fringe-indicator-alist)
5432 (dolist (saved visual-line--saved-state)
5433 (set (make-local-variable (car saved)) (cdr saved)))
5434 (kill-local-variable 'visual-line--saved-state)))
5436 (defun turn-on-visual-line-mode ()
5437 (visual-line-mode 1))
5439 (define-globalized-minor-mode global-visual-line-mode
5440 visual-line-mode turn-on-visual-line-mode
5441 :lighter " vl")
5443 \f
5444 (defun transpose-chars (arg)
5445 "Interchange characters around point, moving forward one character.
5446 With prefix arg ARG, effect is to take character before point
5447 and drag it forward past ARG other characters (backward if ARG negative).
5448 If no argument and at end of line, the previous two chars are exchanged."
5449 (interactive "*P")
5450 (and (null arg) (eolp) (forward-char -1))
5451 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5453 (defun transpose-words (arg)
5454 "Interchange words around point, leaving point at end of them.
5455 With prefix arg ARG, effect is to take word before or around point
5456 and drag it forward past ARG other words (backward if ARG negative).
5457 If ARG is zero, the words around or after point and around or after mark
5458 are interchanged."
5459 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5460 (interactive "*p")
5461 (transpose-subr 'forward-word arg))
5463 (defun transpose-sexps (arg)
5465 Does not work on a sexp that point is in the middle of
5466 if it is a list or string."
5467 (interactive "*p")
5468 (transpose-subr
5469 (lambda (arg)
5470 ;; Here we should try to simulate the behavior of
5471 ;; (cons (progn (forward-sexp x) (point))
5472 ;; (progn (forward-sexp (- x)) (point)))
5473 ;; Except that we don't want to rely on the second forward-sexp
5474 ;; putting us back to where we want to be, since forward-sexp-function
5475 ;; might do funny things like infix-precedence.
5476 (if (if (> arg 0)
5478 (and (not (bobp))
5480 ;; Jumping over a symbol. We might be inside it, mind you.
5481 (progn (funcall (if (> arg 0)
5482 'skip-syntax-backward 'skip-syntax-forward)
5483 "w_")
5484 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5485 ;; Otherwise, we're between sexps. Take a step back before jumping
5486 ;; to make sure we'll obey the same precedence no matter which direction
5487 ;; we're going.
5488 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5489 (cons (save-excursion (forward-sexp arg) (point))
5490 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5491 (not (zerop (funcall (if (> arg 0)
5492 'skip-syntax-forward
5493 'skip-syntax-backward)
5494 ".")))))
5495 (point)))))
5496 arg 'special))
5498 (defun transpose-lines (arg)
5499 "Exchange current line and previous line, leaving point after both.
5500 With argument ARG, takes previous line and moves it past ARG lines.
5501 With argument 0, interchanges line point is in with line mark is in."
5502 (interactive "*p")
5503 (transpose-subr (function
5504 (lambda (arg)
5505 (if (> arg 0)
5506 (progn
5507 ;; Move forward over ARG lines,
5508 ;; but create newlines if necessary.
5509 (setq arg (forward-line arg))
5511 (setq arg (1+ arg)))
5512 (if (> arg 0)
5513 (newline arg)))
5514 (forward-line arg))))
5515 arg))
5517 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5518 ;; which seems inconsistent with the ARG /= 0 case.
5519 ;; FIXME document SPECIAL.
5520 (defun transpose-subr (mover arg &optional special)
5521 "Subroutine to do the work of transposing objects.
5522 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5523 moves forward by units of the given object (e.g. forward-sentence,
5524 forward-paragraph). If ARG is zero, exchanges the current object
5525 with the one containing mark. If ARG is an integer, moves the
5526 current object past ARG following (if ARG is positive) or
5527 preceding (if ARG is negative) objects, leaving point after the
5528 current object."
5529 (let ((aux (if special mover
5530 (lambda (x)
5531 (cons (progn (funcall mover x) (point))
5532 (progn (funcall mover (- x)) (point))))))
5533 pos1 pos2)
5534 (cond
5535 ((= arg 0)
5536 (save-excursion
5537 (setq pos1 (funcall aux 1))
5538 (goto-char (or (mark) (error "No mark set in this buffer")))
5539 (setq pos2 (funcall aux 1))
5540 (transpose-subr-1 pos1 pos2))
5541 (exchange-point-and-mark))
5542 ((> arg 0)
5543 (setq pos1 (funcall aux -1))
5544 (setq pos2 (funcall aux arg))
5545 (transpose-subr-1 pos1 pos2)
5546 (goto-char (car pos2)))
5547 (t
5548 (setq pos1 (funcall aux -1))
5549 (goto-char (car pos1))
5550 (setq pos2 (funcall aux arg))
5551 (transpose-subr-1 pos1 pos2)))))
5553 (defun transpose-subr-1 (pos1 pos2)
5554 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5555 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5556 (when (> (car pos1) (car pos2))
5557 (let ((swap pos1))
5558 (setq pos1 pos2 pos2 swap)))
5559 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5560 (atomic-change-group
5561 ;; This sequence of insertions attempts to preserve marker
5562 ;; positions at the start and end of the transposed objects.
5563 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
5564 (len1 (- (cdr pos1) (car pos1)))
5565 (len2 (length word))
5566 (boundary (make-marker)))
5567 (set-marker boundary (car pos2))
5568 (goto-char (cdr pos1))
5569 (insert-before-markers word)
5570 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
5571 (goto-char boundary)
5572 (insert word)
5573 (goto-char (+ boundary len1))
5574 (delete-region (point) (+ (point) len2))
5575 (set-marker boundary nil))))
5576 \f
5577 (defun backward-word (&optional arg)
5578 "Move backward until encountering the beginning of a word.
5579 With argument ARG, do this that many times."
5580 (interactive "^p")
5581 (forward-word (- (or arg 1))))
5583 (defun mark-word (&optional arg allow-extend)
5584 "Set mark ARG words away from point.
5586 move to with the same argument.
5587 Interactively, if this command is repeated
5588 or (in Transient Mark mode) if the mark is active,
5589 it marks the next ARG words after the ones already marked."
5591 (cond ((and allow-extend
5592 (or (and (eq last-command this-command) (mark t))
5593 (region-active-p)))
5594 (setq arg (if arg (prefix-numeric-value arg)
5595 (if (< (mark) (point)) -1 1)))
5596 (set-mark
5597 (save-excursion
5598 (goto-char (mark))
5599 (forward-word arg)
5600 (point))))
5601 (t
5602 (push-mark
5603 (save-excursion
5604 (forward-word (prefix-numeric-value arg))
5605 (point))
5606 nil t))))
5608 (defun kill-word (arg)
5609 "Kill characters forward until encountering the end of a word.
5610 With argument ARG, do this that many times."
5611 (interactive "p")
5612 (kill-region (point) (progn (forward-word arg) (point))))
5614 (defun backward-kill-word (arg)
5615 "Kill characters backward until encountering the beginning of a word.
5616 With argument ARG, do this that many times."
5617 (interactive "p")
5618 (kill-word (- arg)))
5620 (defun current-word (&optional strict really-word)
5621 "Return the symbol or word that point is on (or a nearby one) as a string.
5622 The return value includes no text properties.
5623 If optional arg STRICT is non-nil, return nil unless point is within
5624 or adjacent to a symbol or word. In all cases the value can be nil
5625 if there is no word nearby.
5626 The function, belying its name, normally finds a symbol.
5627 If optional arg REALLY-WORD is non-nil, it finds just a word."
5628 (save-excursion
5629 (let* ((oldpoint (point)) (start (point)) (end (point))
5630 (syntaxes (if really-word "w" "w_"))
5631 (not-syntaxes (concat "^" syntaxes)))
5632 (skip-syntax-backward syntaxes) (setq start (point))
5633 (goto-char oldpoint)
5634 (skip-syntax-forward syntaxes) (setq end (point))
5635 (when (and (eq start oldpoint) (eq end oldpoint)
5636 ;; Point is neither within nor adjacent to a word.
5637 (not strict))
5638 ;; Look for preceding word in same line.
5639 (skip-syntax-backward not-syntaxes (line-beginning-position))
5640 (if (bolp)
5641 ;; No preceding word in same line.
5642 ;; Look for following word in same line.
5643 (progn
5644 (skip-syntax-forward not-syntaxes (line-end-position))
5645 (setq start (point))
5646 (skip-syntax-forward syntaxes)
5647 (setq end (point)))
5648 (setq end (point))
5649 (skip-syntax-backward syntaxes)
5650 (setq start (point))))
5651 ;; If we found something nonempty, return it as a string.
5652 (unless (= start end)
5653 (buffer-substring-no-properties start end)))))
5654 \f
5655 (defcustom fill-prefix nil
5656 "String for filling to insert at front of new line, or nil for none."
5657 :type '(choice (const :tag "None" nil)
5658 string)
5659 :group 'fill)
5660 (make-variable-buffer-local 'fill-prefix)
5661 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5663 (defcustom auto-fill-inhibit-regexp nil
5664 "Regexp to match lines which should not be auto-filled."
5665 :type '(choice (const :tag "None" nil)
5666 regexp)
5667 :group 'fill)
5669 (defun do-auto-fill ()
5670 "The default value for `normal-auto-fill-function'.
5671 This is the default auto-fill function, some major modes use a different one.
5672 Returns t if it really did any work."
5673 (let (fc justify give-up
5674 (fill-prefix fill-prefix))
5675 (if (or (not (setq justify (current-justification)))
5676 (null (setq fc (current-fill-column)))
5677 (and (eq justify 'left)
5678 (<= (current-column) fc))
5679 (and auto-fill-inhibit-regexp
5680 (save-excursion (beginning-of-line)
5681 (looking-at auto-fill-inhibit-regexp))))
5682 nil ;; Auto-filling not required
5683 (if (memq justify '(full center right))
5684 (save-excursion (unjustify-current-line)))
5686 ;; Choose a fill-prefix automatically.
5687 (when (and adaptive-fill-mode
5688 (or (null fill-prefix) (string= fill-prefix "")))
5689 (let ((prefix
5690 (fill-context-prefix
5691 (save-excursion (fill-forward-paragraph -1) (point))
5692 (save-excursion (fill-forward-paragraph 1) (point)))))
5693 (and prefix (not (equal prefix ""))
5694 ;; Use auto-indentation rather than a guessed empty prefix.
5695 (not (and fill-indent-according-to-mode
5697 (setq fill-prefix prefix))))
5699 (while (and (not give-up) (> (current-column) fc))
5700 ;; Determine where to split the line.
5701 (let* (after-prefix
5702 (fill-point
5703 (save-excursion
5704 (beginning-of-line)
5705 (setq after-prefix (point))
5706 (and fill-prefix
5707 (looking-at (regexp-quote fill-prefix))
5708 (setq after-prefix (match-end 0)))
5709 (move-to-column (1+ fc))
5710 (fill-move-to-break-point after-prefix)
5711 (point))))
5713 ;; See whether the place we found is any good.
5714 (if (save-excursion
5715 (goto-char fill-point)
5716 (or (bolp)
5717 ;; There is no use breaking at end of line.
5718 (save-excursion (skip-chars-forward " ") (eolp))
5719 ;; It is futile to split at the end of the prefix
5720 ;; since we would just insert the prefix again.
5721 (and after-prefix (<= (point) after-prefix))
5722 ;; Don't split right after a comment starter
5723 ;; since we would just make another comment starter.
5724 (and comment-start-skip
5725 (let ((limit (point)))
5726 (beginning-of-line)
5727 (and (re-search-forward comment-start-skip
5728 limit t)
5729 (eq (point) limit))))))
5730 ;; No good place to break => stop trying.
5731 (setq give-up t)
5732 ;; Ok, we have a useful place to break the line. Do it.
5733 (let ((prev-column (current-column)))
5734 ;; If point is at the fill-point, do not `save-excursion'.
5735 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5736 ;; point will end up before it rather than after it.
5737 (if (save-excursion
5739 (= (point) fill-point))
5740 (default-indent-new-line t)
5741 (save-excursion
5742 (goto-char fill-point)
5743 (default-indent-new-line t)))
5744 ;; Now do justification, if required
5745 (if (not (eq justify 'left))
5746 (save-excursion
5747 (end-of-line 0)
5748 (justify-current-line justify nil t)))
5749 ;; If making the new line didn't reduce the hpos of
5750 ;; the end of the line, then give up now;
5751 ;; trying again will not help.
5752 (if (>= (current-column) prev-column)
5753 (setq give-up t))))))
5754 ;; Justify last line.
5755 (justify-current-line justify t t)
5756 t)))
5758 (defvar comment-line-break-function 'comment-indent-new-line
5759 "Mode-specific function which line breaks and continues a comment.
5760 This function is called during auto-filling when a comment syntax
5761 is defined.
5762 The function should take a single optional argument, which is a flag
5763 indicating whether it should use soft newlines.")
5765 (defun default-indent-new-line (&optional soft)
5766 "Break line at point and indent.
5767 If a comment syntax is defined, call `comment-indent-new-line'.
5769 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5770 unless optional argument SOFT is non-nil."
5771 (interactive)
5772 (if comment-start
5773 (funcall comment-line-break-function soft)
5774 ;; Insert the newline before removing empty space so that markers
5775 ;; get preserved better.
5777 (save-excursion (forward-char -1) (delete-horizontal-space))
5778 (delete-horizontal-space)
5780 (if (and fill-prefix (not adaptive-fill-mode))
5781 ;; Blindly trust a non-adaptive fill-prefix.
5782 (progn
5783 (indent-to-left-margin)
5784 (insert-before-markers-and-inherit fill-prefix))
5786 (cond
5787 ;; If there's an adaptive prefix, use it unless we're inside
5788 ;; a comment and the prefix is not a comment starter.
5789 (fill-prefix
5790 (indent-to-left-margin)
5791 (insert-and-inherit fill-prefix))
5792 ;; If we're not inside a comment, just try to indent.
5793 (t (indent-according-to-mode))))))
5795 (defvar normal-auto-fill-function 'do-auto-fill
5796 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5797 Some major modes set this.")
5799 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5800 ;; `functions' and `hooks' are usually unsafe to set, but setting
5801 ;; auto-fill-function to nil in a file-local setting is safe and
5802 ;; can be useful to prevent auto-filling.
5803 (put 'auto-fill-function 'safe-local-variable 'null)
5805 (define-minor-mode auto-fill-mode
5806 "Toggle automatic line breaking (Auto Fill mode).
5807 With a prefix argument ARG, enable Auto Fill mode if ARG is
5808 positive, and disable it otherwise. If called from Lisp, enable
5809 the mode if ARG is omitted or nil.
5811 When Auto Fill mode is enabled, inserting a space at a column
5812 beyond `current-fill-column' automatically breaks the line at a
5813 previous space.
5815 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5816 non-`nil'.
5818 The value of `normal-auto-fill-function' specifies the function to use
5819 for `auto-fill-function' when turning Auto Fill mode on."
5820 :variable (auto-fill-function
5821 . (lambda (v) (setq auto-fill-function
5822 (if v normal-auto-fill-function)))))
5824 ;; This holds a document string used to document auto-fill-mode.
5825 (defun auto-fill-function ()
5826 "Automatically break line at a previous space, in insertion of text."
5827 nil)
5829 (defun turn-on-auto-fill ()
5830 "Unconditionally turn on Auto Fill mode."
5831 (auto-fill-mode 1))
5833 (defun turn-off-auto-fill ()
5834 "Unconditionally turn off Auto Fill mode."
5835 (auto-fill-mode -1))
5837 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5839 (defun set-fill-column (arg)
5840 "Set `fill-column' to specified argument.
5843 (interactive
5844 (list (or current-prefix-arg
5845 ;; We used to use current-column silently, but C-x f is too easily
5846 ;; typed as a typo for C-x C-f, so we turned it into an error and
5847 ;; now an interactive prompt.
5848 (read-number "Set fill-column to: " (current-column)))))
5849 (if (consp arg)
5850 (setq arg (current-column)))
5851 (if (not (integerp arg))
5852 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5853 (error "set-fill-column requires an explicit argument")
5854 (message "Fill column set to %d (was %d)" arg fill-column)
5855 (setq fill-column arg)))
5856 \f
5857 (defun set-selective-display (arg)
5858 "Set `selective-display' to ARG; clear it if no arg.
5859 When the value of `selective-display' is a number > 0,
5860 lines whose indentation is >= that value are not displayed.
5861 The variable `selective-display' has a separate value for each buffer."
5862 (interactive "P")
5863 (if (eq selective-display t)
5864 (error "selective-display already in use for marked lines"))
5865 (let ((current-vpos
5866 (save-restriction
5867 (narrow-to-region (point-min) (point))
5868 (goto-char (window-start))
5869 (vertical-motion (window-height)))))
5870 (setq selective-display
5871 (and arg (prefix-numeric-value arg)))
5872 (recenter current-vpos))
5873 (set-window-start (selected-window) (window-start (selected-window)))
5874 (princ "selective-display set to " t)
5875 (prin1 selective-display t)
5876 (princ "." t))
5878 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5880 (defun toggle-truncate-lines (&optional arg)
5881 "Toggle truncating of long lines for the current buffer.
5882 When truncating is off, long lines are folded.
5883 With prefix argument ARG, truncate long lines if ARG is positive,
5884 otherwise fold them. Note that in side-by-side windows, this
5885 command has no effect if `truncate-partial-width-windows' is
5886 non-nil."
5887 (interactive "P")
5888 (setq truncate-lines
5889 (if (null arg)
5890 (not truncate-lines)
5891 (> (prefix-numeric-value arg) 0)))
5892 (force-mode-line-update)
5893 (unless truncate-lines
5894 (let ((buffer (current-buffer)))
5895 (walk-windows (lambda (window)
5896 (if (eq buffer (window-buffer window))
5897 (set-window-hscroll window 0)))
5898 nil t)))
5899 (message "Truncate long lines %s"
5900 (if truncate-lines "enabled" "disabled")))
5902 (defun toggle-word-wrap (&optional arg)
5903 "Toggle whether to use word-wrapping for continuation lines.
5904 With prefix argument ARG, wrap continuation lines at word boundaries
5905 if ARG is positive, otherwise wrap them at the right screen edge.
5906 This command toggles the value of `word-wrap'. It has no effect
5907 if long lines are truncated."
5908 (interactive "P")
5909 (setq word-wrap
5910 (if (null arg)
5911 (not word-wrap)
5912 (> (prefix-numeric-value arg) 0)))
5913 (force-mode-line-update)
5914 (message "Word wrapping %s"
5915 (if word-wrap "enabled" "disabled")))
5917 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5918 "The string displayed in the mode line when in overwrite mode.")
5919 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5920 "The string displayed in the mode line when in binary overwrite mode.")
5922 (define-minor-mode overwrite-mode
5923 "Toggle Overwrite mode.
5924 With a prefix argument ARG, enable Overwrite mode if ARG is
5925 positive, and disable it otherwise. If called from Lisp, enable
5926 the mode if ARG is omitted or nil.
5928 When Overwrite mode is enabled, printing characters typed in
5929 replace existing text on a one-for-one basis, rather than pushing
5930 it to the right. At the end of a line, such characters extend
5931 the line. Before a tab, such characters insert until the tab is
5933 overwrite mode; this is supposed to make it easier to insert
5934 characters when necessary."
5935 :variable (overwrite-mode
5936 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5938 (define-minor-mode binary-overwrite-mode
5939 "Toggle Binary Overwrite mode.
5940 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5941 is positive, and disable it otherwise. If called from Lisp,
5942 enable the mode if ARG is omitted or nil.
5944 When Binary Overwrite mode is enabled, printing characters typed
5945 in replace existing text. Newlines are not treated specially, so
5946 typing at the end of a line joins the line to the next, with the
5947 typed character between them. Typing before a tab character
5948 simply replaces the tab with the character typed.
5950 ordinary typing characters do.
5952 Note that Binary Overwrite mode is not its own minor mode; it is
5953 a specialization of overwrite mode, entered by setting the
5954 `overwrite-mode' variable to `overwrite-mode-binary'."
5955 :variable (overwrite-mode
5956 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5958 (define-minor-mode line-number-mode
5959 "Toggle line number display in the mode line (Line Number mode).
5960 With a prefix argument ARG, enable Line Number mode if ARG is
5961 positive, and disable it otherwise. If called from Lisp, enable
5962 the mode if ARG is omitted or nil.
5964 Line numbers do not appear for very large buffers and buffers
5965 with very long lines; see variables `line-number-display-limit'
5966 and `line-number-display-limit-width'."
5967 :init-value t :global t :group 'mode-line)
5969 (define-minor-mode column-number-mode
5970 "Toggle column number display in the mode line (Column Number mode).
5971 With a prefix argument ARG, enable Column Number mode if ARG is
5972 positive, and disable it otherwise.
5974 If called from Lisp, enable the mode if ARG is omitted or nil."
5975 :global t :group 'mode-line)
5977 (define-minor-mode size-indication-mode
5978 "Toggle buffer size display in the mode line (Size Indication mode).
5979 With a prefix argument ARG, enable Size Indication mode if ARG is
5980 positive, and disable it otherwise.
5982 If called from Lisp, enable the mode if ARG is omitted or nil."
5983 :global t :group 'mode-line)
5985 (define-minor-mode auto-save-mode
5986 "Toggle auto-saving in the current buffer (Auto Save mode).
5987 With a prefix argument ARG, enable Auto Save mode if ARG is
5988 positive, and disable it otherwise.
5990 If called from Lisp, enable the mode if ARG is omitted or nil."
5991 :variable ((and buffer-auto-save-file-name
5992 ;; If auto-save is off because buffer has shrunk,
5993 ;; then toggling should turn it on.
5994 (>= buffer-saved-size 0))
5995 . (lambda (val)
5996 (setq buffer-auto-save-file-name
5997 (cond
5998 ((null val) nil)
5999 ((and buffer-file-name auto-save-visited-file-name
6000 (not buffer-read-only))
6001 buffer-file-name)
6002 (t (make-auto-save-file-name))))))
6003 ;; If -1 was stored here, to temporarily turn off saving,
6004 ;; turn it back on.
6005 (and (< buffer-saved-size 0)
6006 (setq buffer-saved-size 0)))
6007 \f
6008 (defgroup paren-blinking nil
6009 "Blinking matching of parens and expressions."
6010 :prefix "blink-matching-"
6011 :group 'paren-matching)
6013 (defcustom blink-matching-paren t
6014 "Non-nil means show matching open-paren when close-paren is inserted."
6015 :type 'boolean
6016 :group 'paren-blinking)
6018 (defcustom blink-matching-paren-on-screen t
6019 "Non-nil means show matching open-paren when it is on screen.
6020 If nil, don't show it (but the open-paren can still be shown
6021 when it is off screen).
6023 This variable has no effect if `blink-matching-paren' is nil.
6024 \(In that case, the open-paren is never shown.)
6025 It is also ignored if `show-paren-mode' is enabled."
6026 :type 'boolean
6027 :group 'paren-blinking)
6029 (defcustom blink-matching-paren-distance (* 100 1024)
6030 "If non-nil, maximum distance to search backwards for matching open-paren.
6031 If nil, search stops at the beginning of the accessible portion of the buffer."
6032 :version "23.2" ; 25->100k
6033 :type '(choice (const nil) integer)
6034 :group 'paren-blinking)
6036 (defcustom blink-matching-delay 1
6037 "Time in seconds to delay after showing a matching paren."
6038 :type 'number
6039 :group 'paren-blinking)
6041 (defcustom blink-matching-paren-dont-ignore-comments nil
6042 "If nil, `blink-matching-paren' ignores comments.
6043 More precisely, when looking for the matching parenthesis,
6044 it skips the contents of comments that end before point."
6045 :type 'boolean
6046 :group 'paren-blinking)
6048 (defun blink-matching-check-mismatch (start end)
6049 "Return whether or not START...END are matching parens.
6050 END is the current point and START is the blink position.
6051 START might be nil if no matching starter was found.
6052 Returns non-nil if we find there is a mismatch."
6053 (let* ((end-syntax (syntax-after (1- end)))
6054 (matching-paren (and (consp end-syntax)
6055 (eq (syntax-class end-syntax) 5)
6056 (cdr end-syntax))))
6057 ;; For self-matched chars like " and $, we can't know when they're
6058 ;; mismatched or unmatched, so we can only do it for parens.
6059 (when matching-paren
6060 (not (and start
6061 (or
6062 (eq (char-after start) matching-paren)
6063 ;; The cdr might hold a new paren-class info rather than
6064 ;; a matching-char info, in which case the two CDRs
6065 ;; should match.
6066 (eq matching-paren (cdr-safe (syntax-after start)))))))))
6068 (defvar blink-matching-check-function #'blink-matching-check-mismatch
6069 "Function to check parentheses mismatches.
6070 The function takes two arguments (START and END) where START is the
6071 position just before the opening token and END is the position right after.
6072 START can be nil, if it was not found.
6073 The function should return non-nil if the two tokens do not match.")
6075 (defun blink-matching-open ()
6076 "Move cursor momentarily to the beginning of the sexp before point."
6077 (interactive)
6078 (when (and (not (bobp))
6079 blink-matching-paren)
6080 (let* ((oldpos (point))
6081 (message-log-max nil) ; Don't log messages about paren matching.
6082 (blinkpos
6083 (save-excursion
6084 (save-restriction
6085 (if blink-matching-paren-distance
6086 (narrow-to-region
6087 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
6088 (- (point) blink-matching-paren-distance))
6089 oldpos))
6090 (let ((parse-sexp-ignore-comments
6091 (and parse-sexp-ignore-comments
6092 (not blink-matching-paren-dont-ignore-comments))))
6093 (condition-case ()
6094 (progn
6095 (forward-sexp -1)
6096 ;; backward-sexp skips backward over prefix chars,
6097 ;; so move back to the matching paren.
6098 (while (and (< (point) (1- oldpos))
6099 (let ((code (syntax-after (point))))
6100 (or (eq (syntax-class code) 6)
6101 (eq (logand 1048576 (car code))
6102 1048576))))
6103 (forward-char 1))
6104 (point))
6105 (error nil))))))
6106 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
6107 (cond
6108 (mismatch
6109 (if blinkpos
6110 (if (minibufferp)
6111 (minibuffer-message "Mismatched parentheses")
6112 (message "Mismatched parentheses"))
6113 (if (minibufferp)
6114 (minibuffer-message "No matching parenthesis found")
6115 (message "No matching parenthesis found"))))
6116 ((not blinkpos) nil)
6117 ((pos-visible-in-window-p blinkpos)
6118 ;; Matching open within window, temporarily move to blinkpos but only
6119 ;; if `blink-matching-paren-on-screen' is non-nil.
6120 (and blink-matching-paren-on-screen
6121 (not show-paren-mode)
6122 (save-excursion
6123 (goto-char blinkpos)
6124 (sit-for blink-matching-delay))))
6125 (t
6126 (save-excursion
6127 (goto-char blinkpos)
6128 (let ((open-paren-line-string
6129 ;; Show what precedes the open in its line, if anything.
6130 (cond
6132 (buffer-substring (line-beginning-position)
6133 (1+ blinkpos)))
6134 ;; Show what follows the open in its line, if anything.
6135 ((save-excursion
6136 (forward-char 1)
6138 (not (eolp)))
6139 (buffer-substring blinkpos
6140 (line-end-position)))
6141 ;; Otherwise show the previous nonblank line,
6142 ;; if there is one.
6144 (concat
6145 (buffer-substring (progn
6147 (line-beginning-position))
6148 (progn (end-of-line)
6150 (point)))
6151 ;; Replace the newline and other whitespace with `...'.
6152 "..."
6153 (buffer-substring blinkpos (1+ blinkpos))))
6154 ;; There is nothing to show except the char itself.
6155 (t (buffer-substring blinkpos (1+ blinkpos))))))
6156 (message "Matches %s"
6157 (substring-no-properties open-paren-line-string)))))))))
6159 (defvar blink-paren-function 'blink-matching-open
6160 "Function called, if non-nil, whenever a close parenthesis is inserted.
6161 More precisely, a char with closeparen syntax is self-inserted.")
6163 (defun blink-paren-post-self-insert-function ()
6164 (when (and (eq (char-before) last-command-event) ; Sanity check.
6165 (memq (char-syntax last-command-event) '(?\) ?\$))
6166 blink-paren-function
6167 (not executing-kbd-macro)
6168 (not noninteractive)
6169 ;; Verify an even number of quoting characters precede the close.
6170 (= 1 (logand 1 (- (point)
6171 (save-excursion
6172 (forward-char -1)
6174 (point))))))
6175 (funcall blink-paren-function)))
6177 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
6178 ;; Most likely, this hook is nil, so this arg doesn't matter,
6179 ;; but I use it as a reminder that this function usually
6180 ;; likes to be run after others since it does `sit-for'.
6181 'append)
6182 \f
6183 ;; This executes C-g typed while Emacs is waiting for a command.
6184 ;; Quitting out of a program does not go through here;
6185 ;; that happens in the QUIT macro at the C code level.
6186 (defun keyboard-quit ()
6187 "Signal a `quit' condition.
6188 During execution of Lisp code, this character causes a quit directly.
6189 At top-level, as an editor command, this simply beeps."
6190 (interactive)
6191 ;; Avoid adding the region to the window selection.
6192 (setq saved-region-selection nil)
6193 (let (select-active-regions)
6194 (deactivate-mark))
6195 (if (fboundp 'kmacro-keyboard-quit)
6196 (kmacro-keyboard-quit))
6197 (setq defining-kbd-macro nil)
6198 (let ((debug-on-quit nil))
6199 (signal 'quit nil)))
6201 (defvar buffer-quit-function nil
6204 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6206 (defun keyboard-escape-quit ()
6208 This command can exit an interactive command such as `query-replace',
6209 can clear out a prefix argument or a region,
6210 can get out of the minibuffer or other recursive edit,
6211 cancel the use of the current buffer (for special-purpose buffers),
6212 or go back to just one window (by deleting all but the selected window)."
6213 (interactive)
6214 (cond ((eq last-command 'mode-exited) nil)
6215 ((region-active-p)
6216 (deactivate-mark))
6217 ((> (minibuffer-depth) 0)
6218 (abort-recursive-edit))
6219 (current-prefix-arg
6220 nil)
6221 ((> (recursion-depth) 0)
6222 (exit-recursive-edit))
6223 (buffer-quit-function
6224 (funcall buffer-quit-function))
6225 ((not (one-window-p t))
6226 (delete-other-windows))
6228 (bury-buffer))))
6230 (defun play-sound-file (file &optional volume device)
6231 "Play sound stored in FILE.
6232 VOLUME and DEVICE correspond to the keywords of the sound
6233 specification for `play-sound'."
6234 (interactive "fPlay sound file: ")
6235 (let ((sound (list :file file)))
6236 (if volume
6237 (plist-put sound :volume volume))
6238 (if device
6239 (plist-put sound :device device))
6240 (push 'sound sound)
6241 (play-sound sound)))
6243 \f
6244 (defcustom read-mail-command 'rmail
6245 "Your preference for a mail reading package.
6246 This is used by some keybindings which support reading mail.
6247 See also `mail-user-agent' concerning sending mail."
6250 (function-item :tag "Emacs interface to MH"
6252 (function :tag "Other"))
6253 :version "21.1"
6254 :group 'mail)
6256 (defcustom mail-user-agent 'message-user-agent
6257 "Your preference for a mail composition package.
6258 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6259 outgoing email message. This variable lets you specify which
6260 mail-sending package you prefer.
6262 Valid values include:
6264 `message-user-agent' -- use the Message package.
6265 See Info node `(message)'.
6266 `sendmail-user-agent' -- use the Mail package.
6267 See Info node `(emacs)Sending Mail'.
6268 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6269 See Info node `(mh-e)'.
6270 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6271 paraphernalia if Gnus is running, particularly
6272 the Gcc: header for archiving.
6274 Additional valid symbols may be available; check with the author of
6275 your package for details. The function should return non-nil if it
6276 succeeds.
6278 See also `read-mail-command' concerning reading mail."
6279 :type '(radio (function-item :tag "Message package"
6281 message-user-agent)
6282 (function-item :tag "Mail package"
6284 sendmail-user-agent)
6285 (function-item :tag "Emacs interface to MH"
6287 mh-e-user-agent)
6288 (function-item :tag "Message with full Gnus features"
6290 gnus-user-agent)
6291 (function :tag "Other"))
6292 :version "23.2" ; sendmail->message
6293 :group 'mail)
6295 (defcustom compose-mail-user-agent-warnings t
6296 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6297 If the value of `mail-user-agent' is the default, and the user
6298 appears to have customizations applying to the old default,
6299 `compose-mail' issues a warning."
6300 :type 'boolean
6301 :version "23.2"
6302 :group 'mail)
6304 (defun rfc822-goto-eoh ()
6305 "If the buffer starts with a mail header, move point to the header's end.
6306 Otherwise, moves to `point-min'.
6307 The end of the header is the start of the next line, if there is one,
6308 else the end of the last line. This function obeys RFC822."
6309 (goto-char (point-min))
6310 (when (re-search-forward
6312 (goto-char (match-beginning 0))))
6314 ;; Used by Rmail (e.g., rmail-forward).
6315 (defvar mail-encode-mml nil
6316 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6317 the outgoing message before sending it.")
6319 (defun compose-mail (&optional to subject other-headers continue
6320 switch-function yank-action send-actions
6321 return-action)
6322 "Start composing a mail message to send.
6323 This uses the user's chosen mail composition package
6324 as selected with the variable `mail-user-agent'.
6325 The optional arguments TO and SUBJECT specify recipients
6326 and the initial Subject field, respectively.
6328 OTHER-HEADERS is an alist specifying additional
6329 header fields. Elements look like (HEADER . VALUE) where both
6330 HEADER and VALUE are strings.
6332 CONTINUE, if non-nil, says to continue editing a message already
6333 being composed. Interactively, CONTINUE is the prefix argument.
6335 SWITCH-FUNCTION, if non-nil, is a function to use to
6336 switch to and display the buffer used for mail composition.
6338 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6339 to insert the raw text of the message being replied to.
6340 It has the form (FUNCTION . ARGS). The user agent will apply
6341 FUNCTION to ARGS, to insert the raw text of the original message.
6342 \(The user agent will also run `mail-citation-hook', *after* the
6343 original text has been inserted in this way.)
6345 SEND-ACTIONS is a list of actions to call when the message is sent.
6346 Each action has the form (FUNCTION . ARGS).
6348 RETURN-ACTION, if non-nil, is an action for returning to the
6349 caller. It has the form (FUNCTION . ARGS). The function is
6350 called after the mail has been sent or put aside, and the mail
6351 buffer buried."
6352 (interactive
6353 (list nil nil nil current-prefix-arg))
6355 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6356 ;; from sendmail-user-agent to message-user-agent. Some users may
6357 ;; encounter incompatibilities. This hack tries to detect problems
6358 ;; and warn about them.
6359 (and compose-mail-user-agent-warnings
6360 (eq mail-user-agent 'message-user-agent)
6361 (let (warn-vars)
6362 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6363 mail-yank-hooks mail-archive-file-name
6364 mail-default-reply-to mail-mailing-lists
6365 mail-self-blind))
6366 (and (boundp var)
6367 (symbol-value var)
6368 (push var warn-vars)))
6369 (when warn-vars
6370 (display-warning 'mail
6371 (format "\
6372 The default mail mode is now Message mode.
6373 You have the following Mail mode variable%s customized:
6375 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6376 (if (> (length warn-vars) 1) "s" "")
6377 (mapconcat 'symbol-name
6378 warn-vars " "))))))
6380 (let ((function (get mail-user-agent 'composefunc)))
6381 (funcall function to subject other-headers continue switch-function
6382 yank-action send-actions return-action)))
6384 (defun compose-mail-other-window (&optional to subject other-headers continue
6385 yank-action send-actions
6386 return-action)
6388 (interactive (list nil nil nil current-prefix-arg))
6389 (compose-mail to subject other-headers continue
6390 'switch-to-buffer-other-window yank-action send-actions
6391 return-action))
6393 (defun compose-mail-other-frame (&optional to subject other-headers continue
6394 yank-action send-actions
6395 return-action)
6397 (interactive (list nil nil nil current-prefix-arg))
6398 (compose-mail to subject other-headers continue
6399 'switch-to-buffer-other-frame yank-action send-actions
6400 return-action))
6402 \f
6403 (defvar set-variable-value-history nil
6404 "History of values entered with `set-variable'.
6406 Maximum length of the history list is determined by the value
6407 of `history-length', which see.")
6409 (defun set-variable (variable value &optional make-local)
6410 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6411 VARIABLE should be a user option variable name, a Lisp variable
6412 meant to be customized by users. You should enter VALUE in Lisp syntax,
6413 so if you want VALUE to be a string, you must surround it with doublequotes.
6414 VALUE is used literally, not evaluated.
6416 If VARIABLE has a `variable-interactive' property, that is used as if
6417 it were the arg to `interactive' (which see) to interactively read VALUE.
6419 If VARIABLE has been defined with `defcustom', then the type information
6420 in the definition is used to check that VALUE is valid.
6422 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6423 (interactive
6424 (let* ((default-var (variable-at-point))
6425 (var (if (custom-variable-p default-var)
6426 (read-variable (format "Set variable (default %s): " default-var)
6427 default-var)
6428 (read-variable "Set variable: ")))
6429 (minibuffer-help-form '(describe-variable var))
6430 (prop (get var 'variable-interactive))
6431 (obsolete (car (get var 'byte-obsolete-variable)))
6432 (prompt (format "Set %s %s to value: " var
6433 (cond ((local-variable-p var)
6434 "(buffer-local)")
6435 ((or current-prefix-arg
6436 (local-variable-if-set-p var))
6437 "buffer-locally")
6438 (t "globally"))))
6439 (val (progn
6440 (when obsolete
6441 (message (concat "`%S' is obsolete; "
6442 (if (symbolp obsolete) "use `%S' instead" "%s"))
6443 var obsolete)
6444 (sit-for 3))
6445 (if prop
6446 ;; Use VAR's `variable-interactive' property
6447 ;; as an interactive spec for prompting.
6448 (call-interactively `(lambda (arg)
6449 (interactive ,prop)
6450 arg))
6451 (read
6452 (read-string prompt nil
6453 'set-variable-value-history
6454 (format "%S" (symbol-value var))))))))
6455 (list var val current-prefix-arg)))
6457 (and (custom-variable-p variable)
6458 (not (get variable 'custom-type))
6459 (custom-load-symbol variable))
6460 (let ((type (get variable 'custom-type)))
6461 (when type
6462 ;; Match with custom type.
6463 (require 'cus-edit)
6464 (setq type (widget-convert type))
6465 (unless (widget-apply type :match value)
6466 (error "Value `%S' does not match type %S of %S"
6467 value (car type) variable))))
6469 (if make-local
6470 (make-local-variable variable))
6472 (set variable value)
6474 ;; Force a thorough redisplay for the case that the variable
6475 ;; has an effect on the display, like `tab-width' has.
6476 (force-mode-line-update))
6477 \f
6478 ;; Define the major mode for lists of completions.
6480 (defvar completion-list-mode-map
6481 (let ((map (make-sparse-keymap)))
6482 (define-key map [mouse-2] 'mouse-choose-completion)
6483 (define-key map [follow-link] 'mouse-face)
6484 (define-key map [down-mouse-2] nil)
6485 (define-key map "\C-m" 'choose-completion)
6486 (define-key map "\e\e\e" 'delete-completion-window)
6487 (define-key map [left] 'previous-completion)
6488 (define-key map [right] 'next-completion)
6489 (define-key map "q" 'quit-window)
6490 (define-key map "z" 'kill-this-buffer)
6491 map)
6492 "Local map for completion list buffers.")
6494 ;; Completion mode is suitable only for specially formatted data.
6495 (put 'completion-list-mode 'mode-class 'special)
6497 (defvar completion-reference-buffer nil
6498 "Record the buffer that was current when the completion list was requested.
6499 This is a local variable in the completion list buffer.
6500 Initial value is nil to avoid some compiler warnings.")
6502 (defvar completion-no-auto-exit nil
6503 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6504 This also applies to other functions such as `choose-completion'.")
6506 (defvar completion-base-position nil
6507 "Position of the base of the text corresponding to the shown completions.
6508 This variable is used in the *Completions* buffers.
6509 Its value is a list of the form (START END) where START is the place
6510 where the completion should be inserted and END (if non-nil) is the end
6511 of the text to replace. If END is nil, point is used instead.")
6513 (defvar completion-list-insert-choice-function #'completion--replace
6514 "Function to use to insert the text chosen in *Completions*.
6515 Called with three arguments (BEG END TEXT), it should replace the text
6516 between BEG and END with TEXT. Expected to be set buffer-locally
6517 in the *Completions* buffer.")
6519 (defvar completion-base-size nil
6520 "Number of chars before point not involved in completion.
6521 This is a local variable in the completion list buffer.
6522 It refers to the chars in the minibuffer if completing in the
6523 minibuffer, or in `completion-reference-buffer' otherwise.
6524 Only characters in the field at point are included.
6526 If nil, Emacs determines which part of the tail end of the
6527 buffer's text is involved in completion by comparing the text
6528 directly.")
6529 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6531 (defun delete-completion-window ()
6532 "Delete the completion list window.
6533 Go to the window from which completion was requested."
6534 (interactive)
6535 (let ((buf completion-reference-buffer))
6536 (if (one-window-p t)
6537 (if (window-dedicated-p (selected-window))
6538 (delete-frame (selected-frame)))
6539 (delete-window (selected-window))
6540 (if (get-buffer-window buf)
6541 (select-window (get-buffer-window buf))))))
6543 (defun previous-completion (n)
6544 "Move to the previous item in the completion list."
6545 (interactive "p")
6546 (next-completion (- n)))
6548 (defun next-completion (n)
6549 "Move to the next item in the completion list.
6550 With prefix argument N, move N items (negative N means move backward)."
6551 (interactive "p")
6552 (let ((beg (point-min)) (end (point-max)))
6553 (while (and (> n 0) (not (eobp)))
6554 ;; If in a completion, move to the end of it.
6555 (when (get-text-property (point) 'mouse-face)
6556 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6557 ;; Move to start of next one.
6558 (unless (get-text-property (point) 'mouse-face)
6559 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6560 (setq n (1- n)))
6561 (while (and (< n 0) (not (bobp)))
6562 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6563 ;; If in a completion, move to the start of it.
6564 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6565 (goto-char (previous-single-property-change
6566 (point) 'mouse-face nil beg)))
6567 ;; Move to end of the previous completion.
6568 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6569 (goto-char (previous-single-property-change
6570 (point) 'mouse-face nil beg)))
6571 ;; Move to the start of that one.
6572 (goto-char (previous-single-property-change
6573 (point) 'mouse-face nil beg))
6574 (setq n (1+ n))))))
6576 (defun choose-completion (&optional event)
6577 "Choose the completion at point."
6578 (interactive (list last-nonmenu-event))
6579 ;; In case this is run via the mouse, give temporary modes such as
6580 ;; isearch a chance to turn off.
6581 (run-hooks 'mouse-leave-buffer-hook)
6582 (with-current-buffer (window-buffer (posn-window (event-start event)))
6583 (let ((buffer completion-reference-buffer)
6584 (base-size completion-base-size)
6585 (base-position completion-base-position)
6586 (insert-function completion-list-insert-choice-function)
6587 (choice
6588 (save-excursion
6589 (goto-char (posn-point (event-start event)))
6590 (let (beg end)
6591 (cond
6592 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6593 (setq end (point) beg (1+ (point))))
6594 ((and (not (bobp))
6595 (get-text-property (1- (point)) 'mouse-face))
6596 (setq end (1- (point)) beg (point)))
6597 (t (error "No completion here")))
6598 (setq beg (previous-single-property-change beg 'mouse-face))
6599 (setq end (or (next-single-property-change end 'mouse-face)
6600 (point-max)))
6601 (buffer-substring-no-properties beg end)))))
6603 (unless (buffer-live-p buffer)
6604 (error "Destination buffer is dead"))
6605 (quit-window nil (posn-window (event-start event)))
6607 (with-current-buffer buffer
6608 (choose-completion-string
6609 choice buffer
6610 (or base-position
6611 (when base-size
6612 ;; Someone's using old completion code that doesn't know
6613 ;; about base-position yet.
6614 (list (+ base-size (field-beginning))))
6615 ;; If all else fails, just guess.
6616 (list (choose-completion-guess-base-position choice)))
6617 insert-function)))))
6619 ;; Delete the longest partial match for STRING
6620 ;; that can be found before POINT.
6621 (defun choose-completion-guess-base-position (string)
6622 (save-excursion
6623 (let ((opoint (point))
6624 len)
6625 ;; Try moving back by the length of the string.
6626 (goto-char (max (- (point) (length string))
6627 (minibuffer-prompt-end)))
6628 ;; See how far back we were actually able to move. That is the
6629 ;; upper bound on how much we can match and delete.
6630 (setq len (- opoint (point)))
6631 (if completion-ignore-case
6632 (setq string (downcase string)))
6633 (while (and (> len 0)
6634 (let ((tail (buffer-substring (point) opoint)))
6635 (if completion-ignore-case
6636 (setq tail (downcase tail)))
6637 (not (string= tail (substring string 0 len)))))
6638 (setq len (1- len))
6639 (forward-char 1))
6640 (point))))
6642 (defun choose-completion-delete-max-match (string)
6643 (declare (obsolete choose-completion-guess-base-position "23.2"))
6644 (delete-region (choose-completion-guess-base-position string) (point)))
6646 (defvar choose-completion-string-functions nil
6647 "Functions that may override the normal insertion of a completion choice.
6648 These functions are called in order with four arguments:
6649 CHOICE - the string to insert in the buffer,
6650 BUFFER - the buffer in which the choice should be inserted,
6651 MINI-P - non-nil if BUFFER is a minibuffer, and
6652 BASE-SIZE - the number of characters in BUFFER before
6653 the string being completed.
6655 If a function in the list returns non-nil, that function is supposed
6656 to have inserted the CHOICE in the BUFFER, and possibly exited
6657 the minibuffer; no further functions will be called.
6659 If all functions in the list return nil, that means to use
6660 the default method of inserting the completion in BUFFER.")
6662 (defun choose-completion-string (choice &optional
6663 buffer base-position insert-function)
6664 "Switch to BUFFER and insert the completion choice CHOICE.
6665 BASE-POSITION says where to insert the completion.
6666 INSERT-FUNCTION says how to insert the completion and falls
6667 back on `completion-list-insert-choice-function' when nil."
6669 ;; If BUFFER is the minibuffer, exit the minibuffer
6670 ;; unless it is reading a file name and CHOICE is a directory,
6671 ;; or completion-no-auto-exit is non-nil.
6673 ;; Some older code may call us passing `base-size' instead of
6674 ;; `base-position'. It's difficult to make any use of `base-size',
6675 ;; so we just ignore it.
6676 (unless (consp base-position)
6677 (message "Obsolete `base-size' passed to choose-completion-string")
6678 (setq base-position nil))
6680 (let* ((buffer (or buffer completion-reference-buffer))
6681 (mini-p (minibufferp buffer)))
6682 ;; If BUFFER is a minibuffer, barf unless it's the currently
6683 ;; active minibuffer.
6684 (if (and mini-p
6685 (not (and (active-minibuffer-window)
6686 (equal buffer
6687 (window-buffer (active-minibuffer-window))))))
6688 (error "Minibuffer is not active for completion")
6689 ;; Set buffer so buffer-local choose-completion-string-functions works.
6690 (set-buffer buffer)
6691 (unless (run-hook-with-args-until-success
6692 'choose-completion-string-functions
6693 ;; The fourth arg used to be `mini-p' but was useless
6694 ;; (since minibufferp can be used on the `buffer' arg)
6695 ;; and indeed unused. The last used to be `base-size', so we
6696 ;; keep it to try and avoid breaking old code.
6697 choice buffer base-position nil)
6698 ;; This remove-text-properties should be unnecessary since `choice'
6699 ;; comes from buffer-substring-no-properties.
6700 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6701 ;; Insert the completion into the buffer where it was requested.
6702 (funcall (or insert-function completion-list-insert-choice-function)
6703 (or (car base-position) (point))
6704 (or (cadr base-position) (point))
6705 choice)
6706 ;; Update point in the window that BUFFER is showing in.
6707 (let ((window (get-buffer-window buffer t)))
6708 (set-window-point window (point)))
6709 ;; If completing for the minibuffer, exit it with this choice.
6710 (and (not completion-no-auto-exit)
6711 (minibufferp buffer)
6712 minibuffer-completion-table
6713 ;; If this is reading a file name, and the file name chosen
6714 ;; is a directory, don't exit the minibuffer.
6715 (let* ((result (buffer-substring (field-beginning) (point)))
6716 (bounds
6717 (completion-boundaries result minibuffer-completion-table
6718 minibuffer-completion-predicate
6719 "")))
6720 (if (eq (car bounds) (length result))
6721 ;; The completion chosen leads to a new set of completions
6722 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6723 (let ((mini (active-minibuffer-window)))
6724 (select-window mini)
6725 (when minibuffer-auto-raise
6726 (raise-frame (window-frame mini))))
6727 (exit-minibuffer))))))))
6729 (define-derived-mode completion-list-mode nil "Completion List"
6730 "Major mode for buffers showing lists of possible completions.
6732 to select the completion near point.
6734 with the mouse.
6737 (set (make-local-variable 'completion-base-size) nil))
6739 (defun completion-list-mode-finish ()
6740 "Finish setup of the completions buffer.
6741 Called from `temp-buffer-show-hook'."
6742 (when (eq major-mode 'completion-list-mode)
6743 (setq buffer-read-only t)))
6745 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6748 ;; Variables and faces used in `completion-setup-function'.
6750 (defcustom completion-show-help t
6751 "Non-nil means show help message in *Completions* buffer."
6752 :type 'boolean
6753 :version "22.1"
6754 :group 'completion)
6756 ;; This function goes in completion-setup-hook, so that it is called
6757 ;; after the text of the completion list buffer is written.
6758 (defun completion-setup-function ()
6759 (let* ((mainbuf (current-buffer))
6760 (base-dir
6761 ;; FIXME: This is a bad hack. We try to set the default-directory
6762 ;; in the *Completions* buffer so that the relative file names
6763 ;; displayed there can be treated as valid file names, independently
6764 ;; from the completion context. But this suffers from many problems:
6765 ;; - It's not clear when the completions are file names. With some
6766 ;; completion tables (e.g. bzr revision specs), the listed
6767 ;; completions can mix file names and other things.
6768 ;; - It doesn't pay attention to possible quoting.
6769 ;; - With fancy completion styles, the code below will not always
6770 ;; find the right base directory.
6771 (if minibuffer-completing-file-name
6772 (file-name-as-directory
6773 (expand-file-name
6774 (buffer-substring (minibuffer-prompt-end)
6775 (- (point) (or completion-base-size 0))))))))
6776 (with-current-buffer standard-output
6777 (let ((base-size completion-base-size) ;Read before killing localvars.
6778 (base-position completion-base-position)
6779 (insert-fun completion-list-insert-choice-function))
6780 (completion-list-mode)
6781 (set (make-local-variable 'completion-base-size) base-size)
6782 (set (make-local-variable 'completion-base-position) base-position)
6783 (set (make-local-variable 'completion-list-insert-choice-function)
6784 insert-fun))
6785 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6786 (if base-dir (setq default-directory base-dir))
6787 ;; Maybe insert help string.
6788 (when completion-show-help
6789 (goto-char (point-min))
6790 (if (display-mouse-p)
6791 (insert (substitute-command-keys
6793 (insert (substitute-command-keys
6797 (add-hook 'completion-setup-hook 'completion-setup-function)
6799 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6800 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6802 (defun switch-to-completions ()
6803 "Select the completion list window."
6804 (interactive)
6805 (let ((window (or (get-buffer-window "*Completions*" 0)
6806 ;; Make sure we have a completions window.
6807 (progn (minibuffer-completion-help)
6808 (get-buffer-window "*Completions*" 0)))))
6809 (when window
6810 (select-window window)
6811 ;; In the new buffer, go to the first completion.
6812 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6813 (when (bobp)
6814 (next-completion 1)))))
6815 \f
6816 ;;; Support keyboard commands to turn on various modifiers.
6818 ;; These functions -- which are not commands -- each add one modifier
6819 ;; to the following event.
6821 (defun event-apply-alt-modifier (_ignore-prompt)
6824 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6825 (defun event-apply-super-modifier (_ignore-prompt)
6828 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6829 (defun event-apply-hyper-modifier (_ignore-prompt)
6832 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6833 (defun event-apply-shift-modifier (_ignore-prompt)
6836 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6837 (defun event-apply-control-modifier (_ignore-prompt)
6840 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6841 (defun event-apply-meta-modifier (_ignore-prompt)
6844 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6846 (defun event-apply-modifier (event symbol lshiftby prefix)
6847 "Apply a modifier flag to event EVENT.
6848 SYMBOL is the name of this modifier, as a symbol.
6849 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6850 PREFIX is the string that represents this modifier in an event type symbol."
6851 (if (numberp event)
6852 (cond ((eq symbol 'control)
6853 (if (and (<= (downcase event) ?z)
6854 (>= (downcase event) ?a))
6855 (- (downcase event) ?a -1)
6856 (if (and (<= (downcase event) ?Z)
6857 (>= (downcase event) ?A))
6858 (- (downcase event) ?A -1)
6859 (logior (lsh 1 lshiftby) event))))
6860 ((eq symbol 'shift)
6861 (if (and (<= (downcase event) ?z)
6862 (>= (downcase event) ?a))
6863 (upcase event)
6864 (logior (lsh 1 lshiftby) event)))
6865 (t
6866 (logior (lsh 1 lshiftby) event)))
6867 (if (memq symbol (event-modifiers event))
6868 event
6869 (let ((event-type (if (symbolp event) event (car event))))
6870 (setq event-type (intern (concat prefix (symbol-name event-type))))
6871 (if (symbolp event)
6872 event-type
6873 (cons event-type (cdr event)))))))
6875 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6876 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6877 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6878 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6879 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6880 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6881 \f
6882 ;;;; Keypad support.
6884 ;; Make the keypad keys act like ordinary typing keys. If people add
6885 ;; bindings for the function key symbols, then those bindings will
6886 ;; override these, so this shouldn't interfere with any existing
6887 ;; bindings.
6889 ;; Also tell read-char how to handle these keys.
6890 (mapc
6891 (lambda (keypad-normal)
6892 (let ((keypad (nth 0 keypad-normal))
6893 (normal (nth 1 keypad-normal)))
6894 (put keypad 'ascii-character normal)
6895 (define-key function-key-map (vector keypad) (vector normal))))
6896 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6897 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6898 (kp-space ?\s)
6901 (kp-multiply ?*)
6902 (kp-add ?+)
6903 (kp-separator ?,)
6904 (kp-subtract ?-)
6905 (kp-decimal ?.)
6906 (kp-divide ?/)
6907 (kp-equal ?=)
6908 ;; Do the same for various keys that are represented as symbols under
6909 ;; GUIs but naturally correspond to characters.
6910 (backspace 127)
6911 (delete 127)
6914 (clear ?\C-l)
6915 (return ?\C-m)
6916 (escape ?\e)
6917 ))
6918 \f
6919 ;;;;
6920 ;;;; forking a twin copy of a buffer.
6921 ;;;;
6923 (defvar clone-buffer-hook nil
6924 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6926 (defvar clone-indirect-buffer-hook nil
6927 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6929 (defun clone-process (process &optional newname)
6930 "Create a twin copy of PROCESS.
6931 If NEWNAME is nil, it defaults to PROCESS' name;
6932 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6933 If PROCESS is associated with a buffer, the new process will be associated
6934 with the current buffer instead.
6935 Returns nil if PROCESS has already terminated."
6936 (setq newname (or newname (process-name process)))
6938 (setq newname (substring newname 0 (match-beginning 0))))
6939 (when (memq (process-status process) '(run stop open))
6940 (let* ((process-connection-type (process-tty-name process))
6941 (new-process
6942 (if (memq (process-status process) '(open))
6943 (let ((args (process-contact process t)))
6944 (setq args (plist-put args :name newname))
6945 (setq args (plist-put args :buffer
6946 (if (process-buffer process)
6947 (current-buffer))))
6948 (apply 'make-network-process args))
6949 (apply 'start-process newname
6950 (if (process-buffer process) (current-buffer))
6951 (process-command process)))))
6952 (set-process-query-on-exit-flag
6953 new-process (process-query-on-exit-flag process))
6954 (set-process-inherit-coding-system-flag
6955 new-process (process-inherit-coding-system-flag process))
6956 (set-process-filter new-process (process-filter process))
6957 (set-process-sentinel new-process (process-sentinel process))
6958 (set-process-plist new-process (copy-sequence (process-plist process)))
6959 new-process)))
6961 ;; things to maybe add (currently partly covered by `funcall mode'):
6962 ;; - syntax-table
6963 ;; - overlays
6964 (defun clone-buffer (&optional newname display-flag)
6965 "Create and return a twin copy of the current buffer.
6966 Unlike an indirect buffer, the new buffer can be edited
6967 independently of the old one (if it is not read-only).
6968 NEWNAME is the name of the new buffer. It may be modified by
6969 adding or incrementing <N> at the end as necessary to create a
6970 unique buffer name. If nil, it defaults to the name of the
6971 current buffer, with the proper suffix. If DISPLAY-FLAG is
6972 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6973 clone a file-visiting buffer, or a buffer whose major mode symbol
6974 has a non-nil `no-clone' property, results in an error.
6976 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6977 current buffer with appropriate suffix. However, if a prefix
6978 argument is given, then the command prompts for NEWNAME in the
6979 minibuffer.
6981 This runs the normal hook `clone-buffer-hook' in the new buffer
6982 after it has been set up properly in other respects."
6983 (interactive
6984 (progn
6985 (if buffer-file-name
6986 (error "Cannot clone a file-visiting buffer"))
6987 (if (get major-mode 'no-clone)
6988 (error "Cannot clone a buffer in %s mode" mode-name))
6989 (list (if current-prefix-arg
6990 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6991 t)))
6992 (if buffer-file-name
6993 (error "Cannot clone a file-visiting buffer"))
6994 (if (get major-mode 'no-clone)
6995 (error "Cannot clone a buffer in %s mode" mode-name))
6996 (setq newname (or newname (buffer-name)))
6998 (setq newname (substring newname 0 (match-beginning 0))))
6999 (let ((buf (current-buffer))
7000 (ptmin (point-min))
7001 (ptmax (point-max))
7002 (pt (point))
7003 (mk (if mark-active (mark t)))
7004 (modified (buffer-modified-p))
7005 (mode major-mode)
7006 (lvars (buffer-local-variables))
7007 (process (get-buffer-process (current-buffer)))
7008 (new (generate-new-buffer (or newname (buffer-name)))))
7009 (save-restriction
7010 (widen)
7011 (with-current-buffer new
7012 (insert-buffer-substring buf)))
7013 (with-current-buffer new
7014 (narrow-to-region ptmin ptmax)
7015 (goto-char pt)
7016 (if mk (set-mark mk))
7017 (set-buffer-modified-p modified)
7019 ;; Clone the old buffer's process, if any.
7020 (when process (clone-process process))
7022 ;; Now set up the major mode.
7023 (funcall mode)
7025 ;; Set up other local variables.
7026 (mapc (lambda (v)
7027 (condition-case () ;in case var is read-only
7028 (if (symbolp v)
7029 (makunbound v)
7030 (set (make-local-variable (car v)) (cdr v)))
7031 (error nil)))
7032 lvars)
7034 ;; Run any hooks (typically set up by the major mode
7035 ;; for cloning to work properly).
7036 (run-hooks 'clone-buffer-hook))
7037 (if display-flag
7038 ;; Presumably the current buffer is shown in the selected frame, so
7039 ;; we want to display the clone elsewhere.
7040 (let ((same-window-regexps nil)
7041 (same-window-buffer-names))
7042 (pop-to-buffer new)))
7043 new))
7046 (defun clone-indirect-buffer (newname display-flag &optional norecord)
7047 "Create an indirect buffer that is a twin copy of the current buffer.
7049 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7050 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7051 or if not called with a prefix arg, NEWNAME defaults to the current
7052 buffer's name. The name is modified by adding a `<N>' suffix to it
7053 or by incrementing the N in an existing suffix. Trying to clone a
7054 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7055 property results in an error.
7057 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7058 This is always done when called interactively.
7060 Optional third arg NORECORD non-nil means do not put this buffer at the
7061 front of the list of recently selected ones."
7062 (interactive
7063 (progn
7064 (if (get major-mode 'no-clone-indirect)
7065 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7066 (list (if current-prefix-arg
7067 (read-buffer "Name of indirect buffer: " (current-buffer)))
7068 t)))
7069 (if (get major-mode 'no-clone-indirect)
7070 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7071 (setq newname (or newname (buffer-name)))
7073 (setq newname (substring newname 0 (match-beginning 0))))
7074 (let* ((name (generate-new-buffer-name newname))
7075 (buffer (make-indirect-buffer (current-buffer) name t)))
7076 (with-current-buffer buffer
7077 (run-hooks 'clone-indirect-buffer-hook))
7078 (when display-flag
7079 (pop-to-buffer buffer norecord))
7080 buffer))
7083 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7084 "Like `clone-indirect-buffer' but display in another window."
7085 (interactive
7086 (progn
7087 (if (get major-mode 'no-clone-indirect)
7088 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7089 (list (if current-prefix-arg
7090 (read-buffer "Name of indirect buffer: " (current-buffer)))
7091 t)))
7092 (let ((pop-up-windows t))
7093 (clone-indirect-buffer newname display-flag norecord)))
7095 \f
7096 ;;; Handling of Backspace and Delete keys.
7098 (defcustom normal-erase-is-backspace 'maybe
7099 "Set the default behavior of the Delete and Backspace keys.
7101 If set to t, Delete key deletes forward and Backspace key deletes
7102 backward.
7104 If set to nil, both Delete and Backspace keys delete backward.
7106 If set to 'maybe (which is the default), Emacs automatically
7107 selects a behavior. On window systems, the behavior depends on
7108 the keyboard used. If the keyboard has both a Backspace key and
7109 a Delete key, and both are mapped to their usual meanings, the
7110 option's default value is set to t, so that Backspace can be used
7111 to delete backward, and Delete can be used to delete forward.
7113 If not running under a window system, customizing this option
7114 accomplishes a similar effect by mapping C-h, which is usually
7115 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7116 via `keyboard-translate'. The former functionality of C-h is
7117 available on the F1 key. You should probably not use this
7118 setting if you don't have both Backspace, Delete and F1 keys.
7120 Setting this variable with setq doesn't take effect. Programmatically,
7121 call `normal-erase-is-backspace-mode' (which see) instead."
7122 :type '(choice (const :tag "Off" nil)
7123 (const :tag "Maybe" maybe)
7124 (other :tag "On" t))
7125 :group 'editing-basics
7126 :version "21.1"
7127 :set (lambda (symbol value)
7128 ;; The fboundp is because of a problem with :set when
7129 ;; dumping Emacs. It doesn't really matter.
7130 (if (fboundp 'normal-erase-is-backspace-mode)
7131 (normal-erase-is-backspace-mode (or value 0))
7132 (set-default symbol value))))
7134 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7135 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7136 (unless frame (setq frame (selected-frame)))
7137 (with-selected-frame frame
7138 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7139 (normal-erase-is-backspace-mode
7140 (if (if (eq normal-erase-is-backspace 'maybe)
7141 (and (not noninteractive)
7142 (or (memq system-type '(ms-dos windows-nt))
7143 (memq window-system '(w32 ns))
7144 (and (memq window-system '(x))
7145 (fboundp 'x-backspace-delete-keys-p)
7146 (x-backspace-delete-keys-p))
7147 ;; If the terminal Emacs is running on has erase char
7148 ;; set to ^H, use the Backspace key for deleting
7149 ;; backward, and the Delete key for deleting forward.
7150 (and (null window-system)
7151 (eq tty-erase-char ?\^H))))
7152 normal-erase-is-backspace)
7153 1 0)))))
7155 (define-minor-mode normal-erase-is-backspace-mode
7156 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7157 With a prefix argument ARG, enable this feature if ARG is
7158 positive, and disable it otherwise. If called from Lisp, enable
7159 the mode if ARG is omitted or nil.
7161 On window systems, when this mode is on, Delete is mapped to C-d
7162 and Backspace is mapped to DEL; when this mode is off, both
7163 Delete and Backspace are mapped to DEL. (The remapping goes via
7164 `local-function-key-map', so binding Delete or Backspace in the
7165 global or local keymap will override that.)
7167 In addition, on window systems, the bindings of C-Delete, M-Delete,
7168 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7169 the global keymap in accordance with the functionality of Delete and
7170 Backspace. For example, if Delete is remapped to C-d, which deletes
7171 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7172 to DEL, which deletes backward, C-Delete is bound to
7173 `backward-kill-word'.
7175 If not running on a window system, a similar effect is accomplished by
7176 remapping C-h (normally produced by the Backspace key) and DEL via
7177 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7178 to C-d; if it's off, the keys are not remapped.
7180 When not running on a window system, and this mode is turned on, the
7181 former functionality of C-h is available on the F1 key. You should
7182 probably not turn on this mode on a text-only terminal if you don't
7183 have both Backspace, Delete and F1 keys.
7185 See also `normal-erase-is-backspace'."
7186 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7187 . (lambda (v)
7188 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7189 (if v 1 0))))
7190 (let ((enabled (eq 1 (terminal-parameter
7191 nil 'normal-erase-is-backspace))))
7193 (cond ((or (memq window-system '(x w32 ns pc))
7194 (memq system-type '(ms-dos windows-nt)))
7195 (let ((bindings
7196 `(([M-delete] [M-backspace])
7197 ([C-M-delete] [C-M-backspace])
7198 ([?\e C-delete] [?\e C-backspace]))))
7200 (if enabled
7201 (progn
7202 (define-key local-function-key-map [delete] [deletechar])
7203 (define-key local-function-key-map [kp-delete] [?\C-d])
7204 (define-key local-function-key-map [backspace] [?\C-?])
7205 (dolist (b bindings)
7206 ;; Not sure if input-decode-map is really right, but
7207 ;; keyboard-translate-table (used below) only works
7208 ;; for integer events, and key-translation-table is
7209 ;; global (like the global-map, used earlier).
7210 (define-key input-decode-map (car b) nil)
7211 (define-key input-decode-map (cadr b) nil)))
7212 (define-key local-function-key-map [delete] [?\C-?])
7213 (define-key local-function-key-map [kp-delete] [?\C-?])
7214 (define-key local-function-key-map [backspace] [?\C-?])
7215 (dolist (b bindings)
7216 (define-key input-decode-map (car b) (cadr b))
7217 (define-key input-decode-map (cadr b) (car b))))))
7218 (t
7219 (if enabled
7220 (progn
7221 (keyboard-translate ?\C-h ?\C-?)
7222 (keyboard-translate ?\C-? ?\C-d))
7223 (keyboard-translate ?\C-h ?\C-h)
7224 (keyboard-translate ?\C-? ?\C-?))))
7226 (if (called-interactively-p 'interactive)
7227 (message "Delete key deletes %s"
7228 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7229 "forward" "backward")))))
7230 \f
7231 (defvar vis-mode-saved-buffer-invisibility-spec nil
7232 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7234 (define-minor-mode read-only-mode
7235 "Change whether the current buffer is read-only.
7236 With prefix argument ARG, make the buffer read-only if ARG is
7237 positive, otherwise make it writable. If buffer is read-only
7238 and `view-read-only' is non-nil, enter view mode.
7240 Do not call this from a Lisp program unless you really intend to
7242 possibly enabling or disabling View mode. Also, note that this
7243 command works by setting the variable `buffer-read-only', which
7244 does not affect read-only regions caused by text properties. To
7245 ignore read-only status in a Lisp program (whether due to text
7246 properties or buffer state), bind `inhibit-read-only' temporarily
7247 to a non-nil value."
7248 :variable buffer-read-only
7249 (cond
7250 ((and (not buffer-read-only) view-mode)
7251 (View-exit-and-edit)
7252 (make-local-variable 'view-read-only)
7253 (setq view-read-only t)) ; Must leave view mode.
7254 ((and buffer-read-only view-read-only
7255 ;; If view-mode is already active, `view-mode-enter' is a nop.
7256 (not view-mode)
7257 (not (eq (get major-mode 'mode-class) 'special)))
7258 (view-mode-enter))))
7260 (define-minor-mode visible-mode
7261 "Toggle making all invisible text temporarily visible (Visible mode).
7262 With a prefix argument ARG, enable Visible mode if ARG is
7263 positive, and disable it otherwise. If called from Lisp, enable
7264 the mode if ARG is omitted or nil.
7266 This mode works by saving the value of `buffer-invisibility-spec'
7267 and setting it to nil."
7268 :lighter " Vis"
7269 :group 'editing-basics
7270 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7271 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7272 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7273 (when visible-mode
7274 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7275 buffer-invisibility-spec)
7276 (setq buffer-invisibility-spec nil)))
7277 \f
7278 ;; Minibuffer prompt stuff.
7280 ;;(defun minibuffer-prompt-modification (start end)
7281 ;; (error "You cannot modify the prompt"))
7282 ;;
7283 ;;
7284 ;;(defun minibuffer-prompt-insertion (start end)
7285 ;; (let ((inhibit-modification-hooks t))
7286 ;; (delete-region start end)
7287 ;; ;; Discard undo information for the text insertion itself
7288 ;; ;; and for the text deletion.above.
7289 ;; (when (consp buffer-undo-list)
7290 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7291 ;; (message "You cannot modify the prompt")))
7292 ;;
7293 ;;
7294 ;;(setq minibuffer-prompt-properties
7295 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7296 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7298 \f
7299 ;;;; Problematic external packages.
7301 ;; rms says this should be done by specifying symbols that define
7302 ;; versions together with bad values. This is therefore not as
7303 ;; flexible as it could be. See the thread:
7304 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7305 (defconst bad-packages-alist
7306 ;; Not sure exactly which semantic versions have problems.
7307 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7309 "The version of `semantic' loaded does not work in Emacs 22.
7310 It can cause constant high CPU load.
7311 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7312 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7313 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7314 ;; provided the `CUA-mode' feature. Since this is no longer true,
7315 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7316 (CUA-mode t nil
7317 "CUA-mode is now part of the standard GNU Emacs distribution,
7318 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7320 You have loaded an older version of CUA-mode which does not work
7321 correctly with this version of Emacs. You should remove the old
7322 version and use the one distributed with Emacs."))
7323 "Alist of packages known to cause problems in this version of Emacs.
7324 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7325 PACKAGE is either a regular expression to match file names, or a
7326 symbol (a feature name); see the documentation of
7327 `after-load-alist', to which this variable adds functions.
7328 SYMBOL is either the name of a string variable, or `t'. Upon
7329 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7330 warning using STRING as the message.")
7332 (defun bad-package-check (package)
7333 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7334 (condition-case nil
7335 (let* ((list (assoc package bad-packages-alist))
7336 (symbol (nth 1 list)))
7337 (and list
7338 (boundp symbol)
7339 (or (eq symbol t)
7340 (and (stringp (setq symbol (eval symbol)))
7341 (string-match-p (nth 2 list) symbol)))
7342 (display-warning package (nth 3 list) :warning)))
7343 (error nil)))
7345 (mapc (lambda (elem)
7346 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7347 bad-packages-alist)
7350 (provide 'simple)
7352 ;;; simple.el ends here