| blob | 5fda90210049620486b0fa2ad4bbaa562d88d053 |
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."
391 "Major mode for editing programming language source code."
394 ;; Any programming language is always written left to right.
397 ;; Making and deleting lines.
403 "Insert a newline, and move to left margin of the new line if it's blank.
404 If option `use-hard-newlines' is non-nil, the newline is marked with the
405 text-property `hard'.
406 With ARG, insert that many newlines.
407 Call `auto-fill-function' if the current column number is greater
408 than the value of `fill-column' and ARG is nil."
411 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
412 ;; Set last-command-event to tell self-insert what to insert.
416 ;; Don't auto-fill if we have a numeric argument.
419 ;; Do the rest in post-self-insert-hook, because we want to do it
420 ;; *before* other functions on that hook.
422 ;; Mark the newline(s) `hard'.
426 ;; If the newline leaves the previous line blank, and we
427 ;; have a left margin, delete that from the blank line.
435 ;; Indent the line after the newline, except in one case:
436 ;; when we added the newline at the beginning of a line which
437 ;; starts a page.
444 ;; We first used let-binding to protect the hook, but that was naive
445 ;; since add-hook affects the symbol-default value of the variable,
446 ;; whereas the let-binding might only protect the buffer-local value.
448 nil)
453 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
459 "Insert a newline and leave point before it.
460 If there is a fill prefix and/or a `left-margin', insert them
461 on the new line if the line would have been blank.
462 With arg N, insert N newlines."
467 ;; Don't expand an abbrev before point.
481 "Split current line, moving portion beyond point vertically down.
482 If the current line starts with `fill-prefix', insert it on the new
483 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
485 When called from Lisp code, ARG may be a prefix string to copy."
490 ;; What prefix should we check for (nil means don't).
494 ;; Does this line start with it?
505 "Join this line to previous and fix up whitespace at join.
506 If there is a fill prefix, delete it from the beginning of this line.
507 With argument, join this line to following line."
514 ;; If the second line started with the fill prefix,
515 ;; delete the prefix.
527 "On blank line, delete all surrounding blank lines, leaving just one.
528 On isolated blank line, delete that one.
529 On nonblank line, delete any immediately following blank lines."
535 ;; Set singleblank if there is just one blank line here.
542 ;; Delete preceding blank lines, and this one too if it's the only one.
551 ;; Delete following blank lines, unless the current line is blank
552 ;; and there are no following blank lines.
561 ;; Handle the special case where point is followed by newline and eob.
562 ;; Delete the line, leaving point at eob.
568 Trailing lines are deleted only if `delete-trailing-whitespace'
569 is called on the entire buffer (rather than an active region)."
575 "Delete trailing whitespace between START and END.
576 If called interactively, START and END are the start/end of the
577 region if the mark is active, or of the buffer's accessible
578 portion if the mark is inactive.
580 This command deletes whitespace characters after the last
581 non-whitespace character in each line between START and END. It
582 does not consider formfeed characters to be whitespace.
584 If this command acts on the entire buffer (i.e. if called
585 interactively with the mark inactive, or called from Lisp with
586 END nil), it also deletes all trailing lines at the end of the
587 buffer if the variable `delete-trailing-lines' is non-nil."
600 ;; Don't delete formfeeds, even if they are considered whitespace.
604 ;; Delete trailing empty lines.
607 delete-trailing-lines
608 ;; Really the end of buffer.
613 ;; Return nil for the benefit of `write-file-functions'.
614 nil)
617 "Insert a newline, then indent according to major mode.
618 Indentation is done using the value of `indent-line-function'.
619 In programming language modes, this is the same as TAB.
620 In some text modes, where TAB inserts a tab, this command indents to the
621 column specified by the function `current-left-margin'."
628 "Reindent current line, insert newline, then indent the new line.
629 Indentation of both lines is done according to the current major mode,
630 which means calling the current value of `indent-line-function'.
631 In programming language modes, this is the same as TAB.
632 In some text modes, where TAB inserts a tab, this indents to the
633 column specified by the function `current-left-margin'."
636 ;; Be careful to insert the newline before indenting the line.
637 ;; Otherwise, the indentation might be wrong.
641 ;; We are at EOL before the call to indent-according-to-mode, and
642 ;; after it we usually are as well, but not always. We tried to
643 ;; address it with `save-excursion' but that uses a normal marker
644 ;; whereas we need `move after insertion', so we do the save/restore
645 ;; by hand.
649 ;; Remove the trailing white-space after indentation because
650 ;; indentation may introduce the whitespace.
655 "Read next input character and insert it.
656 This is useful for inserting control characters.
657 With argument, insert ARG copies of the character.
659 If the first character you type after this command is an octal digit,
660 you should type a sequence of octal digits which specify a character code.
661 Any nondigit terminates the sequence. If the terminator is a RET,
662 it is discarded; any other terminator is used itself as input.
663 The variable `read-quoted-char-radix' specifies the radix for this feature;
664 set it to 10 or 16 to use decimal or hex instead of octal.
666 In overwrite mode, this function inserts the character anyway, and
667 does not handle octal digits specially. This means that if you use
668 overwrite as your normal editing mode, you can use this function to
669 insert characters when necessary.
671 In binary overwrite mode, this function does overwrite, and octal
672 digits are interpreted as a character code. This is intended to be
673 useful for editing binary files."
676 ;; Avoid "obsolete" warnings for translation-table-for-input.
683 ;; This used to assume character codes 0240 - 0377 stand for
684 ;; characters in some single-byte character set, and converted them
685 ;; to Emacs characters. But in 23.1 this feature is deprecated
686 ;; in favor of inserting the corresponding Unicode characters.
687 ;; (if (and enable-multibyte-characters
688 ;; (>= char ?\240)
689 ;; (<= char ?\377))
690 ;; (setq char (unibyte-char-to-multibyte char)))
699 "Move forward ARG lines and position at first nonblank character."
705 "Move backward ARG lines and position at first nonblank character."
711 "Move point to the first non-whitespace character on this line."
715 ;; Move back over chars that have whitespace syntax but have the p flag.
719 "Fixup white space between objects around point.
720 Leave one space or none, according to the context."
727 nil
731 "Delete all spaces and tabs around point.
732 If BACKWARD-ONLY is non-nil, only delete them before point."
737 orig-pos
746 "Delete all spaces and tabs around point, leaving one space (or N spaces).
747 If N is negative, delete newlines as well, leaving -N spaces."
752 "Store context used in consecutive calls to `cycle-spacing' command.
753 The first time this function is run, it saves the original point
754 position and original spacing around the point in this
758 "Manipulate spaces around the point in a smart way.
760 When run as an interactive command, the first time it's called
761 in a sequence, deletes all spaces and tabs around point leaving
762 one (or N spaces). If this does not change content of the
763 buffer, skips to the second step:
765 When run for the second time in a sequence, deletes all the
766 spaces it has previously inserted.
768 When run for the third time, returns the whitespace and point in
769 a state encountered when it had been run for the first time.
772 point, calling `cycle-spacing' command will replace two spaces with
773 a single space, calling it again immediately after, will remove all
774 spaces, and calling it for the third time will bring two spaces back
775 together.
777 If N is negative, delete newlines as well. However, if
778 PRESERVE-NL-BACK is t new line characters prior to the point
779 won't be removed.
781 If SINGLE-SHOT is non-nil, will only perform the first step. In
782 other words, it will work just like `just-one-space' command."
790 ;; Command run for the first time or single-shot is non-nil.
801 ;; Special handling for case where there was no space at all.
804 ;; If this run causes no change in buffer content, delete all spaces,
805 ;; otherwise delete all excess spaces.
810 ;; Command run for the second time.
814 ;; Command run for the third time.
819 \f
821 "Move point to the beginning of the buffer.
822 With numeric arg N, put point N/10 of the way from the beginning.
823 If the buffer is narrowed, this command uses the beginning of the
824 accessible part of the buffer.
826 If Transient Mark mode is disabled, leave mark at previous
829 Don't use this command in Lisp programs!
830 \(goto-char (point-min)) is faster."
839 ;; Avoid overflow for large buffer sizes!
847 "Move point to the end of the buffer.
848 With numeric arg N, put point N/10 of the way from the end.
849 If the buffer is narrowed, this command uses the end of the
850 accessible part of the buffer.
852 If Transient Mark mode is disabled, leave mark at previous
855 Don't use this command in Lisp programs!
856 \(goto-char (point-max)) is faster."
863 ;; Avoid overflow for large buffer sizes!
868 ;; If we went to a place in the middle of the buffer,
869 ;; adjust it to the beginning of a line.
873 ;; If the end of the buffer is not already on the screen,
874 ;; then scroll specially to put it near, but not at, the bottom.
879 "Whether single-char deletion commands delete an active region.
880 This has an effect only if Transient Mark mode is enabled, and
881 affects `delete-forward-char' and `delete-backward-char', though
882 not `delete-char'.
884 If the value is the symbol `kill', the active region is killed
885 instead of deleted."
893 "Delete the previous N characters (following if N is negative).
894 If Transient Mark mode is enabled, the mark is active, and N is 1,
895 delete the text in the region and deactivate the mark instead.
896 To disable this, set option `delete-active-region' to nil.
898 Optional second arg KILLFLAG, if non-nil, means to kill (save in
899 kill ring) instead of delete. Interactively, N is the prefix
900 arg, and KILLFLAG is set if N is explicitly specified.
902 In Overwrite mode, single character backward deletion may replace
903 tabs with spaces so as to back over columns, unless point is at
904 the end of the line."
909 delete-active-region
911 ;; If a region is active, kill or delete it.
915 ;; In Overwrite mode, maybe untabify while deleting
925 ;; Otherwise, do simple deletion.
929 "Delete the following N characters (previous if N is negative).
930 If Transient Mark mode is enabled, the mark is active, and N is 1,
931 delete the text in the region and deactivate the mark instead.
932 To disable this, set variable `delete-active-region' to nil.
934 Optional second arg KILLFLAG non-nil means to kill (save in kill
935 ring) instead of delete. Interactively, N is the prefix arg, and
936 KILLFLAG is set if N was explicitly specified."
941 delete-active-region
943 ;; If a region is active, kill or delete it.
947 ;; Otherwise, do simple deletion.
951 "Put point at beginning and mark at end of buffer.
952 If narrowing is in effect, only uses the accessible part of the buffer.
953 You probably should not use this function in Lisp programs;
954 it is usually a mistake for a Lisp function to use any subroutine
955 that uses or sets the mark."
960 \f
962 ;; Counting lines, one way or another.
965 "Go to LINE, counting from line 1 at beginning of buffer.
966 If called interactively, a numeric prefix argument specifies
967 LINE; without a numeric prefix argument, read LINE from the
968 minibuffer.
970 If optional argument BUFFER is non-nil, switch to that buffer and
972 as argument, BUFFER is the most recently selected other buffer.
974 Prior to moving point, this function sets the mark (without
975 activating it), unless Transient Mark mode is enabled and the
976 mark is already active.
978 This function is usually the wrong thing to use in a Lisp program.
979 What you probably want instead is something like:
980 (goto-char (point-min))
981 (forward-line (1- N))
982 If at all possible, an even better solution is to use char counts
983 rather than line counts."
987 ;; Look for a default, a number in the buffer at point.
997 ;; Decide if we're switching buffers.
1005 ;; Read the argument, offering that number (if any) as default.
1008 buffer))))
1009 ;; Switch to the desired buffer, one way or another.
1014 ;; Leave mark at previous position
1016 ;; Move to the specified line number in that buffer.
1025 "Count the number of words in the region.
1026 If called interactively, print a message reporting the number of
1027 lines, words, and characters in the region (whether or not the
1028 region is active); with prefix ARG, report for the entire buffer
1029 rather than the region.
1031 If called from Lisp, return the number of words between positions
1032 START and END."
1044 "Count words between START and END.
1045 If called interactively, START and END are normally the start and
1046 end of the buffer; but if the region is active, START and END are
1047 the start and end of the region. Print a message reporting the
1048 number of lines, words, and chars.
1050 If called from Lisp, return the number of words between START and
1051 END, without printing any message."
1061 words))
1077 str
1085 "Print the current buffer line number and narrowed line number of point."
1098 "Return number of lines between START and END.
1099 This is usually the number of newlines between them,
1100 but can be one more if START is not equal to END
1101 and the greater of them is not at the start of a line."
1117 done)))
1121 "Return (narrowed) buffer line number at position POS.
1122 If POS is nil, use current buffer location.
1123 Counting starts at (point-min), so the value refers
1124 to the contents of the accessible portion of the buffer."
1134 "Print info on cursor position (on screen and within buffer).
1135 Also describe the character after point, and give its character code
1136 in octal, decimal and hex.
1138 For a non-ASCII multibyte character, also give its encoding in the
1139 buffer's selected coding system if the coding system encodes the
1140 character safely. If the character is encoded into one byte, that
1141 code is shown in hex. If the character is encoded into more than one
1144 In addition, with prefix argument, show details about that character
1145 in *Help* buffer. See also the command `describe-char'."
1150 ;; If the character is one of LRE, LRO, RLE, RLO, it
1151 ;; will start a directional embedding, which could
1152 ;; completely disrupt the rest of the line (e.g., RLO
1153 ;; will display the rest of the line right-to-left).
1154 ;; So we put an invisible PDF character after these
1155 ;; characters, to end the embedding, which eliminates
1156 ;; any effects on the rest of the line.
1158 ;; Strong right-to-left characters cause reordering of
1159 ;; the following numerical characters which show the
1160 ;; codepoint, so append LRM to countermand that.
1170 ;; Avoid overflow from multiplying by 100!
1174 ""
1180 pos total percent beg end col hscroll)
1182 pos total col hscroll))
1184 encoded encoding-msg display-prop under-display)
1191 ;; Check if the character is displayed with some `display'
1192 ;; text property. In that case, set under-display to the
1193 ;; buffer substring covered by that property.
1204 under-display)))
1210 char char char under-display)
1212 char char char under-display display-prop))
1215 char char char
1217 "..."
1221 ;; We show the detailed information about CHAR.
1228 bidi-fixer
1229 encoding-msg pos total percent beg end col hscroll)
1236 bidi-fixer encoding-msg pos total percent col hscroll))))))
1237 \f
1238 ;; Initialize read-expression-map. It is defined at C level.
1241 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1242 ;; too rarely useful.
1252 "The current default value or list of default values in the minibuffer.
1253 The functions `read-from-minibuffer' and `completing-read' bind
1257 "Value for `print-level' while printing value in `eval-expression'.
1258 A value of nil means no limit."
1264 "Value for `print-length' while printing value in `eval-expression'.
1265 A value of nil means no limit."
1271 "If non-nil set `debug-on-error' to t in `eval-expression'.
1272 If nil, don't change the value of `debug-on-error'."
1278 "Format VALUE as a result of evaluated expression.
1279 Return a formatted string which is displayed in the echo area
1280 in addition to the value printed by prin1 in functions which
1281 display the result of expression evaluation."
1297 ;; We define this, rather than making `eval' interactive,
1298 ;; for the sake of completion of names like eval-region, eval-buffer.
1300 "Evaluate EXP and print value in the echo area.
1301 When called interactively, read an Emacs Lisp expression and
1302 evaluate it.
1303 Value is also consed on to front of the variable `values'.
1304 Optional argument INSERT-VALUE non-nil (interactively,
1305 with prefix argument) means insert the result into the current buffer
1306 instead of printing it in the echo area. Truncates long output
1307 according to the value of the variables `eval-expression-print-length'
1308 and `eval-expression-print-level'.
1310 If `eval-expression-debug-on-error' is non-nil, which is the default,
1311 this command arranges for all errors to enter the debugger."
1317 nil read-expression-map t
1319 current-prefix-arg))
1324 ;; Bind debug-on-error to something unique so that we can
1325 ;; detect when evalled code changes it.
1329 ;; If evalled code has changed the value of debug-on-error,
1330 ;; propagate that change to the global binding.
1347 "Prompting with PROMPT, let user edit COMMAND and eval result.
1348 COMMAND is a Lisp expression. Let user edit that expression in
1349 the minibuffer, then read and evaluate the result."
1356 read-expression-map t
1358 ;; If command was added to command-history as a string,
1359 ;; get rid of that. We want only evaluable expressions there.
1363 ;; If command to be redone does not match front of history,
1364 ;; add it to the history.
1370 "Edit and re-evaluate last complex command, or ARGth from last.
1371 A complex command is one which used the minibuffer.
1372 The command is placed in the minibuffer as a Lisp form for editing.
1373 The result is executed, repeating the command as changed.
1374 If the command has been changed or is not the most recent previous
1375 command it is added to the front of the command history.
1376 You can use the minibuffer history commands \
1378 to get different commands to edit and resubmit."
1381 newcmd)
1393 ;; If command was added to command-history as a
1394 ;; string, get rid of that. We want only
1395 ;; evaluable expressions there.
1399 ;; If command to be redone does not match front of history,
1400 ;; add it to the history.
1411 "Read command name to invoke in `execute-extended-command'."
1416 ;; Get a command name at point in the original buffer
1417 ;; to propose it after M-n.
1421 ;; Read a string, completing from and restricting to the set of
1422 ;; all defined commands. Don't provide any initial input.
1423 ;; Save the command read on the extended-command history list.
1434 ;; This isn't strictly correct if `execute-extended-command'
1435 ;; is bound to anything else (e.g. [menu]).
1436 ;; It could use (key-description (this-single-command-keys)),
1437 ;; but actually a prompt other than "M-x" would be confusing,
1438 ;; because "M-x" is a well-known prompt to read a command
1439 ;; and it serves as a shorthand for "Extended command: ".
1444 "Non-nil means show the equivalent key-binding when M-x command has one.
1445 The value can be a length of time to show the message for.
1446 If the value is non-nil and not a number, we wait 2 seconds."
1453 ;; Based on Fexecute_extended_command in keyboard.c of Emacs.
1454 ;; Aaron S. Hawley <aaron.s.hawley(at)gmail.com> 2009-08-24
1455 "Read function name, then read its arguments and call it.
1457 To pass a numeric argument to the command you are invoking, specify
1458 the numeric argument to this command.
1460 Noninteractively, the argument PREFIXARG is the prefix argument to
1461 give to the command you invoke, if it asks for an argument."
1463 ;; Emacs<24 calling-convention was with a single `prefixarg' argument.
1474 ;; Normally `real-this-command' should never be changed, but here we really
1475 ;; want to pretend that M-x <cmd> RET is nothing more than a "key
1476 ;; binding" for <cmd>, so the command the user really wanted to run is
1477 ;; `function' and not `execute-extended-command'. The difference is
1478 ;; visible in cases such as M-x <cmd> RET and then C-x z (bug#11506).
1482 ;; If enabled, show which key runs this command.
1484 ;; But first wait, and skip the message if there is input.
1486 ;; If this command displayed something in the echo area;
1487 ;; wait a few seconds, then display our suggestion message.
1497 suggest-key-bindings
1501 ;; BEWARE: Called directly from the C code.
1502 "Execute CMD as an editor command.
1503 CMD must be a symbol that satisfies the `commandp' predicate.
1504 Optional second arg RECORD-FLAG non-nil
1505 means unconditionally put this command in the variable `command-history'.
1506 Otherwise, that is done only if an arg is read using the minibuffer.
1507 The argument KEYS specifies the value to use instead of (this-command-keys)
1508 when reading the arguments; if it is nil, (this-command-keys) is used.
1509 The argument SPECIAL, if non-nil, means that this command is executing
1510 a special event, so ignore the prefix argument and don't clear it."
1518 ;; FIXME: Weird calling convention!
1528 ;; If requested, place the macro in the command history. For
1529 ;; other sorts of commands, call-interactively takes care of this.
1532 ;; Don't keep command history around forever.
1538 ;; Pass `cmd' rather than `final', for the backtrace's sake.
1546 \f
1548 "Default minibuffer history list.
1549 This is used for all minibuffer input
1550 except when an alternate history list is specified.
1552 Maximum length of the history list is determined by the value
1555 "Control whether history list elements are expressions or strings.
1556 If the value of this variable equals current minibuffer depth,
1557 they are expressions; otherwise they are strings.
1558 \(That convention is designed to do the right thing for
1565 "Text that was in this minibuffer before any history commands.
1566 This is nil if there have not yet been any history commands
1575 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1579 "Minibuffer history variables for which matching should ignore case.
1580 If a history variable is a member of this list, then the
1582 commands ignore case when searching it, regardless of `case-fold-search'."
1587 "Find the previous history element that matches REGEXP.
1588 \(Previous history elements refer to earlier actions.)
1589 With prefix argument N, search for Nth previous match.
1590 If N is negative, find the next or Nth next match.
1591 Normally, history elements are matched case-insensitively if
1592 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1593 makes the search case-sensitive.
1594 See also `minibuffer-history-case-insensitive-variables'."
1598 nil
1599 minibuffer-local-map
1600 nil
1601 'minibuffer-history-search-history
1603 ;; Use the last regexp specified, by default, if input is empty.
1608 regexp)
1618 ;; On some systems, ignore case for file names.
1620 minibuffer-history-case-insensitive-variables)
1621 t
1622 ;; Respect the user's setting for case-fold-search:
1623 case-fold-search)
1624 nil))
1625 prevpos
1626 match-string
1627 match-offset
1634 "No later matching history item"
1655 next-matching-history-element))
1659 "Find the next history element that matches REGEXP.
1660 \(The next history element refers to a more recent action.)
1661 With prefix argument N, search for Nth next match.
1662 If N is negative, find the previous or Nth previous match.
1663 Normally, history elements are matched case-insensitively if
1664 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1665 makes the search case-sensitive."
1669 nil
1670 minibuffer-local-map
1671 nil
1672 'minibuffer-history-search-history
1674 ;; Use the last regexp specified, by default, if input is empty.
1679 regexp)
1686 "Function run by `goto-history-element' before consuming default values.
1687 This is useful to dynamically add more elements to the list of default values
1688 when `goto-history-element' reaches the end of this list.
1689 Before calling this function `goto-history-element' sets the variable
1690 `minibuffer-default-add-done' to t, so it will call this function only
1691 once. In special cases, when this function needs to be called more
1692 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1696 "When nil, add more elements to the end of the list of default values.
1697 The value nil causes `goto-history-element' to add more elements to
1698 the list of defaults when it reaches the end of this list. It does
1704 "Return a list of all completions without the default value.
1705 This function is used to add all elements of the completion table to
1706 the end of the list of defaults just after the default value."
1709 minibuffer-completion-table
1710 minibuffer-completion-predicate)))
1716 "Puts element of the minibuffer history in the minibuffer.
1717 The argument NABS specifies the absolute history position."
1731 elt minibuffer-returned-to-present)
1738 "End of defaults; no next item"
1743 previous-history-element))
1755 minibuffer-default)))
1767 elt))
1771 "Puts next element of the minibuffer history in the minibuffer.
1772 With argument N, it uses the Nth following element."
1778 "Puts previous element of the minibuffer history in the minibuffer.
1779 With argument N, it uses the Nth previous element."
1785 "Get next history element which completes the minibuffer before the point.
1786 The contents of the minibuffer after the point are deleted, and replaced
1787 by the new completion."
1793 n)
1794 ;; next-matching-history-element always puts us at (point-min).
1795 ;; Move to the position we were at before changing the buffer contents.
1796 ;; This is still sensible, because the text before point has not changed.
1800 "\
1801 Get previous history element which completes the minibuffer before the point.
1802 The contents of the minibuffer after the point are deleted, and replaced
1803 by the new completion."
1807 ;; For compatibility with the old subr of the same name.
1809 "Return the display width of the minibuffer prompt.
1810 Return 0 if current buffer is not a minibuffer."
1811 ;; Return the width of everything before the field at the end of
1812 ;; the buffer; this should be 0 for normal buffers.
1814 \f
1815 ;; isearch minibuffer history
1822 "Set up a minibuffer for using isearch to search the minibuffer history.
1823 Intended to be added to `minibuffer-setup-hook'."
1835 "Clean up the minibuffer after terminating isearch in the minibuffer."
1840 "Return the proper search function, for isearch in minibuffer history."
1843 ;; Use standard functions to search within minibuffer text
1845 found)
1846 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1847 ;; searching forward. Lazy-highlight calls this lambda with the
1848 ;; bound arg, so skip the minibuffer prompt.
1852 ;; 1. First try searching in the initial minibuffer text
1855 noerror)
1856 ;; 2. If the above search fails, start putting next/prev history
1857 ;; elements in the minibuffer successively, and search the string
1858 ;; in them. Do this only when bound is nil (i.e. not while
1859 ;; lazy-highlighting search strings in the current minibuffer text).
1871 ;; After putting the next/prev history element, search
1872 ;; the string in them again, until next-history-element
1873 ;; or previous-history-element raises an error at the
1874 ;; beginning/end of history.
1877 ;; For backward search, don't search
1878 ;; in the minibuffer prompt
1880 noerror)))
1881 ;; Return point of the new search result
1883 ;; Return nil when next(prev)-history-element fails
1887 "Display the minibuffer history search prompt.
1888 If there are no search errors, this function displays an overlay with
1889 the isearch prompt which replaces the original minibuffer prompt.
1890 Otherwise, it displays the standard isearch message returned from
1891 the function `isearch-message'."
1893 ;; Use standard function `isearch-message' when not in the minibuffer,
1894 ;; or search fails, or has an error (like incomplete regexp).
1895 ;; This function overwrites minibuffer text with isearch message,
1896 ;; so it's possible to see what is wrong in the search string.
1898 ;; Otherwise, put the overlay with the standard isearch prompt over
1899 ;; the initial minibuffer prompt.
1908 ;; And clear any previous isearch message.
1912 "Wrap the minibuffer history search when search fails.
1913 Move point to the first history element for a forward search,
1914 or to the last history element for a backward search."
1915 ;; When `minibuffer-history-isearch-search' fails on reaching the
1916 ;; beginning/end of the history, wrap the search to the first/last
1917 ;; minibuffer history element.
1925 "Save a function restoring the state of minibuffer history search.
1926 Save `minibuffer-history-position' to the additional state parameter
1927 in the search status stack."
1933 "Restore the minibuffer history search state.
1934 Go to the history element by the absolute history position HIST-POS."
1937 \f
1938 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1942 "Table mapping redo records to the corresponding undo one.
1943 A redo record for undo-in-region maps to t.
1953 "Within a run of consecutive undo commands, list remaining to be undone.
1957 "Undo some previous changes.
1958 Repeat this command to undo more changes.
1959 A numeric ARG serves as a repeat count.
1961 In Transient Mark mode when the mark is active, only undo changes within
1963 as an argument limits undo to changes within the current region."
1965 ;; Make last-command indicate for the next command that this was an undo.
1966 ;; That way, another undo will undo more.
1967 ;; If we get to the end of the undo history and get an error,
1968 ;; another undo command will find the undo history empty
1969 ;; and will get another error. To begin undoing the undos,
1970 ;; you must type some other command.
1972 ;; For an indirect buffer, look in the base buffer for the
1973 ;; auto-save data.
1977 message)
1978 ;; If we get an error in undo-start,
1979 ;; the next command should not be a "consecutive undo".
1980 ;; So set `this-command' to something other than `undo'.
1985 ;; If something (a timer or filter?) changed the buffer
1986 ;; since the previous command, don't continue the undo seq.
1990 ;; If the last undo record made was made by undo
1991 ;; it shows nothing else happened in between.
1998 ;; get rid of initial undo boundary
2000 ;; If we got this far, the next command should be a consecutive undo.
2002 ;; Check to see whether we're hitting a redo record, and if
2003 ;; so, ask the user whether she wants to skip the redo/undo pair.
2011 ;; The equiv entry might point to another redo record if we have done
2012 ;; undo-redo-undo-redo-... so skip to the very last equiv.
2020 ;; Record the fact that the just-generated undo records come from an
2021 ;; undo operation--that is, they are redo records.
2022 ;; In the ordinary case (not within a region), map the redo
2023 ;; record to the following undos.
2024 ;; I don't know how to do that in the undo-in-region case.
2026 ;; Strip any leading undo boundaries there might be, like we do
2027 ;; above when checking.
2031 undo-equiv-table))
2032 ;; Don't specify a position in the undo record for the undo command.
2033 ;; Instead, undoing this should move point to where the change is.
2052 ;; Record what the current undo list says,
2053 ;; so the next command can tell if the buffer was modified in between.
2057 ;; Display a message announcing success.
2062 "Make BUFFER stop keeping undo information.
2063 No argument or nil as argument means do this for the current buffer."
2069 "Undo some previous changes.
2070 Repeat this command to undo more changes.
2071 A numeric ARG serves as a repeat count.
2072 Contrary to `undo', this will not redo a previous undo."
2077 "Non-nil while performing an undo.
2081 "Undo back N undo-boundaries beyond what was already undone recently.
2082 Call `undo-start' to get ready to undo recent changes,
2083 then call `undo-more' one or more times to undo them."
2088 ;; Note: The following, while pulling elements off
2089 ;; `pending-undo-list' will call primitive change functions which
2090 ;; will push more elements onto `buffer-undo-list'.
2096 "Undo N records from the front of the list LIST.
2097 Return what remains of the list."
2099 ;; This is a good feature, but would make undo-start
2100 ;; unable to do what is expected.
2101 ;;(when (null (car (list)))
2102 ;; ;; If the head of the list is a boundary, it is the boundary
2103 ;; ;; preceding this command. Get rid of it and don't count it.
2104 ;; (setq list (cdr list))))
2107 ;; In a writable buffer, enable undoing read-only text that is
2108 ;; so because of text properties.
2110 ;; Don't let `intangible' properties interfere with undo.
2112 ;; We use oldlist only to check for EQ. ++kfs
2118 ;; Handle an integer by setting point to that value.
2121 ;; Element (t . TIME) records previous modtime.
2122 ;; Preserve any flag of NONEXISTENT_MODTIME_NSECS or
2123 ;; UNKNOWN_MODTIME_NSECS.
2125 ;; If this records an obsolete save
2126 ;; (not matching the actual disk file)
2127 ;; then don't mark unmodified.
2135 ;; Element (nil PROP VAL BEG . END) is property change.
2140 ;; Element (BEG . END) means range was inserted.
2142 ;; (and `(,beg . ,end) `(,(pred integerp) . ,(pred integerp)))
2143 ;; Ideally: `(,(pred integerp beg) . ,(pred integerp end))
2146 ;; Set point first thing, so that undoing this undo
2147 ;; does not send point back to where it is now.
2150 ;; Element (apply FUN . ARGS) means call FUN to undo.
2154 ;; Long format: (apply DELTA START END FUN . ARGS).
2161 ;; Check that the function did what the entry
2162 ;; said it would do.
2172 ;; Element (STRING . POS) means STRING was deleted.
2182 ;; Now that we record marker adjustments
2183 ;; (caused by deletion) for undo,
2184 ;; we should always insert after markers,
2185 ;; so that undoing the marker adjustments
2186 ;; put the markers back in the right place.
2189 ;; (MARKER . OFFSET) means a marker MARKER was adjusted by OFFSET.
2197 ;; Make sure an apply entry produces at least one undo entry,
2198 ;; so the test in `undo' for continuing an undo series
2199 ;; will work right.
2204 list)
2206 ;; Deep copy of a list
2208 "Make a copy of undo list LIST."
2214 elt))
2217 "Set `pending-undo-list' to the front of the undo list.
2218 The next call to `undo-more' will undo the most recently made change.
2219 If BEG and END are specified, then only undo elements
2220 that apply to text between BEG and END are used; other undo elements
2221 are ignored. If BEG and END are nil, all undo elements are used."
2227 buffer-undo-list)))
2232 "Return a list of undo elements for the region START to END.
2233 The elements come from `buffer-undo-list', but we keep only
2234 the elements inside this region, and discard those outside this region.
2235 If we find an element that crosses an edge of this region,
2236 we stop and ignore all further elements."
2239 undo-adjusted-markers
2240 some-rejected
2241 undo-elt temp-undo-list delta)
2246 ;; This is a "was unmodified" element.
2247 ;; Keep it if we have kept everything thus far.
2254 ;; Don't put two nils together in the list
2268 ;; Loop down the earlier events adjusting their buffer
2269 ;; positions to reflect the fact that a change to the buffer
2270 ;; isn't being undone. We only need to process those element
2271 ;; types which undo-elt-in-region will return as being in
2272 ;; the region since only those types can ever get into the
2273 ;; output
2282 ;; (TEXT . POSITION)
2289 ;; (BEGIN . END)
2294 ;; (nil PROPERTY VALUE BEG . END)
2304 "Determine whether UNDO-ELT falls inside the region START ... END.
2305 If it crosses the edge, we return nil."
2310 t)
2312 nil)
2314 ;; (TEXT . POSITION)
2318 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2319 ;; See if MARKER is inside the region.
2330 ;; (nil PROPERTY VALUE BEG . END)
2335 ;; (BEGIN . END)
2340 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2341 This assumes we have already decided that UNDO-ELT
2342 is not *inside* the region START...END."
2345 ;; (nil PROPERTY VALUE BEG . END)
2350 ;; (BEGIN . END)
2354 ;; Return the first affected buffer position and the delta for an undo element
2355 ;; delta is defined as the change in subsequent buffer positions if we *did*
2356 ;; the undo.
2360 ;; (TEXT . POSITION)
2363 ;; (BEGIN . END)
2370 "If non-nil ask about discarding undo info for the current command.
2371 Normally, Emacs discards the undo info for the current command if
2372 it exceeds `undo-outer-limit'. But if you set this option
2373 non-nil, it asks in the echo area whether to discard the info.
2374 If you answer no, there is a slight risk that Emacs might crash, so
2375 only do it if you really want to undo the command.
2377 This option is mainly intended for debugging. You have to be
2378 careful if you use it for other purposes. Garbage collection is
2379 inhibited while the question is asked, meaning that Emacs might
2380 leak memory. So you should make sure that you do not wait
2381 excessively long before answering the question."
2387 "If non-nil, an extra level of size that's ok in an undo item.
2388 We don't ask the user about truncating the undo list until the
2389 current item gets bigger than this amount.
2394 ;; When the first undo batch in an undo list is longer than
2395 ;; undo-outer-limit, this function gets called to warn the user that
2396 ;; the undo info for the current command was discarded. Garbage
2397 ;; collection is inhibited around the call, so it had better not do a
2398 ;; lot of consing.
2404 ;; Don't ask the question again unless it gets even bigger.
2405 ;; This applies, in particular, if the user quits from the question.
2406 ;; Such a quit quits out of GC, but something else will call GC
2407 ;; again momentarily. It will call this function again,
2408 ;; but we don't want to ask the question again.
2415 t)
2416 nil))
2421 "The undo info was discarded because it exceeded \
2422 `undo-outer-limit'.
2424 This is normal if you executed a command that made a huge change
2425 to the buffer. In that case, to prevent similar problems in the
2426 future, set `undo-outer-limit' to a value that is large enough to
2427 cover the maximum size of normal changes you expect a single
2428 command to make, but not so large that it might exceed the
2429 maximum memory allotted to Emacs.
2431 If you did not execute any such command, the situation is
2432 probably due to a bug and you should report it.
2434 You can disable the popping up of this buffer by adding the entry
2435 \(undo discard-info) to the user option `warning-suppress-types',
2439 t))
2440 \f
2442 "History list for some commands that read shell commands.
2444 Maximum length of the history list is determined by the value
2451 "Buffer name for `shell-command' and `shell-command-on-region' error output.
2452 This buffer is used when `shell-command' or `shell-command-on-region'
2453 is run interactively. A value of nil means that output to stderr and
2460 "Return a list of all commands associated with the current file.
2461 This function is used to add all related commands retrieved by `mailcap'
2462 to the end of the list of defaults just after the default value."
2466 minibuffer-default))
2471 commands))
2482 map)
2486 "Read a shell command from the minibuffer.
2487 The arguments are the same as the ones of `read-from-minibuffer',
2488 except READ and KEYMAP are missing and HIST defaults
2489 to `shell-command-history'."
2497 minibuffer-local-shell-command-map
2498 nil
2500 args)))
2503 "What to do when the output buffer is used by another shell command.
2504 This option specifies how to resolve the conflict where a new command
2505 wants to direct its output to the buffer `*Async Shell Command*',
2506 but this buffer is already taken by another running shell command.
2508 The value `confirm-kill-process' is used to ask for confirmation before
2509 killing the already running process and running a new process
2510 in the same buffer, `confirm-new-buffer' for confirmation before running
2511 the command in a new buffer with a name other than the default buffer name,
2512 `new-buffer' for doing the same without confirmation,
2513 `confirm-rename-buffer' for confirmation before renaming the existing
2514 output buffer and running a new command in the default buffer,
2515 `rename-buffer' for doing the same without confirmation."
2517 confirm-kill-process)
2519 confirm-new-buffer)
2521 new-buffer)
2523 confirm-rename-buffer)
2525 rename-buffer))
2530 "Execute string COMMAND asynchronously in background.
2532 Like `shell-command', but adds `&' at the end of COMMAND
2533 to execute it asynchronously.
2535 The output appears in the buffer `*Async Shell Command*'.
2536 That buffer is in shell mode.
2538 In Elisp, you will often be better served by calling `start-process'
2539 directly, since it offers more control and does not impose the use of a
2540 shell (with its need to quote arguments)."
2550 current-prefix-arg
2551 shell-command-default-error-buffer))
2557 "Execute string COMMAND in inferior shell; display output, if any.
2558 With prefix argument, insert the COMMAND's output at point.
2560 If COMMAND ends in `&', execute it asynchronously.
2561 The output appears in the buffer `*Async Shell Command*'.
2562 That buffer is in shell mode. You can also use
2563 `async-shell-command' that automatically adds `&'.
2565 Otherwise, COMMAND is executed synchronously. The output appears in
2566 the buffer `*Shell Command Output*'. If the output is short enough to
2567 display in the echo area (which is determined by the variables
2568 `resize-mini-windows' and `max-mini-window-height'), it is shown
2569 there, but it is nonetheless available in buffer `*Shell Command
2570 Output*' even though that buffer is not automatically displayed.
2572 To specify a coding system for converting non-ASCII characters
2574 before this command.
2576 Noninteractive callers can specify coding systems by binding
2577 `coding-system-for-read' and `coding-system-for-write'.
2579 The optional second argument OUTPUT-BUFFER, if non-nil,
2580 says to put the output in some other buffer.
2581 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2582 If OUTPUT-BUFFER is not a buffer and not nil,
2583 insert output in current buffer. (This cannot be done asynchronously.)
2584 In either case, the buffer is first erased, and the output is
2585 inserted after point (leaving mark after it).
2587 If the command terminates without error, but generates output,
2589 the output can be displayed in the echo area or in its buffer.
2590 If the output is short enough to display in the echo area
2591 \(determined by the variable `max-mini-window-height' if
2592 `resize-mini-windows' is non-nil), it is shown there.
2593 Otherwise,the buffer containing the output is displayed.
2597 of the output.
2599 If there is no output, or if output is inserted in the current buffer,
2600 then `*Shell Command Output*' is deleted.
2602 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2603 or buffer name to which to direct the command's standard error output.
2604 If it is nil, error output is mingled with regular output.
2605 In an interactive call, the variable `shell-command-default-error-buffer'
2606 specifies the value of ERROR-BUFFER.
2608 In Elisp, you will often be better served by calling `call-process' or
2609 `start-process' directly, since it offers more control and does not impose
2610 the use of a shell (with its need to quote arguments)."
2621 current-prefix-arg
2622 shell-command-default-error-buffer))
2623 ;; Look for a handler in case default-directory is a remote file name.
2631 ;; Output goes in current buffer.
2637 temporary-file-directory)))
2638 nil)))
2641 ;; We do not use -f for csh; we will not support broken use of
2642 ;; .cshrcs. Even the BSD csh manual says to use
2643 ;; "if ($?prompt) exit" before things which are not useful
2644 ;; non-interactively. Besides, if someone wants their other
2645 ;; aliases for shell commands then they can still have them.
2649 t)
2650 nil shell-command-switch command)
2657 ;; Do no formatting while reading error file,
2658 ;; because that can run a shell command, and we
2659 ;; don't want that to cause an infinite recursion.
2661 ;; Put point after the inserted errors.
2665 ;; This is like exchange-point-and-mark, but doesn't
2666 ;; activate the mark. It is cleaner to avoid activation,
2667 ;; even though the command loop would deactivate the mark
2668 ;; because we inserted text.
2672 ;; Output goes in a separate buffer.
2673 ;; Preserve the match data in case called from a program.
2676 ;; Command ending with ampersand means asynchronous.
2680 proc)
2681 ;; Remove the ampersand.
2683 ;; Ask the user what to do with already running process.
2688 ;; If will kill a process, query first.
2693 ;; If will create a new buffer, query first.
2699 ;; It will create a new buffer.
2703 ;; If will rename the buffer, query first.
2712 ;; It will rename the buffer.
2719 ;; Setting buffer-read-only to nil doesn't suffice
2720 ;; if some text has a non-nil read-only property,
2721 ;; which comint sometimes adds for prompts.
2727 shell-command-switch command))
2731 ;; Use the comint filter for proper handling of carriage motion
2732 ;; (see `comint-inhibit-carriage-motion'),.
2734 ))
2735 ;; Otherwise, command is executed synchronously.
2737 output-buffer nil error-buffer)))))))
2741 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2742 MESSAGE may be either a string or a buffer.
2744 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2745 the maximum height of the echo area, as defined by `max-mini-window-height'
2746 if `resize-mini-windows' is non-nil.
2748 Returns either the string shown in the echo area, or when a pop-up
2749 buffer is used, the window used to display it.
2751 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2752 name of the buffer used to display it in the case where a pop-up buffer
2753 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2754 string and it is displayed in the echo area, it is not specified whether
2755 the contents are inserted into the buffer anyway.
2757 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2758 and only used if a buffer is displayed."
2760 ;; Trivial case where we can use the echo area
2764 ;; Trivial case where we can just remove single trailing newline
2767 ;; General case
2770 message
2779 0
2783 (<= lines
2787 max-mini-window-height))
2789 max-mini-window-height)
2793 ;; Don't use the echo area if the output buffer is
2794 ;; already displayed in the selected frame.
2796 ;; Echo area
2802 ;; Buffer
2805 not-this-window frame))))))))
2808 ;; We have a sentinel to prevent insertion of a termination message
2809 ;; in the buffer itself.
2817 &optional output-buffer replace
2818 error-buffer display-error-buffer)
2819 "Execute string COMMAND in inferior shell with region as input.
2820 Normally display output (if any) in temp buffer `*Shell Command Output*';
2821 Prefix arg means replace the region with it. Return the exit code of
2822 COMMAND.
2824 To specify a coding system for converting non-ASCII characters
2826 before this command. By default, the input (from the current buffer)
2827 is encoded using coding-system specified by `process-coding-system-alist',
2828 falling back to `default-process-coding-system' if no match for COMMAND
2829 is found in `process-coding-system-alist'.
2831 Noninteractive callers can specify coding systems by binding
2832 `coding-system-for-read' and `coding-system-for-write'.
2834 If the command generates output, the output may be displayed
2835 in the echo area or in a buffer.
2836 If the output is short enough to display in the echo area
2837 \(determined by the variable `max-mini-window-height' if
2838 `resize-mini-windows' is non-nil), it is shown there.
2839 Otherwise it is displayed in the buffer `*Shell Command Output*'.
2840 The output is available in that buffer in both cases.
2842 If there is output and an error, a message about the error
2843 appears at the end of the output. If there is no output, or if
2844 output is inserted in the current buffer, the buffer `*Shell
2845 Command Output*' is deleted.
2847 Optional fourth arg OUTPUT-BUFFER specifies where to put the
2848 command's output. If the value is a buffer or buffer name, put
2849 the output there. Any other value, including nil, means to
2850 insert the output in the current buffer. In either case, the
2851 output is inserted after point (leaving mark after it).
2853 Optional fifth arg REPLACE, if non-nil, means to insert the
2854 output in place of text from START to END, putting point and mark
2855 around it.
2857 Optional sixth arg ERROR-BUFFER, if non-nil, specifies a buffer
2858 or buffer name to which to direct the command's standard error
2859 output. If nil, error output is mingled with regular output.
2860 When called interactively, `shell-command-default-error-buffer'
2861 is used for ERROR-BUFFER.
2863 Optional seventh arg DISPLAY-ERROR-BUFFER, if non-nil, means to
2864 display the error buffer if there were any errors. When called
2865 interactively, this is t."
2869 ;; Do this before calling region-beginning
2870 ;; and region-end, in case subprocess output
2871 ;; relocates them while we are in the minibuffer.
2873 ;; call-interactively recognizes region-beginning and
2874 ;; region-end specially, leaving them in the history.
2876 string
2877 current-prefix-arg
2878 current-prefix-arg
2879 shell-command-default-error-buffer
2880 t)))
2886 temporary-file-directory)))
2887 nil))
2888 exit-status)
2892 ;; Replace specified region with output from command.
2894 ;; Don't muck with mark unless REPLACE says we should.
2901 t)
2902 nil shell-command-switch command))
2903 ;; It is rude to delete a buffer which the command is not using.
2904 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2905 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2906 ;; (kill-buffer shell-buffer)))
2907 ;; Don't muck with mark unless REPLACE says we should.
2909 ;; No prefix argument: put the output in a temp buffer,
2910 ;; replacing its entire contents.
2915 ;; If the input is the same buffer as the output,
2916 ;; delete everything but the specified region,
2917 ;; then replace that region with the output.
2923 shell-file-name t
2926 t)
2927 nil shell-command-switch
2928 command)))
2929 ;; Clear the output buffer, then run the command with
2930 ;; output there.
2941 buffer)
2942 nil shell-command-switch command)))
2943 ;; Report the output.
2953 ;; There's some output, display it
2955 ;; No output; error?
2962 shell-command-default-error-buffer)
2969 output))
2972 exit-status))
2975 exit-status output))))
2976 ;; Don't kill: there might be useful info in the undo-log.
2977 ;; (kill-buffer buffer)
2978 ))))
2986 ;; Do no formatting while reading error file,
2987 ;; because that can run a shell command, and we
2988 ;; don't want that to cause an infinite recursion.
2990 ;; Put point after the inserted errors.
2995 exit-status))
2998 "Execute shell command COMMAND and return its output as a string."
3001 standard-output
3005 "Process files synchronously in a separate process.
3006 Similar to `call-process', but may invoke a file handler based on
3007 `default-directory'. The current working directory of the
3008 subprocess is `default-directory'.
3010 File names in INFILE and BUFFER are handled normally, but file
3011 names in ARGS should be relative to `default-directory', as they
3012 are passed to the process verbatim. \(This is a difference to
3013 `call-process' which does not support file handlers for INFILE
3014 and BUFFER.\)
3016 Some file handlers might not support all variants, for example
3017 they might behave as if DISPLAY was nil, regardless of the actual
3018 value passed."
3020 lc stderr-file)
3030 display args)
3036 "Whether a call of `process-file' changes remote files.
3038 By default, this variable is always set to `t', meaning that a
3039 call of `process-file' could potentially change any file on a
3040 remote host. When set to `nil', a file handler could optimize
3041 its behavior with respect to remote file attribute caching.
3043 You should only ever change this variable with a let-binding;
3047 "Start a program in a subprocess. Return the process object for it.
3049 Similar to `start-process', but may invoke a file handler based on
3050 `default-directory'. See Info node `(elisp)Magic File Names'.
3052 This handler ought to run PROGRAM, perhaps on the local host,
3053 perhaps on a remote host that corresponds to `default-directory'.
3054 In the latter case, the local part of `default-directory' becomes
3055 the working directory of the process.
3057 PROGRAM and PROGRAM-ARGS might be file names. They are not
3058 objects of file handler invocation. File handlers might not
3059 support pty association, if PROGRAM is nil."
3063 \f
3064 ;;;; Process menu
3076 "Major mode for listing the processes called by Emacs."
3088 "Recompute the list of processes for the Process List buffer.
3089 Also, delete any process that is exited or signaled."
3102 face link
3105 follow-link t
3106 process-buffer ,buf
3107 action process-menu-visit-buffer)
3116 "datagram"
3133 tabulated-list-entries))))))
3139 "Display a list of all processes.
3140 If optional argument QUERY-ONLY is non-nil, only processes with
3141 the query-on-exit flag set are listed.
3142 Any process listed as exited or signaled is actually eliminated
3143 after the listing is made.
3144 Optional argument BUFFER specifies a buffer to use, instead of
3146 The return value is always nil."
3158 nil)
3159 \f
3163 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
3164 (define-key map [switch-frame] nil)
3165 (define-key map [?\C-u] 'universal-argument-more)
3166 (define-key map [?-] 'universal-argument-minus)
3167 (define-key map [?0] 'digit-argument)
3168 (define-key map [?1] 'digit-argument)
3169 (define-key map [?2] 'digit-argument)
3170 (define-key map [?3] 'digit-argument)
3171 (define-key map [?4] 'digit-argument)
3172 (define-key map [?5] 'digit-argument)
3173 (define-key map [?6] 'digit-argument)
3174 (define-key map [?7] 'digit-argument)
3175 (define-key map [?8] 'digit-argument)
3176 (define-key map [?9] 'digit-argument)
3177 (define-key map [kp-0] 'digit-argument)
3178 (define-key map [kp-1] 'digit-argument)
3179 (define-key map [kp-2] 'digit-argument)
3180 (define-key map [kp-3] 'digit-argument)
3181 (define-key map [kp-4] 'digit-argument)
3182 (define-key map [kp-5] 'digit-argument)
3183 (define-key map [kp-6] 'digit-argument)
3184 (define-key map [kp-7] 'digit-argument)
3185 (define-key map [kp-8] 'digit-argument)
3186 (define-key map [kp-9] 'digit-argument)
3187 (define-key map [kp-subtract] 'universal-argument-minus)
3188 map)
3191 (defvar universal-argument-num-events nil
3192 "Number of argument-specifying events read by `universal-argument'.
3193 `universal-argument-other-key' uses this to discard those events
3194 from (this-command-keys), and reread only the final command.")
3196 (defvar saved-overriding-map t
3197 "The saved value of `overriding-terminal-local-map'.
3201 (defun save&set-overriding-map (map)
3202 "Set `overriding-terminal-local-map' to MAP."
3203 (when (eq saved-overriding-map t)
3204 (setq saved-overriding-map overriding-terminal-local-map)
3205 (setq overriding-terminal-local-map map)))
3207 (defun restore-overriding-map ()
3208 "Restore `overriding-terminal-local-map' to its saved value."
3209 (setq overriding-terminal-local-map saved-overriding-map)
3210 (setq saved-overriding-map t))
3212 (defun universal-argument ()
3213 "Begin a numeric argument for the following command.
3218 multiplies the argument by 4 each time.
3220 which is different in effect from any particular numeric argument.
3222 (interactive)
3223 (setq prefix-arg (list 4))
3224 (setq universal-argument-num-events (length (this-command-keys)))
3225 (save&set-overriding-map universal-argument-map))
3227 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
3228 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
3229 (defun universal-argument-more (arg)
3230 (interactive "P")
3231 (if (consp arg)
3232 (setq prefix-arg (list (* 4 (car arg))))
3233 (if (eq arg '-)
3234 (setq prefix-arg (list -4))
3235 (setq prefix-arg arg)
3236 (restore-overriding-map)))
3237 (setq universal-argument-num-events (length (this-command-keys))))
3239 (defun negative-argument (arg)
3240 "Begin a negative numeric argument for the next command.
3242 (interactive "P")
3243 (cond ((integerp arg)
3244 (setq prefix-arg (- arg)))
3245 ((eq arg '-)
3246 (setq prefix-arg nil))
3247 (t
3248 (setq prefix-arg '-)))
3249 (setq universal-argument-num-events (length (this-command-keys)))
3250 (save&set-overriding-map universal-argument-map))
3252 (defun digit-argument (arg)
3253 "Part of the numeric argument for the next command.
3255 (interactive "P")
3256 (let* ((char (if (integerp last-command-event)
3257 last-command-event
3258 (get last-command-event 'ascii-character)))
3260 (cond ((integerp arg)
3261 (setq prefix-arg (+ (* arg 10)
3262 (if (< arg 0) (- digit) digit))))
3263 ((eq arg '-)
3264 ;; Treat -0 as just -, so that -01 will work.
3265 (setq prefix-arg (if (zerop digit) '- (- digit))))
3266 (t
3267 (setq prefix-arg digit))))
3268 (setq universal-argument-num-events (length (this-command-keys)))
3269 (save&set-overriding-map universal-argument-map))
3271 ;; For backward compatibility, minus with no modifiers is an ordinary
3272 ;; command if digits have already been entered.
3273 (defun universal-argument-minus (arg)
3274 (interactive "P")
3275 (if (integerp arg)
3276 (universal-argument-other-key arg)
3277 (negative-argument arg)))
3279 ;; Anything else terminates the argument and is left in the queue to be
3280 ;; executed as a command.
3281 (defun universal-argument-other-key (arg)
3282 (interactive "P")
3283 (setq prefix-arg arg)
3284 (let* ((key (this-command-keys))
3285 (keylist (listify-key-sequence key)))
3286 (setq unread-command-events
3287 (append (nthcdr universal-argument-num-events keylist)
3288 unread-command-events)))
3289 (reset-this-command-lengths)
3290 (restore-overriding-map))
3291 \f
3293 (defvar filter-buffer-substring-functions nil
3294 "This variable is a wrapper hook around `filter-buffer-substring'.")
3295 (make-obsolete-variable 'filter-buffer-substring-functions
3296 'filter-buffer-substring-function "24.4")
3298 (defvar filter-buffer-substring-function #'buffer-substring--filter
3299 "Function to perform the filtering in `filter-buffer-substring'.
3300 The function is called with 3 arguments:
3301 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
3302 as those of `filter-buffer-substring' in each case.
3303 It should return the buffer substring between BEG and END, after filtering.")
3305 (defvar buffer-substring-filters nil
3306 "List of filter functions for `filter-buffer-substring'.
3307 Each function must accept a single argument, a string, and return
3308 a string. The buffer substring is passed to the first function
3309 in the list, and the return value of each function is passed to
3310 the next.
3311 As a special convention, point is set to the start of the buffer text
3312 being operated on (i.e., the first argument of `filter-buffer-substring')
3313 before these functions are called.")
3314 (make-obsolete-variable 'buffer-substring-filters
3315 'filter-buffer-substring-function "24.1")
3317 (defun filter-buffer-substring (beg end &optional delete)
3318 "Return the buffer substring between BEG and END, after filtering.
3319 The hook `filter-buffer-substring-function' performs the actual filtering.
3320 By default, no filtering is done.
3322 If DELETE is non-nil, the text between BEG and END is deleted
3323 from the buffer.
3325 This function should be used instead of `buffer-substring',
3326 `buffer-substring-no-properties', or `delete-and-extract-region'
3327 when you want to allow filtering to take place. For example,
3328 major or minor modes can use `filter-buffer-substring-function' to
3329 extract characters that are special to a buffer, and should not
3330 be copied into other buffers."
3331 (funcall filter-buffer-substring-function beg end delete))
3333 (defun buffer-substring--filter (beg end &optional delete)
3334 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
3335 (cond
3336 ((or delete buffer-substring-filters)
3337 (save-excursion
3338 (goto-char beg)
3339 (let ((string (if delete (delete-and-extract-region beg end)
3340 (buffer-substring beg end))))
3341 (dolist (filter buffer-substring-filters)
3342 (setq string (funcall filter string)))
3343 string)))
3344 (t
3345 (buffer-substring beg end)))))
3348 ;;;; Window system cut and paste hooks.
3350 (defvar interprogram-cut-function nil
3351 "Function to call to make a killed region available to other programs.
3352 Most window systems provide a facility for cutting and pasting
3353 text between different programs, such as the clipboard on X and
3354 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3356 This variable holds a function that Emacs calls whenever text is
3357 put in the kill ring, to make the new kill available to other
3358 programs. The function takes one argument, TEXT, which is a
3359 string containing the text which should be made available.")
3361 (defvar interprogram-paste-function nil
3362 "Function to call to get text cut from other programs.
3363 Most window systems provide a facility for cutting and pasting
3364 text between different programs, such as the clipboard on X and
3365 MS-Windows, or the pasteboard on Nextstep/Mac OS.
3367 This variable holds a function that Emacs calls to obtain text
3368 that other programs have provided for pasting. The function is
3369 called with no arguments. If no other program has provided text
3370 to paste, the function should return nil (in which case the
3371 caller, usually `current-kill', should use the top of the Emacs
3372 kill ring). If another program has provided text to paste, the
3373 function should return that text as a string (in which case the
3374 caller should put this string in the kill ring as the latest
3375 kill).
3377 The function may also return a list of strings if the window
3378 system supports multiple selections. The first string will be
3379 used as the pasted text, but the other will be placed in the kill
3380 ring for easy access via `yank-pop'.
3382 Note that the function should return a string only if a program
3383 other than Emacs has provided a string for pasting; if Emacs
3384 provided the most recent string, the function should return nil.
3385 If it is difficult to tell whether Emacs or some other program
3386 provided the current string, it is probably good enough to return
3387 nil if the string is equal (according to `string=') to the last
3388 text Emacs provided.")
3389 \f
3392 ;;;; The kill ring data structure.
3394 (defvar kill-ring nil
3395 "List of killed text sequences.
3396 Since the kill ring is supposed to interact nicely with cut-and-paste
3397 facilities offered by window systems, use of this variable should
3398 interact nicely with `interprogram-cut-function' and
3399 `interprogram-paste-function'. The functions `kill-new',
3400 `kill-append', and `current-kill' are supposed to implement this
3401 interaction; you may want to use them instead of manipulating the kill
3402 ring directly.")
3404 (defcustom kill-ring-max 60
3405 "Maximum length of kill ring before oldest elements are thrown away."
3406 :type 'integer
3407 :group 'killing)
3409 (defvar kill-ring-yank-pointer nil
3410 "The tail of the kill ring whose car is the last thing yanked.")
3412 (defcustom save-interprogram-paste-before-kill nil
3413 "Save clipboard strings into kill ring before replacing them.
3414 When one selects something in another program to paste it into Emacs,
3415 but kills something in Emacs before actually pasting it,
3416 this selection is gone unless this variable is non-nil,
3417 in which case the other program's selection is saved in the `kill-ring'
3419 :type 'boolean
3420 :group 'killing
3421 :version "23.2")
3423 (defcustom kill-do-not-save-duplicates nil
3424 "Do not add a new string to `kill-ring' if it duplicates the last one.
3425 The comparison is done using `equal-including-properties'."
3426 :type 'boolean
3427 :group 'killing
3428 :version "23.2")
3430 (defun kill-new (string &optional replace yank-handler)
3431 "Make STRING the latest kill in the kill ring.
3432 Set `kill-ring-yank-pointer' to point to it.
3433 If `interprogram-cut-function' is non-nil, apply it to STRING.
3434 Optional second argument REPLACE non-nil means that STRING will replace
3435 the front of the kill ring, rather than being added to the list.
3437 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3438 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3439 STRING.
3441 When the yank handler has a non-nil PARAM element, the original STRING
3442 argument is not used by `insert-for-yank'. However, since Lisp code
3443 may access and use elements from the kill ring directly, the STRING
3445 (if (> (length string) 0)
3446 (if yank-handler
3447 (put-text-property 0 (length string)
3448 'yank-handler yank-handler string))
3449 (if yank-handler
3450 (signal 'args-out-of-range
3451 (list string "yank-handler specified for empty string"))))
3452 (unless (and kill-do-not-save-duplicates
3453 ;; Due to text properties such as 'yank-handler that
3454 ;; can alter the contents to yank, comparison using
3455 ;; `equal' is unsafe.
3456 (equal-including-properties string (car kill-ring)))
3457 (if (fboundp 'menu-bar-update-yank-menu)
3458 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3459 (when save-interprogram-paste-before-kill
3460 (let ((interprogram-paste (and interprogram-paste-function
3461 (funcall interprogram-paste-function))))
3462 (when interprogram-paste
3463 (dolist (s (if (listp interprogram-paste)
3464 (nreverse interprogram-paste)
3465 (list interprogram-paste)))
3466 (unless (and kill-do-not-save-duplicates
3467 (equal-including-properties s (car kill-ring)))
3468 (push s kill-ring))))))
3469 (unless (and kill-do-not-save-duplicates
3470 (equal-including-properties string (car kill-ring)))
3471 (if (and replace kill-ring)
3472 (setcar kill-ring string)
3473 (push string kill-ring)
3474 (if (> (length kill-ring) kill-ring-max)
3475 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3476 (setq kill-ring-yank-pointer kill-ring)
3477 (if interprogram-cut-function
3478 (funcall interprogram-cut-function string)))
3479 (set-advertised-calling-convention
3480 'kill-new '(string &optional replace) "23.3")
3482 (defun kill-append (string before-p &optional yank-handler)
3483 "Append STRING to the end of the latest kill in the kill ring.
3484 If BEFORE-P is non-nil, prepend STRING to the kill.
3485 If `interprogram-cut-function' is set, pass the resulting kill to it."
3486 (let* ((cur (car kill-ring)))
3487 (kill-new (if before-p (concat string cur) (concat cur string))
3488 (or (= (length cur) 0)
3489 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3490 yank-handler)))
3491 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3493 (defcustom yank-pop-change-selection nil
3494 "Whether rotating the kill ring changes the window system selection.
3495 If non-nil, whenever the kill ring is rotated (usually via the
3496 `yank-pop' command), Emacs also calls `interprogram-cut-function'
3497 to copy the new kill to the window system selection."
3498 :type 'boolean
3499 :group 'killing
3500 :version "23.1")
3502 (defun current-kill (n &optional do-not-move)
3503 "Rotate the yanking point by N places, and then return that kill.
3504 If N is zero and `interprogram-paste-function' is set to a
3505 function that returns a string or a list of strings, and if that
3506 function doesn't return nil, then that string (or list) is added
3507 to the front of the kill ring and the string (or first string in
3508 the list) is returned as the latest kill.
3510 If N is not zero, and if `yank-pop-change-selection' is
3511 non-nil, use `interprogram-cut-function' to transfer the
3512 kill at the new yank point into the window system selection.
3514 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3515 move the yanking point; just return the Nth kill forward."
3517 (let ((interprogram-paste (and (= n 0)
3518 interprogram-paste-function
3519 (funcall interprogram-paste-function))))
3520 (if interprogram-paste
3521 (progn
3522 ;; Disable the interprogram cut function when we add the new
3523 ;; text to the kill ring, so Emacs doesn't try to own the
3524 ;; selection, with identical text.
3525 (let ((interprogram-cut-function nil))
3526 (if (listp interprogram-paste)
3527 (mapc 'kill-new (nreverse interprogram-paste))
3528 (kill-new interprogram-paste)))
3529 (car kill-ring))
3530 (or kill-ring (error "Kill ring is empty"))
3531 (let ((ARGth-kill-element
3532 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3533 (length kill-ring))
3534 kill-ring)))
3535 (unless do-not-move
3536 (setq kill-ring-yank-pointer ARGth-kill-element)
3537 (when (and yank-pop-change-selection
3538 (> n 0)
3539 interprogram-cut-function)
3540 (funcall interprogram-cut-function (car ARGth-kill-element))))
3541 (car ARGth-kill-element)))))
3545 ;;;; Commands for manipulating the kill ring.
3547 (defcustom kill-read-only-ok nil
3548 "Non-nil means don't signal an error for killing read-only text."
3549 :type 'boolean
3550 :group 'killing)
3552 (defun kill-region (beg end &optional yank-handler)
3554 This deletes the text from the buffer and saves it in the kill ring.
3558 If you want to append the killed region to the last killed text,
3561 If the buffer is read-only, Emacs will beep and refrain from deleting
3562 the text, but put the text in the kill ring anyway. This means that
3563 you can use the killing commands to copy text from a read-only buffer.
3565 Lisp programs should use this function for killing text.
3566 (To delete text, use `delete-region'.)
3567 Supply two arguments, character positions indicating the stretch of text
3568 to be killed.
3570 If the previous command was also a kill command,
3571 the text killed this time appends to the text killed last time
3572 to make one entry in the kill ring."
3573 ;; Pass point first, then mark, because the order matters
3574 ;; when calling kill-append.
3575 (interactive (list (point) (mark)))
3576 (unless (and beg end)
3577 (error "The mark is not set now, so there is no region"))
3578 (condition-case nil
3579 (let ((string (filter-buffer-substring beg end t)))
3580 (when string ;STRING is nil if BEG = END
3581 ;; Add that string to the kill ring, one way or another.
3582 (if (eq last-command 'kill-region)
3583 (kill-append string (< end beg) yank-handler)
3584 (kill-new string nil yank-handler)))
3585 (when (or string (eq last-command 'kill-region))
3586 (setq this-command 'kill-region))
3587 (setq deactivate-mark t)
3588 nil)
3589 ((buffer-read-only text-read-only)
3590 ;; The code above failed because the buffer, or some of the characters
3591 ;; in the region, are read-only.
3592 ;; We should beep, in case the user just isn't aware of this.
3593 ;; However, there's no harm in putting
3594 ;; the region's text in the kill ring, anyway.
3595 (copy-region-as-kill beg end)
3596 ;; Set this-command now, so it will be set even if we get an error.
3597 (setq this-command 'kill-region)
3598 ;; This should barf, if appropriate, and give us the correct error.
3599 (if kill-read-only-ok
3600 (progn (message "Read only text copied to kill ring") nil)
3601 ;; Signal an error if the buffer is read-only.
3602 (barf-if-buffer-read-only)
3603 ;; If the buffer isn't read-only, the text is.
3604 (signal 'text-read-only (list (current-buffer)))))))
3605 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3607 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3608 ;; to get two copies of the text when the user accidentally types M-w and
3609 ;; then corrects it with the intended C-w.
3610 (defun copy-region-as-kill (beg end)
3611 "Save the region as if killed, but don't kill it.
3612 In Transient Mark mode, deactivate the mark.
3613 If `interprogram-cut-function' is non-nil, also save the text for a window
3614 system cut and paste.
3616 This command's old key binding has been given to `kill-ring-save'."
3617 (interactive "r")
3618 (if (eq last-command 'kill-region)
3619 (kill-append (filter-buffer-substring beg end) (< end beg))
3620 (kill-new (filter-buffer-substring beg end)))
3621 (setq deactivate-mark t)
3622 nil)
3624 (defun kill-ring-save (beg end)
3625 "Save the region as if killed, but don't kill it.
3626 In Transient Mark mode, deactivate the mark.
3627 If `interprogram-cut-function' is non-nil, also save the text for a window
3628 system cut and paste.
3630 If you want to append the killed line to the last killed text,
3633 This command is similar to `copy-region-as-kill', except that it gives
3634 visual feedback indicating the extent of the region being copied."
3635 (interactive "r")
3636 (copy-region-as-kill beg end)
3637 ;; This use of called-interactively-p is correct because the code it
3638 ;; controls just gives the user visual feedback.
3639 (if (called-interactively-p 'interactive)
3640 (indicate-copied-region)))
3642 (defun indicate-copied-region (&optional message-len)
3643 "Indicate that the region text has been copied interactively.
3644 If the mark is visible in the selected window, blink the cursor
3645 between point and mark if there is currently no active region
3646 highlighting.
3648 If the mark lies outside the selected window, display an
3649 informative message containing a sample of the copied text. The
3650 optional argument MESSAGE-LEN, if non-nil, specifies the length
3651 of this sample text; it defaults to 40."
3652 (let ((mark (mark t))
3653 (point (point))
3654 ;; Inhibit quitting so we can make a quit here
3655 ;; look like a C-g typed as a command.
3656 (inhibit-quit t))
3657 (if (pos-visible-in-window-p mark (selected-window))
3658 ;; Swap point-and-mark quickly so as to show the region that
3659 ;; was selected. Don't do it if the region is highlighted.
3660 (unless (and (region-active-p)
3661 (face-background 'region))
3662 ;; Swap point and mark.
3663 (set-marker (mark-marker) (point) (current-buffer))
3664 (goto-char mark)
3665 (sit-for blink-matching-delay)
3666 ;; Swap back.
3667 (set-marker (mark-marker) mark (current-buffer))
3668 (goto-char point)
3669 ;; If user quit, deactivate the mark
3670 ;; as C-g would as a command.
3671 (and quit-flag mark-active
3672 (deactivate-mark)))
3673 (let ((len (min (abs (- mark point))
3674 (or message-len 40))))
3675 (if (< point mark)
3676 ;; Don't say "killed"; that is misleading.
3678 (buffer-substring-no-properties (- mark len) mark))
3680 (buffer-substring-no-properties mark (+ mark len))))))))
3682 (defun append-next-kill (&optional interactive)
3683 "Cause following command, if it kills, to append to previous kill.
3684 The argument is used for internal purposes; do not supply one."
3685 (interactive "p")
3686 ;; We don't use (interactive-p), since that breaks kbd macros.
3687 (if interactive
3688 (progn
3689 (setq this-command 'kill-region)
3690 (message "If the next command is a kill, it will append"))
3691 (setq last-command 'kill-region)))
3692 \f
3693 ;; Yanking.
3695 (defcustom yank-handled-properties
3696 '((font-lock-face . yank-handle-font-lock-face-property)
3697 (category . yank-handle-category-property))
3698 "List of special text property handling conditions for yanking.
3699 Each element should have the form (PROP . FUN), where PROP is a
3700 property symbol and FUN is a function. When the `yank' command
3701 inserts text into the buffer, it scans the inserted text for
3702 stretches of text that have `eq' values of the text property
3703 PROP; for each such stretch of text, FUN is called with three
3704 arguments: the property's value in that text, and the start and
3705 end positions of the text.
3707 This is done prior to removing the properties specified by
3708 `yank-excluded-properties'."
3709 :group 'killing
3710 :version "24.3")
3712 ;; This is actually used in subr.el but defcustom does not work there.
3713 (defcustom yank-excluded-properties
3714 '(category field follow-link fontified font-lock-face help-echo
3715 intangible invisible keymap local-map mouse-face read-only
3716 yank-handler)
3717 "Text properties to discard when yanking.
3718 The value should be a list of text properties to discard or t,
3719 which means to discard all text properties.
3721 See also `yank-handled-properties'."
3722 :type '(choice (const :tag "All" t) (repeat symbol))
3723 :group 'killing
3724 :version "24.3")
3726 (defvar yank-window-start nil)
3727 (defvar yank-undo-function nil
3728 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3729 Function is called with two parameters, START and END corresponding to
3730 the value of the mark and point; it is guaranteed that START <= END.
3731 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3733 (defun yank-pop (&optional arg)
3734 "Replace just-yanked stretch of killed text with a different stretch.
3735 This command is allowed only immediately after a `yank' or a `yank-pop'.
3736 At such a time, the region contains a stretch of reinserted
3737 previously-killed text. `yank-pop' deletes that text and inserts in its
3738 place a different stretch of killed text.
3740 With no argument, the previous kill is inserted.
3741 With argument N, insert the Nth previous kill.
3742 If N is negative, this is a more recent kill.
3744 The sequence of kills wraps around, so that after the oldest one
3745 comes the newest one.
3747 When this command inserts killed text into the buffer, it honors
3748 `yank-excluded-properties' and `yank-handler' as described in the
3749 doc string for `insert-for-yank-1', which see."
3750 (interactive "*p")
3751 (if (not (eq last-command 'yank))
3752 (error "Previous command was not a yank"))
3753 (setq this-command 'yank)
3754 (unless arg (setq arg 1))
3755 (let ((inhibit-read-only t)
3756 (before (< (point) (mark t))))
3757 (if before
3758 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3759 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3760 (setq yank-undo-function nil)
3761 (set-marker (mark-marker) (point) (current-buffer))
3762 (insert-for-yank (current-kill arg))
3763 ;; Set the window start back where it was in the yank command,
3764 ;; if possible.
3765 (set-window-start (selected-window) yank-window-start t)
3766 (if before
3767 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3768 ;; It is cleaner to avoid activation, even though the command
3769 ;; loop would deactivate the mark because we inserted text.
3770 (goto-char (prog1 (mark t)
3771 (set-marker (mark-marker) (point) (current-buffer))))))
3772 nil)
3774 (defun yank (&optional arg)
3776 More precisely, reinsert the most recent kill, which is the
3777 stretch of killed text most recently killed OR yanked. Put point
3778 at the end, and set mark at the beginning without activating it.
3780 With argument N, reinsert the Nth most recent kill.
3782 When this command inserts text into the buffer, it honors the
3783 `yank-handled-properties' and `yank-excluded-properties'
3784 variables, and the `yank-handler' text property. See
3785 `insert-for-yank-1' for details.
3788 (interactive "*P")
3789 (setq yank-window-start (window-start))
3790 ;; If we don't get all the way thru, make last-command indicate that
3791 ;; for the following command.
3792 (setq this-command t)
3793 (push-mark (point))
3794 (insert-for-yank (current-kill (cond
3795 ((listp arg) 0)
3796 ((eq arg '-) -2)
3797 (t (1- arg)))))
3798 (if (consp arg)
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 ;; If we do get all the way thru, make this-command indicate that.
3805 (if (eq this-command t)
3806 (setq this-command 'yank))
3807 nil)
3809 (defun rotate-yank-pointer (arg)
3810 "Rotate the yanking point in the kill ring.
3811 With ARG, rotate that many kills forward (or backward, if negative)."
3812 (interactive "p")
3813 (current-kill arg))
3814 \f
3815 ;; Some kill commands.
3817 ;; Internal subroutine of delete-char
3818 (defun kill-forward-chars (arg)
3819 (if (listp arg) (setq arg (car arg)))
3820 (if (eq arg '-) (setq arg -1))
3821 (kill-region (point) (+ (point) arg)))
3823 ;; Internal subroutine of backward-delete-char
3824 (defun kill-backward-chars (arg)
3825 (if (listp arg) (setq arg (car arg)))
3826 (if (eq arg '-) (setq arg -1))
3827 (kill-region (point) (- (point) arg)))
3829 (defcustom backward-delete-char-untabify-method 'untabify
3830 "The method for untabifying when deleting backward.
3831 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3832 `hungry' -- delete all whitespace, both tabs and spaces;
3833 `all' -- delete all whitespace, including tabs, spaces and newlines;
3834 nil -- just delete one character."
3835 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3836 :version "20.3"
3837 :group 'killing)
3839 (defun backward-delete-char-untabify (arg &optional killp)
3840 "Delete characters backward, changing tabs into spaces.
3841 The exact behavior depends on `backward-delete-char-untabify-method'.
3842 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3843 Interactively, ARG is the prefix arg (default 1)
3844 and KILLP is t if a prefix arg was specified."
3846 (when (eq backward-delete-char-untabify-method 'untabify)
3847 (let ((count arg))
3848 (save-excursion
3849 (while (and (> count 0) (not (bobp)))
3851 (let ((col (current-column)))
3852 (forward-char -1)
3853 (setq col (- col (current-column)))
3854 (insert-char ?\s col)
3855 (delete-char 1)))
3856 (forward-char -1)
3857 (setq count (1- count))))))
3859 ((eq backward-delete-char-untabify-method 'all)
3861 (n (if skip
3862 (let* ((oldpt (point))
3863 (wh (- oldpt (save-excursion
3864 (skip-chars-backward skip)
3865 (constrain-to-field nil oldpt)))))
3866 (+ arg (if (zerop wh) 0 (1- wh))))
3867 arg)))
3868 ;; Avoid warning about delete-backward-char
3869 (with-no-warnings (delete-backward-char n killp))))
3871 (defun zap-to-char (arg char)
3872 "Kill up to and including ARGth occurrence of CHAR.
3873 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3874 Goes backward if ARG is negative; error if CHAR not found."
3875 (interactive (list (prefix-numeric-value current-prefix-arg)
3876 (read-char "Zap to char: " t)))
3877 ;; Avoid "obsolete" warnings for translation-table-for-input.
3878 (with-no-warnings
3879 (if (char-table-p translation-table-for-input)
3880 (setq char (or (aref translation-table-for-input char) char))))
3881 (kill-region (point) (progn
3882 (search-forward (char-to-string char) nil nil arg)
3883 (point))))
3885 ;; kill-line and its subroutines.
3887 (defcustom kill-whole-line nil
3888 "If non-nil, `kill-line' with no arg at start of line kills the whole line."
3889 :type 'boolean
3890 :group 'killing)
3892 (defun kill-line (&optional arg)
3893 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3894 With prefix argument ARG, kill that many lines from point.
3895 Negative arguments kill lines backward.
3896 With zero argument, kills the text before point on the current line.
3899 a number counts as a prefix arg.
3901 To kill a whole line, when point is not at the beginning, type \
3904 If `show-trailing-whitespace' is non-nil, this command will just
3905 kill the rest of the current line, even if there are only
3906 nonblanks there.
3908 If option `kill-whole-line' is non-nil, then this command kills the whole line
3909 including its terminating newline, when used at the beginning of a line
3910 with no argument. As a consequence, you can always kill a whole line
3913 If you want to append the killed line to the last killed text,
3916 If the buffer is read-only, Emacs will beep and refrain from deleting
3917 the line, but put the line in the kill ring anyway. This means that
3918 you can use this command to copy text from a read-only buffer.
3919 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3920 even beep.)"
3921 (interactive "P")
3922 (kill-region (point)
3923 ;; It is better to move point to the other end of the kill
3924 ;; before killing. That way, in a read-only buffer, point
3925 ;; moves across the text that is copied to the kill ring.
3926 ;; The choice has no effect on undo now that undo records
3927 ;; the value of point from before the command was run.
3928 (progn
3929 (if arg
3930 (forward-visible-line (prefix-numeric-value arg))
3931 (if (eobp)
3932 (signal 'end-of-buffer nil))
3933 (let ((end
3934 (save-excursion
3935 (end-of-visible-line) (point))))
3936 (if (or (save-excursion
3937 ;; If trailing whitespace is visible,
3938 ;; don't treat it as nothing.
3939 (unless show-trailing-whitespace
3941 (= (point) end))
3942 (and kill-whole-line (bolp)))
3943 (forward-visible-line 1)
3944 (goto-char end))))
3945 (point))))
3947 (defun kill-whole-line (&optional arg)
3948 "Kill current line.
3949 With prefix ARG, kill that many lines starting from the current line.
3950 If ARG is negative, kill backward. Also kill the preceding newline.
3952 If ARG is zero, kill current line but exclude the trailing newline."
3953 (interactive "p")
3954 (or arg (setq arg 1))
3955 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3956 (signal 'end-of-buffer nil))
3957 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3958 (signal 'beginning-of-buffer nil))
3959 (unless (eq last-command 'kill-region)
3960 (kill-new "")
3961 (setq last-command 'kill-region))
3962 (cond ((zerop arg)
3963 ;; We need to kill in two steps, because the previous command
3964 ;; could have been a kill command, in which case the text
3965 ;; before point needs to be prepended to the current kill
3966 ;; ring entry and the text after point appended. Also, we
3967 ;; need to use save-excursion to avoid copying the same text
3968 ;; twice to the kill ring in read-only buffers.
3969 (save-excursion
3970 (kill-region (point) (progn (forward-visible-line 0) (point))))
3971 (kill-region (point) (progn (end-of-visible-line) (point))))
3972 ((< arg 0)
3973 (save-excursion
3974 (kill-region (point) (progn (end-of-visible-line) (point))))
3975 (kill-region (point)
3976 (progn (forward-visible-line (1+ arg))
3977 (unless (bobp) (backward-char))
3978 (point))))
3979 (t
3980 (save-excursion
3981 (kill-region (point) (progn (forward-visible-line 0) (point))))
3982 (kill-region (point)
3983 (progn (forward-visible-line arg) (point))))))
3985 (defun forward-visible-line (arg)
3986 "Move forward by ARG lines, ignoring currently invisible newlines only.
3987 If ARG is negative, move backward -ARG lines.
3988 If ARG is zero, move to the beginning of the current line."
3989 (condition-case nil
3990 (if (> arg 0)
3991 (progn
3992 (while (> arg 0)
3993 (or (zerop (forward-line 1))
3994 (signal 'end-of-buffer nil))
3995 ;; If the newline we just skipped is invisible,
3996 ;; don't count it.
3997 (let ((prop
3998 (get-char-property (1- (point)) 'invisible)))
3999 (if (if (eq buffer-invisibility-spec t)
4000 prop
4001 (or (memq prop buffer-invisibility-spec)
4002 (assq prop buffer-invisibility-spec)))
4003 (setq arg (1+ arg))))
4004 (setq arg (1- arg)))
4005 ;; If invisible text follows, and it is a number of complete lines,
4006 ;; skip it.
4007 (let ((opoint (point)))
4008 (while (and (not (eobp))
4009 (let ((prop
4010 (get-char-property (point) 'invisible)))
4011 (if (eq buffer-invisibility-spec t)
4012 prop
4013 (or (memq prop buffer-invisibility-spec)
4014 (assq prop buffer-invisibility-spec)))))
4015 (goto-char
4016 (if (get-text-property (point) 'invisible)
4017 (or (next-single-property-change (point) 'invisible)
4018 (point-max))
4019 (next-overlay-change (point)))))
4020 (unless (bolp)
4021 (goto-char opoint))))
4022 (let ((first t))
4023 (while (or first (<= arg 0))
4024 (if first
4025 (beginning-of-line)
4026 (or (zerop (forward-line -1))
4027 (signal 'beginning-of-buffer nil)))
4028 ;; If the newline we just moved to is invisible,
4029 ;; don't count it.
4030 (unless (bobp)
4031 (let ((prop
4032 (get-char-property (1- (point)) 'invisible)))
4033 (unless (if (eq buffer-invisibility-spec t)
4034 prop
4035 (or (memq prop buffer-invisibility-spec)
4036 (assq prop buffer-invisibility-spec)))
4037 (setq arg (1+ arg)))))
4038 (setq first nil))
4039 ;; If invisible text follows, and it is a number of complete lines,
4040 ;; skip it.
4041 (let ((opoint (point)))
4042 (while (and (not (bobp))
4043 (let ((prop
4044 (get-char-property (1- (point)) 'invisible)))
4045 (if (eq buffer-invisibility-spec t)
4046 prop
4047 (or (memq prop buffer-invisibility-spec)
4048 (assq prop buffer-invisibility-spec)))))
4049 (goto-char
4050 (if (get-text-property (1- (point)) 'invisible)
4051 (or (previous-single-property-change (point) 'invisible)
4052 (point-min))
4053 (previous-overlay-change (point)))))
4054 (unless (bolp)
4055 (goto-char opoint)))))
4056 ((beginning-of-buffer end-of-buffer)
4057 nil)))
4059 (defun end-of-visible-line ()
4060 "Move to end of current visible line."
4061 (end-of-line)
4062 ;; If the following character is currently invisible,
4063 ;; skip all characters with that same `invisible' property value,
4064 ;; then find the next newline.
4065 (while (and (not (eobp))
4066 (save-excursion
4068 (let ((prop
4069 (get-char-property (point) 'invisible)))
4070 (if (eq buffer-invisibility-spec t)
4071 prop
4072 (or (memq prop buffer-invisibility-spec)
4073 (assq prop buffer-invisibility-spec))))))
4075 (if (get-text-property (point) 'invisible)
4076 (goto-char (or (next-single-property-change (point) 'invisible)
4077 (point-max)))
4078 (goto-char (next-overlay-change (point))))
4079 (end-of-line)))
4080 \f
4081 (defun insert-buffer (buffer)
4082 "Insert after point the contents of BUFFER.
4083 Puts mark after the inserted text.
4084 BUFFER may be a buffer or a buffer name.
4086 This function is meant for the user to run interactively.
4087 Don't call it from programs: use `insert-buffer-substring' instead!"
4088 (interactive
4089 (list
4090 (progn
4091 (barf-if-buffer-read-only)
4092 (read-buffer "Insert buffer: "
4093 (if (eq (selected-window) (next-window (selected-window)))
4094 (other-buffer (current-buffer))
4095 (window-buffer (next-window (selected-window))))
4096 t))))
4097 (push-mark
4098 (save-excursion
4099 (insert-buffer-substring (get-buffer buffer))
4100 (point)))
4101 nil)
4103 (defun append-to-buffer (buffer start end)
4104 "Append to specified buffer the text of the region.
4105 It is inserted into that buffer before its point.
4107 When calling from a program, give three arguments:
4108 BUFFER (or buffer name), START and END.
4109 START and END specify the portion of the current buffer to be copied."
4110 (interactive
4111 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
4112 (region-beginning) (region-end)))
4113 (let* ((oldbuf (current-buffer))
4114 (append-to (get-buffer-create buffer))
4115 (windows (get-buffer-window-list append-to t t))
4116 point)
4117 (save-excursion
4118 (with-current-buffer append-to
4119 (setq point (point))
4120 (barf-if-buffer-read-only)
4121 (insert-buffer-substring oldbuf start end)
4122 (dolist (window windows)
4123 (when (= (window-point window) point)
4124 (set-window-point window (point))))))))
4126 (defun prepend-to-buffer (buffer start end)
4127 "Prepend to specified buffer the text of the region.
4128 It is inserted into that buffer after its point.
4130 When calling from a program, give three arguments:
4131 BUFFER (or buffer name), START and END.
4132 START and END specify the portion of the current buffer to be copied."
4134 (let ((oldbuf (current-buffer)))
4135 (with-current-buffer (get-buffer-create buffer)
4136 (barf-if-buffer-read-only)
4137 (save-excursion
4138 (insert-buffer-substring oldbuf start end)))))
4140 (defun copy-to-buffer (buffer start end)
4141 "Copy to specified buffer the text of the region.
4142 It is inserted into that buffer, replacing existing text there.
4144 When calling from a program, give three arguments:
4145 BUFFER (or buffer name), START and END.
4146 START and END specify the portion of the current buffer to be copied."
4148 (let ((oldbuf (current-buffer)))
4149 (with-current-buffer (get-buffer-create buffer)
4150 (barf-if-buffer-read-only)
4151 (erase-buffer)
4152 (save-excursion
4153 (insert-buffer-substring oldbuf start end)))))
4154 \f
4155 (put 'mark-inactive 'error-conditions '(mark-inactive error))
4156 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
4158 (defvar activate-mark-hook nil
4159 "Hook run when the mark becomes active.
4160 It is also run at the end of a command, if the mark is active and
4161 it is possible that the region may have changed.")
4163 (defvar deactivate-mark-hook nil
4164 "Hook run when the mark becomes inactive.")
4166 (defun mark (&optional force)
4167 "Return this buffer's mark value as integer, or nil if never set.
4169 In Transient Mark mode, this function signals an error if
4170 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
4171 or the argument FORCE is non-nil, it disregards whether the mark
4172 is active, and returns an integer or nil in the usual way.
4174 If you are using this in an editing command, you are most likely making
4175 a mistake; see the documentation of `set-mark'."
4176 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
4177 (marker-position (mark-marker))
4178 (signal 'mark-inactive nil)))
4180 (defun deactivate-mark (&optional force)
4181 "Deactivate the mark.
4182 If Transient Mark mode is disabled, this function normally does
4183 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
4185 Deactivating the mark sets `mark-active' to nil, updates the
4186 primary selection according to `select-active-regions', and runs
4187 `deactivate-mark-hook'.
4189 If Transient Mark mode was temporarily enabled, reset the value
4190 of the variable `transient-mark-mode'; if this causes Transient
4191 Mark mode to be disabled, don't change `mark-active' to nil or
4192 run `deactivate-mark-hook'."
4193 (when (or transient-mark-mode force)
4194 (when (and (if (eq select-active-regions 'only)
4195 (eq (car-safe transient-mark-mode) 'only)
4196 select-active-regions)
4197 (region-active-p)
4198 (display-selections-p))
4199 ;; The var `saved-region-selection', if non-nil, is the text in
4200 ;; the region prior to the last command modifying the buffer.
4201 ;; Set the selection to that, or to the current region.
4202 (cond (saved-region-selection
4203 (x-set-selection 'PRIMARY saved-region-selection)
4204 (setq saved-region-selection nil))
4205 ;; If another program has acquired the selection, region
4206 ;; deactivation should not clobber it (Bug#11772).
4207 ((and (/= (region-beginning) (region-end))
4208 (or (x-selection-owner-p 'PRIMARY)
4209 (null (x-selection-exists-p 'PRIMARY))))
4210 (x-set-selection 'PRIMARY
4211 (buffer-substring (region-beginning)
4212 (region-end))))))
4213 (if (and (null force)
4214 (or (eq transient-mark-mode 'lambda)
4215 (and (eq (car-safe transient-mark-mode) 'only)
4216 (null (cdr transient-mark-mode)))))
4217 ;; When deactivating a temporary region, don't change
4218 ;; `mark-active' or run `deactivate-mark-hook'.
4219 (setq transient-mark-mode nil)
4220 (if (eq (car-safe transient-mark-mode) 'only)
4221 (setq transient-mark-mode (cdr transient-mark-mode)))
4222 (setq mark-active nil)
4223 (run-hooks 'deactivate-mark-hook))))
4225 (defun activate-mark ()
4226 "Activate the mark."
4227 (when (mark t)
4228 (setq mark-active t)
4229 (unless transient-mark-mode
4230 (setq transient-mark-mode 'lambda))
4231 (run-hooks 'activate-mark-hook)))
4233 (defun set-mark (pos)
4234 "Set this buffer's mark to POS. Don't use this function!
4235 That is to say, don't use this function unless you want
4236 the user to see that the mark has moved, and you want the previous
4237 mark position to be lost.
4239 Normally, when a new mark is set, the old one should go on the stack.
4240 This is why most applications should use `push-mark', not `set-mark'.
4242 Novice Emacs Lisp programmers often try to use the mark for the wrong
4243 purposes. The mark saves a location for the user's convenience.
4244 Most editing commands should not alter the mark.
4245 To remember a location for internal use in the Lisp program,
4246 store it in a Lisp variable. Example:
4248 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
4250 (if pos
4251 (progn
4252 (setq mark-active t)
4253 (run-hooks 'activate-mark-hook)
4254 (set-marker (mark-marker) pos (current-buffer)))
4255 ;; Normally we never clear mark-active except in Transient Mark mode.
4256 ;; But when we actually clear out the mark value too, we must
4257 ;; clear mark-active in any mode.
4258 (deactivate-mark t)
4259 (set-marker (mark-marker) nil)))
4261 (defcustom use-empty-active-region nil
4263 If nil, region-aware commands treat empty regions as inactive.
4264 If non-nil, region-aware commands treat the region as active as
4265 long as the mark is active, even if the region is empty.
4267 Region-aware commands are those that act on the region if it is
4268 active and Transient Mark mode is enabled, and on the text near
4269 point otherwise."
4270 :type 'boolean
4271 :version "23.1"
4272 :group 'editing-basics)
4274 (defun use-region-p ()
4275 "Return t if the region is active and it is appropriate to act on it.
4276 This is used by commands that act specially on the region under
4277 Transient Mark mode.
4279 The return value is t if Transient Mark mode is enabled and the
4280 mark is active; furthermore, if `use-empty-active-region' is nil,
4281 the region must not be empty. Otherwise, the return value is nil.
4283 For some commands, it may be appropriate to ignore the value of
4284 `use-empty-active-region'; in that case, use `region-active-p'."
4285 (and (region-active-p)
4286 (or use-empty-active-region (> (region-end) (region-beginning)))))
4288 (defun region-active-p ()
4289 "Return t if Transient Mark mode is enabled and the mark is active.
4291 Some commands act specially on the region when Transient Mark
4292 mode is enabled. Usually, such commands should use
4293 `use-region-p' instead of this function, because `use-region-p'
4294 also checks the value of `use-empty-active-region'."
4295 (and transient-mark-mode mark-active))
4297 (defvar mark-ring nil
4298 "The list of former marks of the current buffer, most recent first.")
4299 (make-variable-buffer-local 'mark-ring)
4300 (put 'mark-ring 'permanent-local t)
4302 (defcustom mark-ring-max 16
4303 "Maximum size of mark ring. Start discarding off end if gets this big."
4304 :type 'integer
4305 :group 'editing-basics)
4307 (defvar global-mark-ring nil
4308 "The list of saved global marks, most recent first.")
4310 (defcustom global-mark-ring-max 16
4311 "Maximum size of global mark ring. \
4312 Start discarding off end if gets this big."
4313 :type 'integer
4314 :group 'editing-basics)
4316 (defun pop-to-mark-command ()
4317 "Jump to mark, and pop a new position for mark off the ring.
4318 \(Does not affect global mark ring\)."
4319 (interactive)
4320 (if (null (mark t))
4321 (error "No mark set in this buffer")
4322 (if (= (point) (mark t))
4323 (message "Mark popped"))
4324 (goto-char (mark t))
4325 (pop-mark)))
4327 (defun push-mark-command (arg &optional nomsg)
4328 "Set mark at where point is.
4329 If no prefix ARG and mark is already set there, just activate it.
4330 Display `Mark set' unless the optional second arg NOMSG is non-nil."
4331 (interactive "P")
4332 (let ((mark (marker-position (mark-marker))))
4333 (if (or arg (null mark) (/= mark (point)))
4334 (push-mark nil nomsg t)
4335 (setq mark-active t)
4336 (run-hooks 'activate-mark-hook)
4337 (unless nomsg
4338 (message "Mark activated")))))
4340 (defcustom set-mark-command-repeat-pop nil
4343 will pop the mark twice, and
4345 will pop the mark three times.
4349 :type 'boolean
4350 :group 'editing-basics)
4352 (defun set-mark-command (arg)
4353 "Set the mark where point is, or jump to the mark.
4354 Setting the mark also alters the region, which is the text
4355 between point and mark; this is the closest equivalent in
4358 With no prefix argument, set the mark at point, and push the
4359 old mark position on local mark ring. Also push the old mark on
4360 global mark ring, if the previous mark was set in another buffer.
4362 When Transient Mark Mode is off, immediately repeating this
4363 command activates `transient-mark-mode' temporarily.
4366 jump to the mark, and set the mark from
4367 position popped off the local mark ring \(this does not affect the global
4369 mark ring \(see `pop-global-mark'\).
4371 If `set-mark-command-repeat-pop' is non-nil, repeating
4373 off the local (or global) mark ring and jumps there.
4376 argument, unconditionally set mark where point is, even if
4377 `set-mark-command-repeat-pop' is non-nil.
4379 Novice Emacs Lisp programmers often try to use the mark for the wrong
4380 purposes. See the documentation of `set-mark' for more information."
4381 (interactive "P")
4382 (cond ((eq transient-mark-mode 'lambda)
4383 (setq transient-mark-mode nil))
4384 ((eq (car-safe transient-mark-mode) 'only)
4385 (deactivate-mark)))
4386 (cond
4387 ((and (consp arg) (> (prefix-numeric-value arg) 4))
4388 (push-mark-command nil))
4389 ((not (eq this-command 'set-mark-command))
4390 (if arg
4391 (pop-to-mark-command)
4392 (push-mark-command t)))
4393 ((and set-mark-command-repeat-pop
4394 (eq last-command 'pop-to-mark-command))
4395 (setq this-command 'pop-to-mark-command)
4396 (pop-to-mark-command))
4397 ((and set-mark-command-repeat-pop
4398 (eq last-command 'pop-global-mark)
4399 (not arg))
4400 (setq this-command 'pop-global-mark)
4401 (pop-global-mark))
4402 (arg
4403 (setq this-command 'pop-to-mark-command)
4404 (pop-to-mark-command))
4405 ((eq last-command 'set-mark-command)
4406 (if (region-active-p)
4407 (progn
4408 (deactivate-mark)
4409 (message "Mark deactivated"))
4410 (activate-mark)
4411 (message "Mark activated")))
4412 (t
4413 (push-mark-command nil))))
4415 (defun push-mark (&optional location nomsg activate)
4416 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4417 If the last global mark pushed was not in the current buffer,
4418 also push LOCATION on the global mark ring.
4419 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4421 Novice Emacs Lisp programmers often try to use the mark for the wrong
4422 purposes. See the documentation of `set-mark' for more information.
4424 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4425 (unless (null (mark t))
4426 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4427 (when (> (length mark-ring) mark-ring-max)
4428 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4429 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4430 (set-marker (mark-marker) (or location (point)) (current-buffer))
4431 ;; Now push the mark on the global mark ring.
4432 (if (and global-mark-ring
4433 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4434 ;; The last global mark pushed was in this same buffer.
4435 ;; Don't push another one.
4436 nil
4437 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4438 (when (> (length global-mark-ring) global-mark-ring-max)
4439 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4440 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4441 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4442 (message "Mark set"))
4443 (if (or activate (not transient-mark-mode))
4444 (set-mark (mark t)))
4445 nil)
4447 (defun pop-mark ()
4448 "Pop off mark ring into the buffer's actual mark.
4449 Does not set point. Does nothing if mark ring is empty."
4450 (when mark-ring
4451 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4452 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4453 (move-marker (car mark-ring) nil)
4454 (if (null (mark t)) (ding))
4455 (setq mark-ring (cdr mark-ring)))
4456 (deactivate-mark))
4458 (define-obsolete-function-alias
4459 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4460 (defun exchange-point-and-mark (&optional arg)
4461 "Put the mark where point is now, and point where the mark is now.
4462 This command works even when the mark is not active,
4463 and it reactivates the mark.
4465 If Transient Mark mode is on, a prefix ARG deactivates the mark
4466 if it is active, and otherwise avoids reactivating it. If
4467 Transient Mark mode is off, a prefix ARG enables Transient Mark
4468 mode temporarily."
4469 (interactive "P")
4470 (let ((omark (mark t))
4471 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4472 (if (null omark)
4473 (error "No mark set in this buffer"))
4474 (deactivate-mark)
4475 (set-mark (point))
4476 (goto-char omark)
4477 (cond (temp-highlight
4478 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4479 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4480 (not (or arg (region-active-p))))
4481 (deactivate-mark))
4482 (t (activate-mark)))
4483 nil))
4485 (defcustom shift-select-mode t
4486 "When non-nil, shifted motion keys activate the mark momentarily.
4488 While the mark is activated in this way, any shift-translated point
4489 motion key extends the region, and if Transient Mark mode was off, it
4490 is temporarily turned on. Furthermore, the mark will be deactivated
4491 by any subsequent point motion key that was not shift-translated, or
4492 by any action that normally deactivates the mark in Transient Mark mode.
4494 See `this-command-keys-shift-translated' for the meaning of
4495 shift-translation."
4496 :type 'boolean
4497 :group 'editing-basics)
4499 (defun handle-shift-selection ()
4500 "Activate/deactivate mark depending on invocation thru shift translation.
4501 This function is called by `call-interactively' when a command
4502 with a `^' character in its `interactive' spec is invoked, before
4503 running the command itself.
4505 If `shift-select-mode' is enabled and the command was invoked
4506 through shift translation, set the mark and activate the region
4507 temporarily, unless it was already set in this way. See
4508 `this-command-keys-shift-translated' for the meaning of shift
4509 translation.
4511 Otherwise, if the region has been activated temporarily,
4512 deactivate it, and restore the variable `transient-mark-mode' to
4513 its earlier value."
4514 (cond ((and shift-select-mode this-command-keys-shift-translated)
4515 (unless (and mark-active
4516 (eq (car-safe transient-mark-mode) 'only))
4517 (setq transient-mark-mode
4518 (cons 'only
4519 (unless (eq transient-mark-mode 'lambda)
4520 transient-mark-mode)))
4521 (push-mark nil nil t)))
4522 ((eq (car-safe transient-mark-mode) 'only)
4523 (setq transient-mark-mode (cdr transient-mark-mode))
4524 (deactivate-mark))))
4526 (define-minor-mode transient-mark-mode
4527 "Toggle Transient Mark mode.
4528 With a prefix argument ARG, enable Transient Mark mode if ARG is
4529 positive, and disable it otherwise. If called from Lisp, enable
4530 Transient Mark mode if ARG is omitted or nil.
4532 Transient Mark mode is a global minor mode. When enabled, the
4533 region is highlighted whenever the mark is active. The mark is
4535 operations that set the mark but whose main purpose is something
4541 Many commands change their behavior when Transient Mark mode is
4542 in effect and the mark is active, by acting on the region instead
4543 of their usual default part of the buffer's text. Examples of
4546 To see the documentation of commands which are sensitive to the
4549 :global t
4550 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4551 :variable transient-mark-mode)
4553 (defvar widen-automatically t
4554 "Non-nil means it is ok for commands to call `widen' when they want to.
4555 Some commands will do this in order to go to positions outside
4556 the current accessible part of the buffer.
4558 If `widen-automatically' is nil, these commands will do something else
4559 as a fallback, and won't change the buffer bounds.")
4561 (defvar non-essential nil
4562 "Whether the currently executing code is performing an essential task.
4563 This variable should be non-nil only when running code which should not
4564 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4565 user for a password when we are simply scanning a set of files in the
4566 background or displaying possible completions before the user even asked
4567 for it.")
4569 (defun pop-global-mark ()
4570 "Pop off global mark ring and jump to the top location."
4571 (interactive)
4572 ;; Pop entries which refer to non-existent buffers.
4573 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4574 (setq global-mark-ring (cdr global-mark-ring)))
4575 (or global-mark-ring
4576 (error "No global mark set"))
4577 (let* ((marker (car global-mark-ring))
4578 (buffer (marker-buffer marker))
4579 (position (marker-position marker)))
4580 (setq global-mark-ring (nconc (cdr global-mark-ring)
4581 (list (car global-mark-ring))))
4582 (set-buffer buffer)
4583 (or (and (>= position (point-min))
4584 (<= position (point-max)))
4585 (if widen-automatically
4586 (widen)
4587 (error "Global mark position is outside accessible part of buffer")))
4588 (goto-char position)
4589 (switch-to-buffer buffer)))
4590 \f
4591 (defcustom next-line-add-newlines nil
4592 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4593 :type 'boolean
4594 :version "21.1"
4595 :group 'editing-basics)
4597 (defun next-line (&optional arg try-vscroll)
4598 "Move cursor vertically down ARG lines.
4599 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4600 If there is no character in the target line exactly under the current column,
4601 the cursor is positioned after the character in that line which spans this
4602 column, or at the end of the line if it is not long enough.
4603 If there is no line in the buffer after this one, behavior depends on the
4604 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4605 to create a line, and moves the cursor to that line. Otherwise it moves the
4606 cursor to the end of the buffer.
4608 If the variable `line-move-visual' is non-nil, this command moves
4609 by display lines. Otherwise, it moves by buffer lines, without
4610 taking variable-width characters or continued lines into account.
4613 a semipermanent goal column for this command.
4614 Then instead of trying to move exactly vertically (or as close as possible),
4615 this command moves to the specified goal column (or as close as possible).
4616 The goal column is stored in the variable `goal-column', which is nil
4617 when there is no goal column. Note that setting `goal-column'
4618 overrides `line-move-visual' and causes this command to move by buffer
4619 lines rather than by display lines.
4621 If you are thinking of using this in a Lisp program, consider
4622 using `forward-line' instead. It is usually easier to use
4623 and more reliable (no dependence on goal column, etc.)."
4625 (or arg (setq arg 1))
4626 (if (and next-line-add-newlines (= arg 1))
4627 (if (save-excursion (end-of-line) (eobp))
4628 ;; When adding a newline, don't expand an abbrev.
4629 (let ((abbrev-mode nil))
4630 (end-of-line)
4632 (line-move arg nil nil try-vscroll))
4633 (if (called-interactively-p 'interactive)
4634 (condition-case err
4635 (line-move arg nil nil try-vscroll)
4636 ((beginning-of-buffer end-of-buffer)
4637 (signal (car err) (cdr err))))
4638 (line-move arg nil nil try-vscroll)))
4639 nil)
4641 (defun previous-line (&optional arg try-vscroll)
4642 "Move cursor vertically up ARG lines.
4643 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4644 If there is no character in the target line exactly over the current column,
4645 the cursor is positioned after the character in that line which spans this
4646 column, or at the end of the line if it is not long enough.
4648 If the variable `line-move-visual' is non-nil, this command moves
4649 by display lines. Otherwise, it moves by buffer lines, without
4650 taking variable-width characters or continued lines into account.
4653 a semipermanent goal column for this command.
4654 Then instead of trying to move exactly vertically (or as close as possible),
4655 this command moves to the specified goal column (or as close as possible).
4656 The goal column is stored in the variable `goal-column', which is nil
4657 when there is no goal column. Note that setting `goal-column'
4658 overrides `line-move-visual' and causes this command to move by buffer
4659 lines rather than by display lines.
4661 If you are thinking of using this in a Lisp program, consider using
4662 `forward-line' with a negative argument instead. It is usually easier
4663 to use and more reliable (no dependence on goal column, etc.)."
4665 (or arg (setq arg 1))
4666 (if (called-interactively-p 'interactive)
4667 (condition-case err
4668 (line-move (- arg) nil nil try-vscroll)
4669 ((beginning-of-buffer end-of-buffer)
4670 (signal (car err) (cdr err))))
4671 (line-move (- arg) nil nil try-vscroll))
4672 nil)
4674 (defcustom track-eol nil
4675 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4676 This means moving to the end of each line moved onto.
4677 The beginning of a blank line does not count as the end of a line.
4678 This has no effect when the variable `line-move-visual' is non-nil."
4679 :type 'boolean
4680 :group 'editing-basics)
4682 (defcustom goal-column nil
4684 A non-nil setting overrides the variable `line-move-visual', which see."
4685 :type '(choice integer
4686 (const :tag "None" nil))
4687 :group 'editing-basics)
4688 (make-variable-buffer-local 'goal-column)
4690 (defvar temporary-goal-column 0
4691 "Current goal column for vertical motion.
4692 It is the column where point was at the start of the current run
4693 of vertical motion commands.
4695 When moving by visual lines via the function `line-move-visual', it is a cons
4696 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4697 divided by the default column width, and HSCROLL is the number of
4698 columns by which window is scrolled from left margin.
4700 When the `track-eol' feature is doing its job, the value is
4701 `most-positive-fixnum'.")
4703 (defcustom line-move-ignore-invisible t
4705 Outline mode sets this."
4706 :type 'boolean
4707 :group 'editing-basics)
4709 (defcustom line-move-visual t
4710 "When non-nil, `line-move' moves point by visual lines.
4711 This movement is based on where the cursor is displayed on the
4712 screen, instead of relying on buffer contents alone. It takes
4713 into account variable-width characters and line continuation.
4714 If nil, `line-move' moves point by logical lines.
4715 A non-nil setting of `goal-column' overrides the value of this variable
4716 and forces movement by logical lines.
4717 A window that is horizontally scrolled also forces movement by logical
4718 lines."
4719 :type 'boolean
4720 :group 'editing-basics
4721 :version "23.1")
4723 ;; Returns non-nil if partial move was done.
4724 (defun line-move-partial (arg noerror to-end)
4725 (if (< arg 0)
4726 ;; Move backward (up).
4727 ;; If already vscrolled, reduce vscroll
4728 (let ((vs (window-vscroll nil t)))
4729 (when (> vs (frame-char-height))
4730 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4732 ;; Move forward (down).
4733 (let* ((lh (window-line-height -1))
4734 (vpos (nth 1 lh))
4735 (ypos (nth 2 lh))
4736 (rbot (nth 3 lh))
4737 py vs)
4738 (when (or (null lh)
4739 (>= rbot (frame-char-height))
4740 (<= ypos (- (frame-char-height))))
4741 (unless lh
4742 (let ((wend (pos-visible-in-window-p t nil t)))
4743 (setq rbot (nth 3 wend)
4744 vpos (nth 5 wend))))
4745 (cond
4746 ;; If last line of window is fully visible, move forward.
4747 ((or (null rbot) (= rbot 0))
4748 nil)
4749 ;; If cursor is not in the bottom scroll margin, move forward.
4750 ((and (> vpos 0)
4751 (< (setq py
4752 (or (nth 1 (window-line-height))
4753 (let ((ppos (posn-at-point)))
4754 (cdr (or (posn-actual-col-row ppos)
4755 (posn-col-row ppos))))))
4756 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4757 nil)
4758 ;; When already vscrolled, we vscroll some more if we can,
4759 ;; or clear vscroll and move forward at end of tall image.
4760 ((> (setq vs (window-vscroll nil t)) 0)
4761 (when (> rbot 0)
4762 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4763 ;; If cursor just entered the bottom scroll margin, move forward,
4764 ;; but also vscroll one line so redisplay won't recenter.
4765 ((and (> vpos 0)
4766 (= py (min (- (window-text-height) scroll-margin 1)
4767 (1- vpos))))
4768 (set-window-vscroll nil (frame-char-height) t)
4769 (line-move-1 arg noerror to-end)
4770 t)
4771 ;; If there are lines above the last line, scroll-up one line.
4772 ((> vpos 0)
4773 (scroll-up 1)
4774 t)
4775 ;; Finally, start vscroll.
4776 (t
4777 (set-window-vscroll nil (frame-char-height) t)))))))
4780 ;; This is like line-move-1 except that it also performs
4781 ;; vertical scrolling of tall images if appropriate.
4782 ;; That is not really a clean thing to do, since it mixes
4783 ;; scrolling with cursor motion. But so far we don't have
4784 ;; a cleaner solution to the problem of making C-n do something
4785 ;; useful given a tall image.
4786 (defun line-move (arg &optional noerror to-end try-vscroll)
4787 (if noninteractive
4788 (forward-line arg)
4789 (unless (and auto-window-vscroll try-vscroll
4790 ;; Only vscroll for single line moves
4791 (= (abs arg) 1)
4792 ;; Under scroll-conservatively, the display engine
4793 ;; does this better.
4794 (zerop scroll-conservatively)
4795 ;; But don't vscroll in a keyboard macro.
4796 (not defining-kbd-macro)
4797 (not executing-kbd-macro)
4798 (line-move-partial arg noerror to-end))
4799 (set-window-vscroll nil 0 t)
4800 (if (and line-move-visual
4801 ;; Display-based column are incompatible with goal-column.
4802 (not goal-column)
4803 ;; When the text in the window is scrolled to the left,
4804 ;; display-based motion doesn't make sense (because each
4805 ;; logical line occupies exactly one screen line).
4806 (not (> (window-hscroll) 0)))
4807 (line-move-visual arg noerror)
4808 (line-move-1 arg noerror to-end)))))
4810 ;; Display-based alternative to line-move-1.
4811 ;; Arg says how many lines to move. The value is t if we can move the
4812 ;; specified number of lines.
4813 (defun line-move-visual (arg &optional noerror)
4814 (let ((opoint (point))
4815 (hscroll (window-hscroll))
4816 target-hscroll)
4817 ;; Check if the previous command was a line-motion command, or if
4818 ;; we were called from some other command.
4819 (if (and (consp temporary-goal-column)
4820 (memq last-command `(next-line previous-line ,this-command)))
4821 ;; If so, there's no need to reset `temporary-goal-column',
4822 ;; but we may need to hscroll.
4823 (if (or (/= (cdr temporary-goal-column) hscroll)
4824 (> (cdr temporary-goal-column) 0))
4825 (setq target-hscroll (cdr temporary-goal-column)))
4826 ;; Otherwise, we should reset `temporary-goal-column'.
4827 (let ((posn (posn-at-point)))
4828 (cond
4829 ;; Handle the `overflow-newline-into-fringe' case:
4830 ((eq (nth 1 posn) 'right-fringe)
4831 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4832 ((car (posn-x-y posn))
4833 (setq temporary-goal-column
4834 (cons (/ (float (car (posn-x-y posn)))
4835 (frame-char-width)) hscroll))))))
4836 (if target-hscroll
4837 (set-window-hscroll (selected-window) target-hscroll))
4838 (or (and (= (vertical-motion
4839 (cons (or goal-column
4840 (if (consp temporary-goal-column)
4841 (car temporary-goal-column)
4842 temporary-goal-column))
4843 arg))
4844 arg)
4845 (or (>= arg 0)
4846 (/= (point) opoint)
4847 ;; If the goal column lies on a display string,
4848 ;; `vertical-motion' advances the cursor to the end
4849 ;; of the string. For arg < 0, this can cause the
4850 ;; cursor to get stuck. (Bug#3020).
4851 (= (vertical-motion arg) arg)))
4852 (unless noerror
4853 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4854 nil)))))
4856 ;; This is the guts of next-line and previous-line.
4857 ;; Arg says how many lines to move.
4858 ;; The value is t if we can move the specified number of lines.
4859 (defun line-move-1 (arg &optional noerror _to-end)
4860 ;; Don't run any point-motion hooks, and disregard intangibility,
4861 ;; for intermediate positions.
4862 (let ((inhibit-point-motion-hooks t)
4863 (opoint (point))
4864 (orig-arg arg))
4865 (if (consp temporary-goal-column)
4866 (setq temporary-goal-column (+ (car temporary-goal-column)
4867 (cdr temporary-goal-column))))
4868 (unwind-protect
4869 (progn
4870 (if (not (memq last-command '(next-line previous-line)))
4871 (setq temporary-goal-column
4872 (if (and track-eol (eolp)
4873 ;; Don't count beg of empty line as end of line
4874 ;; unless we just did explicit end-of-line.
4875 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4876 most-positive-fixnum
4877 (current-column))))
4879 (if (not (or (integerp selective-display)
4880 line-move-ignore-invisible))
4881 ;; Use just newline characters.
4882 ;; Set ARG to 0 if we move as many lines as requested.
4883 (or (if (> arg 0)
4884 (progn (if (> arg 1) (forward-line (1- arg)))
4885 ;; This way of moving forward ARG lines
4886 ;; verifies that we have a newline after the last one.
4887 ;; It doesn't get confused by intangible text.
4888 (end-of-line)
4889 (if (zerop (forward-line 1))
4890 (setq arg 0)))
4891 (and (zerop (forward-line arg))
4892 (bolp)
4893 (setq arg 0)))
4894 (unless noerror
4895 (signal (if (< arg 0)
4896 'beginning-of-buffer
4897 'end-of-buffer)
4898 nil)))
4899 ;; Move by arg lines, but ignore invisible ones.
4900 (let (done)
4901 (while (and (> arg 0) (not done))
4902 ;; If the following character is currently invisible,
4903 ;; skip all characters with that same `invisible' property value.
4904 (while (and (not (eobp)) (invisible-p (point)))
4905 (goto-char (next-char-property-change (point))))
4906 ;; Move a line.
4907 ;; We don't use `end-of-line', since we want to escape
4908 ;; from field boundaries occurring exactly at point.
4909 (goto-char (constrain-to-field
4910 (let ((inhibit-field-text-motion t))
4911 (line-end-position))
4912 (point) t t
4913 'inhibit-line-move-field-capture))
4914 ;; If there's no invisibility here, move over the newline.
4915 (cond
4916 ((eobp)
4917 (if (not noerror)
4918 (signal 'end-of-buffer nil)
4919 (setq done t)))
4920 ((and (> arg 1) ;; Use vertical-motion for last move
4921 (not (integerp selective-display))
4922 (not (invisible-p (point))))
4923 ;; We avoid vertical-motion when possible
4924 ;; because that has to fontify.
4925 (forward-line 1))
4926 ;; Otherwise move a more sophisticated way.
4927 ((zerop (vertical-motion 1))
4928 (if (not noerror)
4929 (signal 'end-of-buffer nil)
4930 (setq done t))))
4931 (unless done
4932 (setq arg (1- arg))))
4933 ;; The logic of this is the same as the loop above,
4934 ;; it just goes in the other direction.
4935 (while (and (< arg 0) (not done))
4936 ;; For completely consistency with the forward-motion
4937 ;; case, we should call beginning-of-line here.
4938 ;; However, if point is inside a field and on a
4939 ;; continued line, the call to (vertical-motion -1)
4940 ;; below won't move us back far enough; then we return
4941 ;; to the same column in line-move-finish, and point
4942 ;; gets stuck -- cyd
4943 (forward-line 0)
4944 (cond
4945 ((bobp)
4946 (if (not noerror)
4947 (signal 'beginning-of-buffer nil)
4948 (setq done t)))
4949 ((and (< arg -1) ;; Use vertical-motion for last move
4950 (not (integerp selective-display))
4951 (not (invisible-p (1- (point)))))
4952 (forward-line -1))
4953 ((zerop (vertical-motion -1))
4954 (if (not noerror)
4955 (signal 'beginning-of-buffer nil)
4956 (setq done t))))
4957 (unless done
4958 (setq arg (1+ arg))
4959 (while (and ;; Don't move over previous invis lines
4960 ;; if our target is the middle of this line.
4961 (or (zerop (or goal-column temporary-goal-column))
4962 (< arg 0))
4963 (not (bobp)) (invisible-p (1- (point))))
4964 (goto-char (previous-char-property-change (point))))))))
4965 ;; This is the value the function returns.
4966 (= arg 0))
4968 (cond ((> arg 0)
4969 ;; If we did not move down as far as desired, at least go
4970 ;; to end of line. Be sure to call point-entered and
4971 ;; point-left-hooks.
4972 (let* ((npoint (prog1 (line-end-position)
4973 (goto-char opoint)))
4974 (inhibit-point-motion-hooks nil))
4975 (goto-char npoint)))
4976 ((< arg 0)
4977 ;; If we did not move up as far as desired,
4978 ;; at least go to beginning of line.
4979 (let* ((npoint (prog1 (line-beginning-position)
4980 (goto-char opoint)))
4981 (inhibit-point-motion-hooks nil))
4982 (goto-char npoint)))
4983 (t
4984 (line-move-finish (or goal-column temporary-goal-column)
4985 opoint (> orig-arg 0)))))))
4987 (defun line-move-finish (column opoint forward)
4988 (let ((repeat t))
4989 (while repeat
4990 ;; Set REPEAT to t to repeat the whole thing.
4991 (setq repeat nil)
4993 (let (new
4994 (old (point))
4995 (line-beg (line-beginning-position))
4996 (line-end
4997 ;; Compute the end of the line
4998 ;; ignoring effectively invisible newlines.
4999 (save-excursion
5000 ;; Like end-of-line but ignores fields.
5002 (while (and (not (eobp)) (invisible-p (point)))
5003 (goto-char (next-char-property-change (point)))
5005 (point))))
5007 ;; Move to the desired column.
5008 (line-move-to-column (truncate column))
5010 ;; Corner case: suppose we start out in a field boundary in
5011 ;; the middle of a continued line. When we get to
5012 ;; line-move-finish, point is at the start of a new *screen*
5013 ;; line but the same text line; then line-move-to-column would
5014 ;; move us backwards. Test using C-n with point on the "x" in
5015 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
5016 (and forward
5017 (< (point) old)
5018 (goto-char old))
5020 (setq new (point))
5022 ;; Process intangibility within a line.
5023 ;; With inhibit-point-motion-hooks bound to nil, a call to
5024 ;; goto-char moves point past intangible text.
5026 ;; However, inhibit-point-motion-hooks controls both the
5027 ;; intangibility and the point-entered/point-left hooks. The
5028 ;; following hack avoids calling the point-* hooks
5029 ;; unnecessarily. Note that we move *forward* past intangible
5030 ;; text when the initial and final points are the same.
5031 (goto-char new)
5032 (let ((inhibit-point-motion-hooks nil))
5033 (goto-char new)
5035 ;; If intangibility moves us to a different (later) place
5036 ;; in the same line, use that as the destination.
5037 (if (<= (point) line-end)
5038 (setq new (point))
5039 ;; If that position is "too late",
5040 ;; try the previous allowable position.
5041 ;; See if it is ok.
5042 (backward-char)
5043 (if (if forward
5044 ;; If going forward, don't accept the previous
5045 ;; allowable position if it is before the target line.
5046 (< line-beg (point))
5047 ;; If going backward, don't accept the previous
5048 ;; allowable position if it is still after the target line.
5049 (<= (point) line-end))
5050 (setq new (point))
5051 ;; As a last resort, use the end of the line.
5052 (setq new line-end))))
5054 ;; Now move to the updated destination, processing fields
5055 ;; as well as intangibility.
5056 (goto-char opoint)
5057 (let ((inhibit-point-motion-hooks nil))
5058 (goto-char
5059 ;; Ignore field boundaries if the initial and final
5060 ;; positions have the same `field' property, even if the
5061 ;; fields are non-contiguous. This seems to be "nicer"
5062 ;; behavior in many situations.
5063 (if (eq (get-char-property new 'field)
5064 (get-char-property opoint 'field))
5065 new
5066 (constrain-to-field new opoint t t
5067 'inhibit-line-move-field-capture))))
5069 ;; If all this moved us to a different line,
5070 ;; retry everything within that new line.
5071 (when (or (< (point) line-beg) (> (point) line-end))
5072 ;; Repeat the intangibility and field processing.
5073 (setq repeat t))))))
5075 (defun line-move-to-column (col)
5076 "Try to find column COL, considering invisibility.
5077 This function works only in certain cases,
5078 because what we really need is for `move-to-column'
5079 and `current-column' to be able to ignore invisible text."
5080 (if (zerop col)
5081 (beginning-of-line)
5082 (move-to-column col))
5084 (when (and line-move-ignore-invisible
5085 (not (bolp)) (invisible-p (1- (point))))
5086 (let ((normal-location (point))
5087 (normal-column (current-column)))
5088 ;; If the following character is currently invisible,
5089 ;; skip all characters with that same `invisible' property value.
5090 (while (and (not (eobp))
5091 (invisible-p (point)))
5092 (goto-char (next-char-property-change (point))))
5093 ;; Have we advanced to a larger column position?
5094 (if (> (current-column) normal-column)
5095 ;; We have made some progress towards the desired column.
5096 ;; See if we can make any further progress.
5097 (line-move-to-column (+ (current-column) (- col normal-column)))
5098 ;; Otherwise, go to the place we originally found
5099 ;; and move back over invisible text.
5100 ;; that will get us to the same place on the screen
5101 ;; but with a more reasonable buffer position.
5102 (goto-char normal-location)
5103 (let ((line-beg (line-beginning-position)))
5104 (while (and (not (bolp)) (invisible-p (1- (point))))
5105 (goto-char (previous-char-property-change (point) line-beg))))))))
5107 (defun move-end-of-line (arg)
5108 "Move point to end of current line as displayed.
5109 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5110 If point reaches the beginning or end of buffer, it stops there.
5112 To ignore the effects of the `intangible' text or overlay
5113 property, bind `inhibit-point-motion-hooks' to t.
5114 If there is an image in the current line, this function
5115 disregards newlines that are part of the text on which the image
5116 rests."
5117 (interactive "^p")
5118 (or arg (setq arg 1))
5119 (let (done)
5120 (while (not done)
5121 (let ((newpos
5122 (save-excursion
5123 (let ((goal-column 0)
5124 (line-move-visual nil))
5125 (and (line-move arg t)
5126 ;; With bidi reordering, we may not be at bol,
5127 ;; so make sure we are.
5129 (not (bobp))
5130 (progn
5131 (while (and (not (bobp)) (invisible-p (1- (point))))
5132 (goto-char (previous-single-char-property-change
5133 (point) 'invisible)))
5134 (backward-char 1)))
5135 (point)))))
5136 (goto-char newpos)
5137 (if (and (> (point) newpos)
5139 (backward-char 1)
5140 (if (and (> (point) newpos) (not (eobp))
5142 ;; If we skipped something intangible and now we're not
5143 ;; really at eol, keep going.
5144 (setq arg 1)
5145 (setq done t)))))))
5147 (defun move-beginning-of-line (arg)
5148 "Move point to beginning of current line as displayed.
5149 \(If there's an image in the line, this disregards newlines
5150 which are part of the text that the image rests on.)
5152 With argument ARG not nil or 1, move forward ARG - 1 lines first.
5153 If point reaches the beginning or end of buffer, it stops there.
5154 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5155 (interactive "^p")
5156 (or arg (setq arg 1))
5158 (let ((orig (point))
5159 first-vis first-vis-field-value)
5161 ;; Move by lines, if ARG is not 1 (the default).
5162 (if (/= arg 1)
5163 (let ((line-move-visual nil))
5164 (line-move (1- arg) t)))
5166 ;; Move to beginning-of-line, ignoring fields and invisible text.
5168 (while (and (not (bobp)) (invisible-p (1- (point))))
5169 (goto-char (previous-char-property-change (point)))
5172 ;; Now find first visible char in the line
5173 (while (and (not (eobp)) (invisible-p (point)))
5174 (goto-char (next-char-property-change (point))))
5175 (setq first-vis (point))
5177 ;; See if fields would stop us from reaching FIRST-VIS.
5178 (setq first-vis-field-value
5179 (constrain-to-field first-vis orig (/= arg 1) t nil))
5181 (goto-char (if (/= first-vis-field-value first-vis)
5182 ;; If yes, obey them.
5183 first-vis-field-value
5184 ;; Otherwise, move to START with attention to fields.
5185 ;; (It is possible that fields never matter in this case.)
5186 (constrain-to-field (point) orig
5187 (/= arg 1) t nil)))))
5190 ;; Many people have said they rarely use this feature, and often type
5191 ;; it by accident. Maybe it shouldn't even be on a key.
5192 (put 'set-goal-column 'disabled t)
5194 (defun set-goal-column (arg)
5196 Those commands will move to this position in the line moved to
5197 rather than trying to keep the same horizontal position.
5198 With a non-nil argument ARG, clears out the goal column
5200 The goal column is stored in the variable `goal-column'."
5201 (interactive "P")
5202 (if arg
5203 (progn
5204 (setq goal-column nil)
5205 (message "No goal column"))
5206 (setq goal-column (current-column))
5207 ;; The older method below can be erroneous if `set-goal-column' is bound
5208 ;; to a sequence containing %
5209 ;;(message (substitute-command-keys
5211 ;;goal-column)
5212 (message "%s"
5213 (concat
5214 (format "Goal column %d " goal-column)
5215 (substitute-command-keys
5218 )
5219 nil)
5220 \f
5221 ;;; Editing based on visual lines, as opposed to logical lines.
5223 (defun end-of-visual-line (&optional n)
5224 "Move point to end of current visual line.
5225 With argument N not nil or 1, move forward N - 1 visual lines first.
5226 If point reaches the beginning or end of buffer, it stops there.
5227 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5228 (interactive "^p")
5229 (or n (setq n 1))
5230 (if (/= n 1)
5231 (let ((line-move-visual t))
5232 (line-move (1- n) t)))
5233 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
5234 ;; constrain to field boundaries, so we don't either.
5235 (vertical-motion (cons (window-width) 0)))
5237 (defun beginning-of-visual-line (&optional n)
5238 "Move point to beginning of current visual line.
5239 With argument N not nil or 1, move forward N - 1 visual lines first.
5240 If point reaches the beginning or end of buffer, it stops there.
5241 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
5242 (interactive "^p")
5243 (or n (setq n 1))
5244 (let ((opoint (point)))
5245 (if (/= n 1)
5246 (let ((line-move-visual t))
5247 (line-move (1- n) t)))
5248 (vertical-motion 0)
5249 ;; Constrain to field boundaries, like `move-beginning-of-line'.
5250 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
5252 (defun kill-visual-line (&optional arg)
5253 "Kill the rest of the visual line.
5254 With prefix argument ARG, kill that many visual lines from point.
5255 If ARG is negative, kill visual lines backward.
5256 If ARG is zero, kill the text before point on the current visual
5257 line.
5259 If you want to append the killed line to the last killed text,
5262 If the buffer is read-only, Emacs will beep and refrain from deleting
5263 the line, but put the line in the kill ring anyway. This means that
5264 you can use this command to copy text from a read-only buffer.
5265 \(If the variable `kill-read-only-ok' is non-nil, then this won't
5266 even beep.)"
5267 (interactive "P")
5268 ;; Like in `kill-line', it's better to move point to the other end
5269 ;; of the kill before killing.
5270 (let ((opoint (point))
5271 (kill-whole-line (and kill-whole-line (bolp))))
5272 (if arg
5273 (vertical-motion (prefix-numeric-value arg))
5274 (end-of-visual-line 1)
5275 (if (= (point) opoint)
5276 (vertical-motion 1)
5277 ;; Skip any trailing whitespace at the end of the visual line.
5278 ;; We used to do this only if `show-trailing-whitespace' is
5279 ;; nil, but that's wrong; the correct thing would be to check
5280 ;; whether the trailing whitespace is highlighted. But, it's
5281 ;; OK to just do this unconditionally.
5284 (1+ (point))
5285 (point)))))
5287 (defun next-logical-line (&optional arg try-vscroll)
5288 "Move cursor vertically down ARG lines.
5289 This is identical to `next-line', except that it always moves
5290 by logical lines instead of visual lines, ignoring the value of
5291 the variable `line-move-visual'."
5293 (let ((line-move-visual nil))
5294 (with-no-warnings
5295 (next-line arg try-vscroll))))
5297 (defun previous-logical-line (&optional arg try-vscroll)
5298 "Move cursor vertically up ARG lines.
5299 This is identical to `previous-line', except that it always moves
5300 by logical lines instead of visual lines, ignoring the value of
5301 the variable `line-move-visual'."
5303 (let ((line-move-visual nil))
5304 (with-no-warnings
5305 (previous-line arg try-vscroll))))
5307 (defgroup visual-line nil
5308 "Editing based on visual lines."
5309 :group 'convenience
5310 :version "23.1")
5312 (defvar visual-line-mode-map
5313 (let ((map (make-sparse-keymap)))
5314 (define-key map [remap kill-line] 'kill-visual-line)
5315 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
5316 (define-key map [remap move-end-of-line] 'end-of-visual-line)
5317 ;; These keybindings interfere with xterm function keys. Are
5318 ;; there any other suitable bindings?
5319 ;; (define-key map "\M-[" 'previous-logical-line)
5320 ;; (define-key map "\M-]" 'next-logical-line)
5321 map))
5323 (defcustom visual-line-fringe-indicators '(nil nil)
5324 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
5325 The value should be a list of the form (LEFT RIGHT), where LEFT
5326 and RIGHT are symbols representing the bitmaps to display, to
5327 indicate wrapped lines, in the left and right fringes respectively.
5328 See also `fringe-indicator-alist'.
5329 The default is not to display fringe indicators for wrapped lines.
5330 This variable does not affect fringe indicators displayed for
5331 other purposes."
5332 :type '(list (choice (const :tag "Hide left indicator" nil)
5333 (const :tag "Left curly arrow" left-curly-arrow)
5334 (symbol :tag "Other bitmap"))
5335 (choice (const :tag "Hide right indicator" nil)
5336 (const :tag "Right curly arrow" right-curly-arrow)
5337 (symbol :tag "Other bitmap")))
5338 :set (lambda (symbol value)
5339 (dolist (buf (buffer-list))
5340 (with-current-buffer buf
5341 (when (and (boundp 'visual-line-mode)
5342 (symbol-value 'visual-line-mode))
5343 (setq fringe-indicator-alist
5344 (cons (cons 'continuation value)
5345 (assq-delete-all
5346 'continuation
5347 (copy-tree fringe-indicator-alist)))))))
5348 (set-default symbol value)))
5350 (defvar visual-line--saved-state nil)
5352 (define-minor-mode visual-line-mode
5353 "Toggle visual line based editing (Visual Line mode).
5354 With a prefix argument ARG, enable Visual Line mode if ARG is
5355 positive, and disable it otherwise. If called from Lisp, enable
5356 the mode if ARG is omitted or nil.
5358 When Visual Line mode is enabled, `word-wrap' is turned on in
5359 this buffer, and simple editing commands are redefined to act on
5360 visual lines, not logical lines. See Info node `Visual Line
5361 Mode' for details."
5362 :keymap visual-line-mode-map
5363 :group 'visual-line
5364 :lighter " Wrap"
5365 (if visual-line-mode
5366 (progn
5367 (set (make-local-variable 'visual-line--saved-state) nil)
5368 ;; Save the local values of some variables, to be restored if
5369 ;; visual-line-mode is turned off.
5370 (dolist (var '(line-move-visual truncate-lines
5371 truncate-partial-width-windows
5372 word-wrap fringe-indicator-alist))
5373 (if (local-variable-p var)
5374 (push (cons var (symbol-value var))
5375 visual-line--saved-state)))
5376 (set (make-local-variable 'line-move-visual) t)
5377 (set (make-local-variable 'truncate-partial-width-windows) nil)
5378 (setq truncate-lines nil
5379 word-wrap t
5380 fringe-indicator-alist
5381 (cons (cons 'continuation visual-line-fringe-indicators)
5382 fringe-indicator-alist)))
5383 (kill-local-variable 'line-move-visual)
5384 (kill-local-variable 'word-wrap)
5385 (kill-local-variable 'truncate-lines)
5386 (kill-local-variable 'truncate-partial-width-windows)
5387 (kill-local-variable 'fringe-indicator-alist)
5388 (dolist (saved visual-line--saved-state)
5389 (set (make-local-variable (car saved)) (cdr saved)))
5390 (kill-local-variable 'visual-line--saved-state)))
5392 (defun turn-on-visual-line-mode ()
5393 (visual-line-mode 1))
5395 (define-globalized-minor-mode global-visual-line-mode
5396 visual-line-mode turn-on-visual-line-mode
5397 :lighter " vl")
5399 \f
5400 (defun transpose-chars (arg)
5401 "Interchange characters around point, moving forward one character.
5402 With prefix arg ARG, effect is to take character before point
5403 and drag it forward past ARG other characters (backward if ARG negative).
5404 If no argument and at end of line, the previous two chars are exchanged."
5405 (interactive "*P")
5406 (and (null arg) (eolp) (forward-char -1))
5407 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5409 (defun transpose-words (arg)
5410 "Interchange words around point, leaving point at end of them.
5411 With prefix arg ARG, effect is to take word before or around point
5412 and drag it forward past ARG other words (backward if ARG negative).
5413 If ARG is zero, the words around or after point and around or after mark
5414 are interchanged."
5415 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5416 (interactive "*p")
5417 (transpose-subr 'forward-word arg))
5419 (defun transpose-sexps (arg)
5421 Does not work on a sexp that point is in the middle of
5422 if it is a list or string."
5423 (interactive "*p")
5424 (transpose-subr
5425 (lambda (arg)
5426 ;; Here we should try to simulate the behavior of
5427 ;; (cons (progn (forward-sexp x) (point))
5428 ;; (progn (forward-sexp (- x)) (point)))
5429 ;; Except that we don't want to rely on the second forward-sexp
5430 ;; putting us back to where we want to be, since forward-sexp-function
5431 ;; might do funny things like infix-precedence.
5432 (if (if (> arg 0)
5434 (and (not (bobp))
5436 ;; Jumping over a symbol. We might be inside it, mind you.
5437 (progn (funcall (if (> arg 0)
5438 'skip-syntax-backward 'skip-syntax-forward)
5439 "w_")
5440 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5441 ;; Otherwise, we're between sexps. Take a step back before jumping
5442 ;; to make sure we'll obey the same precedence no matter which direction
5443 ;; we're going.
5444 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5445 (cons (save-excursion (forward-sexp arg) (point))
5446 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5447 (not (zerop (funcall (if (> arg 0)
5448 'skip-syntax-forward
5449 'skip-syntax-backward)
5450 ".")))))
5451 (point)))))
5452 arg 'special))
5454 (defun transpose-lines (arg)
5455 "Exchange current line and previous line, leaving point after both.
5456 With argument ARG, takes previous line and moves it past ARG lines.
5457 With argument 0, interchanges line point is in with line mark is in."
5458 (interactive "*p")
5459 (transpose-subr (function
5460 (lambda (arg)
5461 (if (> arg 0)
5462 (progn
5463 ;; Move forward over ARG lines,
5464 ;; but create newlines if necessary.
5465 (setq arg (forward-line arg))
5467 (setq arg (1+ arg)))
5468 (if (> arg 0)
5469 (newline arg)))
5470 (forward-line arg))))
5471 arg))
5473 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5474 ;; which seems inconsistent with the ARG /= 0 case.
5475 ;; FIXME document SPECIAL.
5476 (defun transpose-subr (mover arg &optional special)
5477 "Subroutine to do the work of transposing objects.
5478 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5479 moves forward by units of the given object (e.g. forward-sentence,
5480 forward-paragraph). If ARG is zero, exchanges the current object
5481 with the one containing mark. If ARG is an integer, moves the
5482 current object past ARG following (if ARG is positive) or
5483 preceding (if ARG is negative) objects, leaving point after the
5484 current object."
5485 (let ((aux (if special mover
5486 (lambda (x)
5487 (cons (progn (funcall mover x) (point))
5488 (progn (funcall mover (- x)) (point))))))
5489 pos1 pos2)
5490 (cond
5491 ((= arg 0)
5492 (save-excursion
5493 (setq pos1 (funcall aux 1))
5494 (goto-char (or (mark) (error "No mark set in this buffer")))
5495 (setq pos2 (funcall aux 1))
5496 (transpose-subr-1 pos1 pos2))
5497 (exchange-point-and-mark))
5498 ((> arg 0)
5499 (setq pos1 (funcall aux -1))
5500 (setq pos2 (funcall aux arg))
5501 (transpose-subr-1 pos1 pos2)
5502 (goto-char (car pos2)))
5503 (t
5504 (setq pos1 (funcall aux -1))
5505 (goto-char (car pos1))
5506 (setq pos2 (funcall aux arg))
5507 (transpose-subr-1 pos1 pos2)))))
5509 (defun transpose-subr-1 (pos1 pos2)
5510 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5511 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5512 (when (> (car pos1) (car pos2))
5513 (let ((swap pos1))
5514 (setq pos1 pos2 pos2 swap)))
5515 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5516 (atomic-change-group
5517 ;; This sequence of insertions attempts to preserve marker
5518 ;; positions at the start and end of the transposed objects.
5519 (let* ((word (buffer-substring (car pos2) (cdr pos2)))
5520 (len1 (- (cdr pos1) (car pos1)))
5521 (len2 (length word))
5522 (boundary (make-marker)))
5523 (set-marker boundary (car pos2))
5524 (goto-char (cdr pos1))
5525 (insert-before-markers word)
5526 (setq word (delete-and-extract-region (car pos1) (+ (car pos1) len1)))
5527 (goto-char boundary)
5528 (insert word)
5529 (goto-char (+ boundary len1))
5530 (delete-region (point) (+ (point) len2))
5531 (set-marker boundary nil))))
5532 \f
5533 (defun backward-word (&optional arg)
5534 "Move backward until encountering the beginning of a word.
5535 With argument ARG, do this that many times."
5536 (interactive "^p")
5537 (forward-word (- (or arg 1))))
5539 (defun mark-word (&optional arg allow-extend)
5540 "Set mark ARG words away from point.
5542 move to with the same argument.
5543 Interactively, if this command is repeated
5544 or (in Transient Mark mode) if the mark is active,
5545 it marks the next ARG words after the ones already marked."
5547 (cond ((and allow-extend
5548 (or (and (eq last-command this-command) (mark t))
5549 (region-active-p)))
5550 (setq arg (if arg (prefix-numeric-value arg)
5551 (if (< (mark) (point)) -1 1)))
5552 (set-mark
5553 (save-excursion
5554 (goto-char (mark))
5555 (forward-word arg)
5556 (point))))
5557 (t
5558 (push-mark
5559 (save-excursion
5560 (forward-word (prefix-numeric-value arg))
5561 (point))
5562 nil t))))
5564 (defun kill-word (arg)
5565 "Kill characters forward until encountering the end of a word.
5566 With argument ARG, do this that many times."
5567 (interactive "p")
5568 (kill-region (point) (progn (forward-word arg) (point))))
5570 (defun backward-kill-word (arg)
5571 "Kill characters backward until encountering the beginning of a word.
5572 With argument ARG, do this that many times."
5573 (interactive "p")
5574 (kill-word (- arg)))
5576 (defun current-word (&optional strict really-word)
5577 "Return the symbol or word that point is on (or a nearby one) as a string.
5578 The return value includes no text properties.
5579 If optional arg STRICT is non-nil, return nil unless point is within
5580 or adjacent to a symbol or word. In all cases the value can be nil
5581 if there is no word nearby.
5582 The function, belying its name, normally finds a symbol.
5583 If optional arg REALLY-WORD is non-nil, it finds just a word."
5584 (save-excursion
5585 (let* ((oldpoint (point)) (start (point)) (end (point))
5586 (syntaxes (if really-word "w" "w_"))
5587 (not-syntaxes (concat "^" syntaxes)))
5588 (skip-syntax-backward syntaxes) (setq start (point))
5589 (goto-char oldpoint)
5590 (skip-syntax-forward syntaxes) (setq end (point))
5591 (when (and (eq start oldpoint) (eq end oldpoint)
5592 ;; Point is neither within nor adjacent to a word.
5593 (not strict))
5594 ;; Look for preceding word in same line.
5595 (skip-syntax-backward not-syntaxes (line-beginning-position))
5596 (if (bolp)
5597 ;; No preceding word in same line.
5598 ;; Look for following word in same line.
5599 (progn
5600 (skip-syntax-forward not-syntaxes (line-end-position))
5601 (setq start (point))
5602 (skip-syntax-forward syntaxes)
5603 (setq end (point)))
5604 (setq end (point))
5605 (skip-syntax-backward syntaxes)
5606 (setq start (point))))
5607 ;; If we found something nonempty, return it as a string.
5608 (unless (= start end)
5609 (buffer-substring-no-properties start end)))))
5610 \f
5611 (defcustom fill-prefix nil
5612 "String for filling to insert at front of new line, or nil for none."
5613 :type '(choice (const :tag "None" nil)
5614 string)
5615 :group 'fill)
5616 (make-variable-buffer-local 'fill-prefix)
5617 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5619 (defcustom auto-fill-inhibit-regexp nil
5620 "Regexp to match lines which should not be auto-filled."
5621 :type '(choice (const :tag "None" nil)
5622 regexp)
5623 :group 'fill)
5625 (defun do-auto-fill ()
5626 "The default value for `normal-auto-fill-function'.
5627 This is the default auto-fill function, some major modes use a different one.
5628 Returns t if it really did any work."
5629 (let (fc justify give-up
5630 (fill-prefix fill-prefix))
5631 (if (or (not (setq justify (current-justification)))
5632 (null (setq fc (current-fill-column)))
5633 (and (eq justify 'left)
5634 (<= (current-column) fc))
5635 (and auto-fill-inhibit-regexp
5636 (save-excursion (beginning-of-line)
5637 (looking-at auto-fill-inhibit-regexp))))
5638 nil ;; Auto-filling not required
5639 (if (memq justify '(full center right))
5640 (save-excursion (unjustify-current-line)))
5642 ;; Choose a fill-prefix automatically.
5643 (when (and adaptive-fill-mode
5644 (or (null fill-prefix) (string= fill-prefix "")))
5645 (let ((prefix
5646 (fill-context-prefix
5647 (save-excursion (fill-forward-paragraph -1) (point))
5648 (save-excursion (fill-forward-paragraph 1) (point)))))
5649 (and prefix (not (equal prefix ""))
5650 ;; Use auto-indentation rather than a guessed empty prefix.
5651 (not (and fill-indent-according-to-mode
5653 (setq fill-prefix prefix))))
5655 (while (and (not give-up) (> (current-column) fc))
5656 ;; Determine where to split the line.
5657 (let* (after-prefix
5658 (fill-point
5659 (save-excursion
5660 (beginning-of-line)
5661 (setq after-prefix (point))
5662 (and fill-prefix
5663 (looking-at (regexp-quote fill-prefix))
5664 (setq after-prefix (match-end 0)))
5665 (move-to-column (1+ fc))
5666 (fill-move-to-break-point after-prefix)
5667 (point))))
5669 ;; See whether the place we found is any good.
5670 (if (save-excursion
5671 (goto-char fill-point)
5672 (or (bolp)
5673 ;; There is no use breaking at end of line.
5674 (save-excursion (skip-chars-forward " ") (eolp))
5675 ;; It is futile to split at the end of the prefix
5676 ;; since we would just insert the prefix again.
5677 (and after-prefix (<= (point) after-prefix))
5678 ;; Don't split right after a comment starter
5679 ;; since we would just make another comment starter.
5680 (and comment-start-skip
5681 (let ((limit (point)))
5682 (beginning-of-line)
5683 (and (re-search-forward comment-start-skip
5684 limit t)
5685 (eq (point) limit))))))
5686 ;; No good place to break => stop trying.
5687 (setq give-up t)
5688 ;; Ok, we have a useful place to break the line. Do it.
5689 (let ((prev-column (current-column)))
5690 ;; If point is at the fill-point, do not `save-excursion'.
5691 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5692 ;; point will end up before it rather than after it.
5693 (if (save-excursion
5695 (= (point) fill-point))
5696 (default-indent-new-line t)
5697 (save-excursion
5698 (goto-char fill-point)
5699 (default-indent-new-line t)))
5700 ;; Now do justification, if required
5701 (if (not (eq justify 'left))
5702 (save-excursion
5703 (end-of-line 0)
5704 (justify-current-line justify nil t)))
5705 ;; If making the new line didn't reduce the hpos of
5706 ;; the end of the line, then give up now;
5707 ;; trying again will not help.
5708 (if (>= (current-column) prev-column)
5709 (setq give-up t))))))
5710 ;; Justify last line.
5711 (justify-current-line justify t t)
5712 t)))
5714 (defvar comment-line-break-function 'comment-indent-new-line
5715 "Mode-specific function which line breaks and continues a comment.
5716 This function is called during auto-filling when a comment syntax
5717 is defined.
5718 The function should take a single optional argument, which is a flag
5719 indicating whether it should use soft newlines.")
5721 (defun default-indent-new-line (&optional soft)
5722 "Break line at point and indent.
5723 If a comment syntax is defined, call `comment-indent-new-line'.
5725 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5726 unless optional argument SOFT is non-nil."
5727 (interactive)
5728 (if comment-start
5729 (funcall comment-line-break-function soft)
5730 ;; Insert the newline before removing empty space so that markers
5731 ;; get preserved better.
5733 (save-excursion (forward-char -1) (delete-horizontal-space))
5734 (delete-horizontal-space)
5736 (if (and fill-prefix (not adaptive-fill-mode))
5737 ;; Blindly trust a non-adaptive fill-prefix.
5738 (progn
5739 (indent-to-left-margin)
5740 (insert-before-markers-and-inherit fill-prefix))
5742 (cond
5743 ;; If there's an adaptive prefix, use it unless we're inside
5744 ;; a comment and the prefix is not a comment starter.
5745 (fill-prefix
5746 (indent-to-left-margin)
5747 (insert-and-inherit fill-prefix))
5748 ;; If we're not inside a comment, just try to indent.
5749 (t (indent-according-to-mode))))))
5751 (defvar normal-auto-fill-function 'do-auto-fill
5752 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5753 Some major modes set this.")
5755 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5756 ;; `functions' and `hooks' are usually unsafe to set, but setting
5757 ;; auto-fill-function to nil in a file-local setting is safe and
5758 ;; can be useful to prevent auto-filling.
5759 (put 'auto-fill-function 'safe-local-variable 'null)
5761 (define-minor-mode auto-fill-mode
5762 "Toggle automatic line breaking (Auto Fill mode).
5763 With a prefix argument ARG, enable Auto Fill mode if ARG is
5764 positive, and disable it otherwise. If called from Lisp, enable
5765 the mode if ARG is omitted or nil.
5767 When Auto Fill mode is enabled, inserting a space at a column
5768 beyond `current-fill-column' automatically breaks the line at a
5769 previous space.
5771 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5772 non-`nil'.
5774 The value of `normal-auto-fill-function' specifies the function to use
5775 for `auto-fill-function' when turning Auto Fill mode on."
5776 :variable (auto-fill-function
5777 . (lambda (v) (setq auto-fill-function
5778 (if v normal-auto-fill-function)))))
5780 ;; This holds a document string used to document auto-fill-mode.
5781 (defun auto-fill-function ()
5782 "Automatically break line at a previous space, in insertion of text."
5783 nil)
5785 (defun turn-on-auto-fill ()
5786 "Unconditionally turn on Auto Fill mode."
5787 (auto-fill-mode 1))
5789 (defun turn-off-auto-fill ()
5790 "Unconditionally turn off Auto Fill mode."
5791 (auto-fill-mode -1))
5793 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5795 (defun set-fill-column (arg)
5796 "Set `fill-column' to specified argument.
5799 (interactive
5800 (list (or current-prefix-arg
5801 ;; We used to use current-column silently, but C-x f is too easily
5802 ;; typed as a typo for C-x C-f, so we turned it into an error and
5803 ;; now an interactive prompt.
5804 (read-number "Set fill-column to: " (current-column)))))
5805 (if (consp arg)
5806 (setq arg (current-column)))
5807 (if (not (integerp arg))
5808 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5809 (error "set-fill-column requires an explicit argument")
5810 (message "Fill column set to %d (was %d)" arg fill-column)
5811 (setq fill-column arg)))
5812 \f
5813 (defun set-selective-display (arg)
5814 "Set `selective-display' to ARG; clear it if no arg.
5815 When the value of `selective-display' is a number > 0,
5816 lines whose indentation is >= that value are not displayed.
5817 The variable `selective-display' has a separate value for each buffer."
5818 (interactive "P")
5819 (if (eq selective-display t)
5820 (error "selective-display already in use for marked lines"))
5821 (let ((current-vpos
5822 (save-restriction
5823 (narrow-to-region (point-min) (point))
5824 (goto-char (window-start))
5825 (vertical-motion (window-height)))))
5826 (setq selective-display
5827 (and arg (prefix-numeric-value arg)))
5828 (recenter current-vpos))
5829 (set-window-start (selected-window) (window-start (selected-window)))
5830 (princ "selective-display set to " t)
5831 (prin1 selective-display t)
5832 (princ "." t))
5834 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5836 (defun toggle-truncate-lines (&optional arg)
5837 "Toggle truncating of long lines for the current buffer.
5838 When truncating is off, long lines are folded.
5839 With prefix argument ARG, truncate long lines if ARG is positive,
5840 otherwise fold them. Note that in side-by-side windows, this
5841 command has no effect if `truncate-partial-width-windows' is
5842 non-nil."
5843 (interactive "P")
5844 (setq truncate-lines
5845 (if (null arg)
5846 (not truncate-lines)
5847 (> (prefix-numeric-value arg) 0)))
5848 (force-mode-line-update)
5849 (unless truncate-lines
5850 (let ((buffer (current-buffer)))
5851 (walk-windows (lambda (window)
5852 (if (eq buffer (window-buffer window))
5853 (set-window-hscroll window 0)))
5854 nil t)))
5855 (message "Truncate long lines %s"
5856 (if truncate-lines "enabled" "disabled")))
5858 (defun toggle-word-wrap (&optional arg)
5859 "Toggle whether to use word-wrapping for continuation lines.
5860 With prefix argument ARG, wrap continuation lines at word boundaries
5861 if ARG is positive, otherwise wrap them at the right screen edge.
5862 This command toggles the value of `word-wrap'. It has no effect
5863 if long lines are truncated."
5864 (interactive "P")
5865 (setq word-wrap
5866 (if (null arg)
5867 (not word-wrap)
5868 (> (prefix-numeric-value arg) 0)))
5869 (force-mode-line-update)
5870 (message "Word wrapping %s"
5871 (if word-wrap "enabled" "disabled")))
5873 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5874 "The string displayed in the mode line when in overwrite mode.")
5875 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5876 "The string displayed in the mode line when in binary overwrite mode.")
5878 (define-minor-mode overwrite-mode
5879 "Toggle Overwrite mode.
5880 With a prefix argument ARG, enable Overwrite mode if ARG is
5881 positive, and disable it otherwise. If called from Lisp, enable
5882 the mode if ARG is omitted or nil.
5884 When Overwrite mode is enabled, printing characters typed in
5885 replace existing text on a one-for-one basis, rather than pushing
5886 it to the right. At the end of a line, such characters extend
5887 the line. Before a tab, such characters insert until the tab is
5889 overwrite mode; this is supposed to make it easier to insert
5890 characters when necessary."
5891 :variable (overwrite-mode
5892 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-textual)))))
5894 (define-minor-mode binary-overwrite-mode
5895 "Toggle Binary Overwrite mode.
5896 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5897 is positive, and disable it otherwise. If called from Lisp,
5898 enable the mode if ARG is omitted or nil.
5900 When Binary Overwrite mode is enabled, printing characters typed
5901 in replace existing text. Newlines are not treated specially, so
5902 typing at the end of a line joins the line to the next, with the
5903 typed character between them. Typing before a tab character
5904 simply replaces the tab with the character typed.
5906 ordinary typing characters do.
5908 Note that Binary Overwrite mode is not its own minor mode; it is
5909 a specialization of overwrite mode, entered by setting the
5910 `overwrite-mode' variable to `overwrite-mode-binary'."
5911 :variable (overwrite-mode
5912 . (lambda (v) (setq overwrite-mode (if v 'overwrite-mode-binary)))))
5914 (define-minor-mode line-number-mode
5915 "Toggle line number display in the mode line (Line Number mode).
5916 With a prefix argument ARG, enable Line Number mode if ARG is
5917 positive, and disable it otherwise. If called from Lisp, enable
5918 the mode if ARG is omitted or nil.
5920 Line numbers do not appear for very large buffers and buffers
5921 with very long lines; see variables `line-number-display-limit'
5922 and `line-number-display-limit-width'."
5923 :init-value t :global t :group 'mode-line)
5925 (define-minor-mode column-number-mode
5926 "Toggle column number display in the mode line (Column Number mode).
5927 With a prefix argument ARG, enable Column Number mode if ARG is
5928 positive, and disable it otherwise.
5930 If called from Lisp, enable the mode if ARG is omitted or nil."
5931 :global t :group 'mode-line)
5933 (define-minor-mode size-indication-mode
5934 "Toggle buffer size display in the mode line (Size Indication mode).
5935 With a prefix argument ARG, enable Size Indication mode if ARG is
5936 positive, and disable it otherwise.
5938 If called from Lisp, enable the mode if ARG is omitted or nil."
5939 :global t :group 'mode-line)
5941 (define-minor-mode auto-save-mode
5942 "Toggle auto-saving in the current buffer (Auto Save mode).
5943 With a prefix argument ARG, enable Auto Save mode if ARG is
5944 positive, and disable it otherwise.
5946 If called from Lisp, enable the mode if ARG is omitted or nil."
5947 :variable ((and buffer-auto-save-file-name
5948 ;; If auto-save is off because buffer has shrunk,
5949 ;; then toggling should turn it on.
5950 (>= buffer-saved-size 0))
5951 . (lambda (val)
5952 (setq buffer-auto-save-file-name
5953 (cond
5954 ((null val) nil)
5955 ((and buffer-file-name auto-save-visited-file-name
5956 (not buffer-read-only))
5957 buffer-file-name)
5958 (t (make-auto-save-file-name))))))
5959 ;; If -1 was stored here, to temporarily turn off saving,
5960 ;; turn it back on.
5961 (and (< buffer-saved-size 0)
5962 (setq buffer-saved-size 0)))
5963 \f
5964 (defgroup paren-blinking nil
5965 "Blinking matching of parens and expressions."
5966 :prefix "blink-matching-"
5967 :group 'paren-matching)
5969 (defcustom blink-matching-paren t
5970 "Non-nil means show matching open-paren when close-paren is inserted."
5971 :type 'boolean
5972 :group 'paren-blinking)
5974 (defcustom blink-matching-paren-on-screen t
5975 "Non-nil means show matching open-paren when it is on screen.
5976 If nil, don't show it (but the open-paren can still be shown
5977 when it is off screen).
5979 This variable has no effect if `blink-matching-paren' is nil.
5980 \(In that case, the open-paren is never shown.)
5981 It is also ignored if `show-paren-mode' is enabled."
5982 :type 'boolean
5983 :group 'paren-blinking)
5985 (defcustom blink-matching-paren-distance (* 100 1024)
5986 "If non-nil, maximum distance to search backwards for matching open-paren.
5987 If nil, search stops at the beginning of the accessible portion of the buffer."
5988 :version "23.2" ; 25->100k
5989 :type '(choice (const nil) integer)
5990 :group 'paren-blinking)
5992 (defcustom blink-matching-delay 1
5993 "Time in seconds to delay after showing a matching paren."
5994 :type 'number
5995 :group 'paren-blinking)
5997 (defcustom blink-matching-paren-dont-ignore-comments nil
5998 "If nil, `blink-matching-paren' ignores comments.
5999 More precisely, when looking for the matching parenthesis,
6000 it skips the contents of comments that end before point."
6001 :type 'boolean
6002 :group 'paren-blinking)
6004 (defun blink-matching-check-mismatch (start end)
6005 "Return whether or not START...END are matching parens.
6006 END is the current point and START is the blink position.
6007 START might be nil if no matching starter was found.
6008 Returns non-nil if we find there is a mismatch."
6009 (let* ((end-syntax (syntax-after (1- end)))
6010 (matching-paren (and (consp end-syntax)
6011 (eq (syntax-class end-syntax) 5)
6012 (cdr end-syntax))))
6013 ;; For self-matched chars like " and $, we can't know when they're
6014 ;; mismatched or unmatched, so we can only do it for parens.
6015 (when matching-paren
6016 (not (and start
6017 (or
6018 (eq (char-after start) matching-paren)
6019 ;; The cdr might hold a new paren-class info rather than
6020 ;; a matching-char info, in which case the two CDRs
6021 ;; should match.
6022 (eq matching-paren (cdr-safe (syntax-after start)))))))))
6024 (defvar blink-matching-check-function #'blink-matching-check-mismatch
6025 "Function to check parentheses mismatches.
6026 The function takes two arguments (START and END) where START is the
6027 position just before the opening token and END is the position right after.
6028 START can be nil, if it was not found.
6029 The function should return non-nil if the two tokens do not match.")
6031 (defun blink-matching-open ()
6032 "Move cursor momentarily to the beginning of the sexp before point."
6033 (interactive)
6034 (when (and (not (bobp))
6035 blink-matching-paren)
6036 (let* ((oldpos (point))
6037 (message-log-max nil) ; Don't log messages about paren matching.
6038 (blinkpos
6039 (save-excursion
6040 (save-restriction
6041 (if blink-matching-paren-distance
6042 (narrow-to-region
6043 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
6044 (- (point) blink-matching-paren-distance))
6045 oldpos))
6046 (let ((parse-sexp-ignore-comments
6047 (and parse-sexp-ignore-comments
6048 (not blink-matching-paren-dont-ignore-comments))))
6049 (condition-case ()
6050 (progn
6051 (forward-sexp -1)
6052 ;; backward-sexp skips backward over prefix chars,
6053 ;; so move back to the matching paren.
6054 (while (and (< (point) (1- oldpos))
6055 (let ((code (syntax-after (point))))
6056 (or (eq (syntax-class code) 6)
6057 (eq (logand 1048576 (car code))
6058 1048576))))
6059 (forward-char 1))
6060 (point))
6061 (error nil))))))
6062 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
6063 (cond
6064 (mismatch
6065 (if blinkpos
6066 (if (minibufferp)
6067 (minibuffer-message "Mismatched parentheses")
6068 (message "Mismatched parentheses"))
6069 (if (minibufferp)
6070 (minibuffer-message "No matching parenthesis found")
6071 (message "No matching parenthesis found"))))
6072 ((not blinkpos) nil)
6073 ((pos-visible-in-window-p blinkpos)
6074 ;; Matching open within window, temporarily move to blinkpos but only
6075 ;; if `blink-matching-paren-on-screen' is non-nil.
6076 (and blink-matching-paren-on-screen
6077 (not show-paren-mode)
6078 (save-excursion
6079 (goto-char blinkpos)
6080 (sit-for blink-matching-delay))))
6081 (t
6082 (save-excursion
6083 (goto-char blinkpos)
6084 (let ((open-paren-line-string
6085 ;; Show what precedes the open in its line, if anything.
6086 (cond
6088 (buffer-substring (line-beginning-position)
6089 (1+ blinkpos)))
6090 ;; Show what follows the open in its line, if anything.
6091 ((save-excursion
6092 (forward-char 1)
6094 (not (eolp)))
6095 (buffer-substring blinkpos
6096 (line-end-position)))
6097 ;; Otherwise show the previous nonblank line,
6098 ;; if there is one.
6100 (concat
6101 (buffer-substring (progn
6103 (line-beginning-position))
6104 (progn (end-of-line)
6106 (point)))
6107 ;; Replace the newline and other whitespace with `...'.
6108 "..."
6109 (buffer-substring blinkpos (1+ blinkpos))))
6110 ;; There is nothing to show except the char itself.
6111 (t (buffer-substring blinkpos (1+ blinkpos))))))
6112 (message "Matches %s"
6113 (substring-no-properties open-paren-line-string)))))))))
6115 (defvar blink-paren-function 'blink-matching-open
6116 "Function called, if non-nil, whenever a close parenthesis is inserted.
6117 More precisely, a char with closeparen syntax is self-inserted.")
6119 (defun blink-paren-post-self-insert-function ()
6120 (when (and (eq (char-before) last-command-event) ; Sanity check.
6121 (memq (char-syntax last-command-event) '(?\) ?\$))
6122 blink-paren-function
6123 (not executing-kbd-macro)
6124 (not noninteractive)
6125 ;; Verify an even number of quoting characters precede the close.
6126 (= 1 (logand 1 (- (point)
6127 (save-excursion
6128 (forward-char -1)
6130 (point))))))
6131 (funcall blink-paren-function)))
6133 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
6134 ;; Most likely, this hook is nil, so this arg doesn't matter,
6135 ;; but I use it as a reminder that this function usually
6136 ;; likes to be run after others since it does `sit-for'.
6137 'append)
6138 \f
6139 ;; This executes C-g typed while Emacs is waiting for a command.
6140 ;; Quitting out of a program does not go through here;
6141 ;; that happens in the QUIT macro at the C code level.
6142 (defun keyboard-quit ()
6143 "Signal a `quit' condition.
6144 During execution of Lisp code, this character causes a quit directly.
6145 At top-level, as an editor command, this simply beeps."
6146 (interactive)
6147 ;; Avoid adding the region to the window selection.
6148 (setq saved-region-selection nil)
6149 (let (select-active-regions)
6150 (deactivate-mark))
6151 (if (fboundp 'kmacro-keyboard-quit)
6152 (kmacro-keyboard-quit))
6153 (setq defining-kbd-macro nil)
6154 (let ((debug-on-quit nil))
6155 (signal 'quit nil)))
6157 (defvar buffer-quit-function nil
6160 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
6162 (defun keyboard-escape-quit ()
6164 This command can exit an interactive command such as `query-replace',
6165 can clear out a prefix argument or a region,
6166 can get out of the minibuffer or other recursive edit,
6167 cancel the use of the current buffer (for special-purpose buffers),
6168 or go back to just one window (by deleting all but the selected window)."
6169 (interactive)
6170 (cond ((eq last-command 'mode-exited) nil)
6171 ((region-active-p)
6172 (deactivate-mark))
6173 ((> (minibuffer-depth) 0)
6174 (abort-recursive-edit))
6175 (current-prefix-arg
6176 nil)
6177 ((> (recursion-depth) 0)
6178 (exit-recursive-edit))
6179 (buffer-quit-function
6180 (funcall buffer-quit-function))
6181 ((not (one-window-p t))
6182 (delete-other-windows))
6184 (bury-buffer))))
6186 (defun play-sound-file (file &optional volume device)
6187 "Play sound stored in FILE.
6188 VOLUME and DEVICE correspond to the keywords of the sound
6189 specification for `play-sound'."
6190 (interactive "fPlay sound file: ")
6191 (let ((sound (list :file file)))
6192 (if volume
6193 (plist-put sound :volume volume))
6194 (if device
6195 (plist-put sound :device device))
6196 (push 'sound sound)
6197 (play-sound sound)))
6199 \f
6200 (defcustom read-mail-command 'rmail
6201 "Your preference for a mail reading package.
6202 This is used by some keybindings which support reading mail.
6203 See also `mail-user-agent' concerning sending mail."
6206 (function-item :tag "Emacs interface to MH"
6208 (function :tag "Other"))
6209 :version "21.1"
6210 :group 'mail)
6212 (defcustom mail-user-agent 'message-user-agent
6213 "Your preference for a mail composition package.
6214 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
6215 outgoing email message. This variable lets you specify which
6216 mail-sending package you prefer.
6218 Valid values include:
6220 `message-user-agent' -- use the Message package.
6221 See Info node `(message)'.
6222 `sendmail-user-agent' -- use the Mail package.
6223 See Info node `(emacs)Sending Mail'.
6224 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
6225 See Info node `(mh-e)'.
6226 `gnus-user-agent' -- like `message-user-agent', but with Gnus
6227 paraphernalia if Gnus is running, particularly
6228 the Gcc: header for archiving.
6230 Additional valid symbols may be available; check with the author of
6231 your package for details. The function should return non-nil if it
6232 succeeds.
6234 See also `read-mail-command' concerning reading mail."
6235 :type '(radio (function-item :tag "Message package"
6237 message-user-agent)
6238 (function-item :tag "Mail package"
6240 sendmail-user-agent)
6241 (function-item :tag "Emacs interface to MH"
6243 mh-e-user-agent)
6244 (function-item :tag "Message with full Gnus features"
6246 gnus-user-agent)
6247 (function :tag "Other"))
6248 :version "23.2" ; sendmail->message
6249 :group 'mail)
6251 (defcustom compose-mail-user-agent-warnings t
6252 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
6253 If the value of `mail-user-agent' is the default, and the user
6254 appears to have customizations applying to the old default,
6255 `compose-mail' issues a warning."
6256 :type 'boolean
6257 :version "23.2"
6258 :group 'mail)
6260 (defun rfc822-goto-eoh ()
6261 "If the buffer starts with a mail header, move point to the header's end.
6262 Otherwise, moves to `point-min'.
6263 The end of the header is the start of the next line, if there is one,
6264 else the end of the last line. This function obeys RFC822."
6265 (goto-char (point-min))
6266 (when (re-search-forward
6268 (goto-char (match-beginning 0))))
6270 ;; Used by Rmail (e.g., rmail-forward).
6271 (defvar mail-encode-mml nil
6272 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
6273 the outgoing message before sending it.")
6275 (defun compose-mail (&optional to subject other-headers continue
6276 switch-function yank-action send-actions
6277 return-action)
6278 "Start composing a mail message to send.
6279 This uses the user's chosen mail composition package
6280 as selected with the variable `mail-user-agent'.
6281 The optional arguments TO and SUBJECT specify recipients
6282 and the initial Subject field, respectively.
6284 OTHER-HEADERS is an alist specifying additional
6285 header fields. Elements look like (HEADER . VALUE) where both
6286 HEADER and VALUE are strings.
6288 CONTINUE, if non-nil, says to continue editing a message already
6289 being composed. Interactively, CONTINUE is the prefix argument.
6291 SWITCH-FUNCTION, if non-nil, is a function to use to
6292 switch to and display the buffer used for mail composition.
6294 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
6295 to insert the raw text of the message being replied to.
6296 It has the form (FUNCTION . ARGS). The user agent will apply
6297 FUNCTION to ARGS, to insert the raw text of the original message.
6298 \(The user agent will also run `mail-citation-hook', *after* the
6299 original text has been inserted in this way.)
6301 SEND-ACTIONS is a list of actions to call when the message is sent.
6302 Each action has the form (FUNCTION . ARGS).
6304 RETURN-ACTION, if non-nil, is an action for returning to the
6305 caller. It has the form (FUNCTION . ARGS). The function is
6306 called after the mail has been sent or put aside, and the mail
6307 buffer buried."
6308 (interactive
6309 (list nil nil nil current-prefix-arg))
6311 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
6312 ;; from sendmail-user-agent to message-user-agent. Some users may
6313 ;; encounter incompatibilities. This hack tries to detect problems
6314 ;; and warn about them.
6315 (and compose-mail-user-agent-warnings
6316 (eq mail-user-agent 'message-user-agent)
6317 (let (warn-vars)
6318 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
6319 mail-yank-hooks mail-archive-file-name
6320 mail-default-reply-to mail-mailing-lists
6321 mail-self-blind))
6322 (and (boundp var)
6323 (symbol-value var)
6324 (push var warn-vars)))
6325 (when warn-vars
6326 (display-warning 'mail
6327 (format "\
6328 The default mail mode is now Message mode.
6329 You have the following Mail mode variable%s customized:
6331 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
6332 (if (> (length warn-vars) 1) "s" "")
6333 (mapconcat 'symbol-name
6334 warn-vars " "))))))
6336 (let ((function (get mail-user-agent 'composefunc)))
6337 (funcall function to subject other-headers continue switch-function
6338 yank-action send-actions return-action)))
6340 (defun compose-mail-other-window (&optional to subject other-headers continue
6341 yank-action send-actions
6342 return-action)
6344 (interactive (list nil nil nil current-prefix-arg))
6345 (compose-mail to subject other-headers continue
6346 'switch-to-buffer-other-window yank-action send-actions
6347 return-action))
6349 (defun compose-mail-other-frame (&optional to subject other-headers continue
6350 yank-action send-actions
6351 return-action)
6353 (interactive (list nil nil nil current-prefix-arg))
6354 (compose-mail to subject other-headers continue
6355 'switch-to-buffer-other-frame yank-action send-actions
6356 return-action))
6358 \f
6359 (defvar set-variable-value-history nil
6360 "History of values entered with `set-variable'.
6362 Maximum length of the history list is determined by the value
6363 of `history-length', which see.")
6365 (defun set-variable (variable value &optional make-local)
6366 "Set VARIABLE to VALUE. VALUE is a Lisp object.
6367 VARIABLE should be a user option variable name, a Lisp variable
6368 meant to be customized by users. You should enter VALUE in Lisp syntax,
6369 so if you want VALUE to be a string, you must surround it with doublequotes.
6370 VALUE is used literally, not evaluated.
6372 If VARIABLE has a `variable-interactive' property, that is used as if
6373 it were the arg to `interactive' (which see) to interactively read VALUE.
6375 If VARIABLE has been defined with `defcustom', then the type information
6376 in the definition is used to check that VALUE is valid.
6378 With a prefix argument, set VARIABLE to VALUE buffer-locally."
6379 (interactive
6380 (let* ((default-var (variable-at-point))
6381 (var (if (custom-variable-p default-var)
6382 (read-variable (format "Set variable (default %s): " default-var)
6383 default-var)
6384 (read-variable "Set variable: ")))
6385 (minibuffer-help-form '(describe-variable var))
6386 (prop (get var 'variable-interactive))
6387 (obsolete (car (get var 'byte-obsolete-variable)))
6388 (prompt (format "Set %s %s to value: " var
6389 (cond ((local-variable-p var)
6390 "(buffer-local)")
6391 ((or current-prefix-arg
6392 (local-variable-if-set-p var))
6393 "buffer-locally")
6394 (t "globally"))))
6395 (val (progn
6396 (when obsolete
6397 (message (concat "`%S' is obsolete; "
6398 (if (symbolp obsolete) "use `%S' instead" "%s"))
6399 var obsolete)
6400 (sit-for 3))
6401 (if prop
6402 ;; Use VAR's `variable-interactive' property
6403 ;; as an interactive spec for prompting.
6404 (call-interactively `(lambda (arg)
6405 (interactive ,prop)
6406 arg))
6407 (read
6408 (read-string prompt nil
6409 'set-variable-value-history
6410 (format "%S" (symbol-value var))))))))
6411 (list var val current-prefix-arg)))
6413 (and (custom-variable-p variable)
6414 (not (get variable 'custom-type))
6415 (custom-load-symbol variable))
6416 (let ((type (get variable 'custom-type)))
6417 (when type
6418 ;; Match with custom type.
6419 (require 'cus-edit)
6420 (setq type (widget-convert type))
6421 (unless (widget-apply type :match value)
6422 (error "Value `%S' does not match type %S of %S"
6423 value (car type) variable))))
6425 (if make-local
6426 (make-local-variable variable))
6428 (set variable value)
6430 ;; Force a thorough redisplay for the case that the variable
6431 ;; has an effect on the display, like `tab-width' has.
6432 (force-mode-line-update))
6433 \f
6434 ;; Define the major mode for lists of completions.
6436 (defvar completion-list-mode-map
6437 (let ((map (make-sparse-keymap)))
6438 (define-key map [mouse-2] 'mouse-choose-completion)
6439 (define-key map [follow-link] 'mouse-face)
6440 (define-key map [down-mouse-2] nil)
6441 (define-key map "\C-m" 'choose-completion)
6442 (define-key map "\e\e\e" 'delete-completion-window)
6443 (define-key map [left] 'previous-completion)
6444 (define-key map [right] 'next-completion)
6445 (define-key map "q" 'quit-window)
6446 (define-key map "z" 'kill-this-buffer)
6447 map)
6448 "Local map for completion list buffers.")
6450 ;; Completion mode is suitable only for specially formatted data.
6451 (put 'completion-list-mode 'mode-class 'special)
6453 (defvar completion-reference-buffer nil
6454 "Record the buffer that was current when the completion list was requested.
6455 This is a local variable in the completion list buffer.
6456 Initial value is nil to avoid some compiler warnings.")
6458 (defvar completion-no-auto-exit nil
6459 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6460 This also applies to other functions such as `choose-completion'.")
6462 (defvar completion-base-position nil
6463 "Position of the base of the text corresponding to the shown completions.
6464 This variable is used in the *Completions* buffers.
6465 Its value is a list of the form (START END) where START is the place
6466 where the completion should be inserted and END (if non-nil) is the end
6467 of the text to replace. If END is nil, point is used instead.")
6469 (defvar completion-list-insert-choice-function #'completion--replace
6470 "Function to use to insert the text chosen in *Completions*.
6471 Called with three arguments (BEG END TEXT), it should replace the text
6472 between BEG and END with TEXT. Expected to be set buffer-locally
6473 in the *Completions* buffer.")
6475 (defvar completion-base-size nil
6476 "Number of chars before point not involved in completion.
6477 This is a local variable in the completion list buffer.
6478 It refers to the chars in the minibuffer if completing in the
6479 minibuffer, or in `completion-reference-buffer' otherwise.
6480 Only characters in the field at point are included.
6482 If nil, Emacs determines which part of the tail end of the
6483 buffer's text is involved in completion by comparing the text
6484 directly.")
6485 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6487 (defun delete-completion-window ()
6488 "Delete the completion list window.
6489 Go to the window from which completion was requested."
6490 (interactive)
6491 (let ((buf completion-reference-buffer))
6492 (if (one-window-p t)
6493 (if (window-dedicated-p (selected-window))
6494 (delete-frame (selected-frame)))
6495 (delete-window (selected-window))
6496 (if (get-buffer-window buf)
6497 (select-window (get-buffer-window buf))))))
6499 (defun previous-completion (n)
6500 "Move to the previous item in the completion list."
6501 (interactive "p")
6502 (next-completion (- n)))
6504 (defun next-completion (n)
6505 "Move to the next item in the completion list.
6506 With prefix argument N, move N items (negative N means move backward)."
6507 (interactive "p")
6508 (let ((beg (point-min)) (end (point-max)))
6509 (while (and (> n 0) (not (eobp)))
6510 ;; If in a completion, move to the end of it.
6511 (when (get-text-property (point) 'mouse-face)
6512 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6513 ;; Move to start of next one.
6514 (unless (get-text-property (point) 'mouse-face)
6515 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6516 (setq n (1- n)))
6517 (while (and (< n 0) (not (bobp)))
6518 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6519 ;; If in a completion, move to the start of it.
6520 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6521 (goto-char (previous-single-property-change
6522 (point) 'mouse-face nil beg)))
6523 ;; Move to end of the previous completion.
6524 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6525 (goto-char (previous-single-property-change
6526 (point) 'mouse-face nil beg)))
6527 ;; Move to the start of that one.
6528 (goto-char (previous-single-property-change
6529 (point) 'mouse-face nil beg))
6530 (setq n (1+ n))))))
6532 (defun choose-completion (&optional event)
6533 "Choose the completion at point."
6534 (interactive (list last-nonmenu-event))
6535 ;; In case this is run via the mouse, give temporary modes such as
6536 ;; isearch a chance to turn off.
6537 (run-hooks 'mouse-leave-buffer-hook)
6538 (with-current-buffer (window-buffer (posn-window (event-start event)))
6539 (let ((buffer completion-reference-buffer)
6540 (base-size completion-base-size)
6541 (base-position completion-base-position)
6542 (insert-function completion-list-insert-choice-function)
6543 (choice
6544 (save-excursion
6545 (goto-char (posn-point (event-start event)))
6546 (let (beg end)
6547 (cond
6548 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6549 (setq end (point) beg (1+ (point))))
6550 ((and (not (bobp))
6551 (get-text-property (1- (point)) 'mouse-face))
6552 (setq end (1- (point)) beg (point)))
6553 (t (error "No completion here")))
6554 (setq beg (previous-single-property-change beg 'mouse-face))
6555 (setq end (or (next-single-property-change end 'mouse-face)
6556 (point-max)))
6557 (buffer-substring-no-properties beg end)))))
6559 (unless (buffer-live-p buffer)
6560 (error "Destination buffer is dead"))
6561 (quit-window nil (posn-window (event-start event)))
6563 (with-current-buffer buffer
6564 (choose-completion-string
6565 choice buffer
6566 (or base-position
6567 (when base-size
6568 ;; Someone's using old completion code that doesn't know
6569 ;; about base-position yet.
6570 (list (+ base-size (field-beginning))))
6571 ;; If all else fails, just guess.
6572 (list (choose-completion-guess-base-position choice)))
6573 insert-function)))))
6575 ;; Delete the longest partial match for STRING
6576 ;; that can be found before POINT.
6577 (defun choose-completion-guess-base-position (string)
6578 (save-excursion
6579 (let ((opoint (point))
6580 len)
6581 ;; Try moving back by the length of the string.
6582 (goto-char (max (- (point) (length string))
6583 (minibuffer-prompt-end)))
6584 ;; See how far back we were actually able to move. That is the
6585 ;; upper bound on how much we can match and delete.
6586 (setq len (- opoint (point)))
6587 (if completion-ignore-case
6588 (setq string (downcase string)))
6589 (while (and (> len 0)
6590 (let ((tail (buffer-substring (point) opoint)))
6591 (if completion-ignore-case
6592 (setq tail (downcase tail)))
6593 (not (string= tail (substring string 0 len)))))
6594 (setq len (1- len))
6595 (forward-char 1))
6596 (point))))
6598 (defun choose-completion-delete-max-match (string)
6599 (declare (obsolete choose-completion-guess-base-position "23.2"))
6600 (delete-region (choose-completion-guess-base-position string) (point)))
6602 (defvar choose-completion-string-functions nil
6603 "Functions that may override the normal insertion of a completion choice.
6604 These functions are called in order with four arguments:
6605 CHOICE - the string to insert in the buffer,
6606 BUFFER - the buffer in which the choice should be inserted,
6607 MINI-P - non-nil if BUFFER is a minibuffer, and
6608 BASE-SIZE - the number of characters in BUFFER before
6609 the string being completed.
6611 If a function in the list returns non-nil, that function is supposed
6612 to have inserted the CHOICE in the BUFFER, and possibly exited
6613 the minibuffer; no further functions will be called.
6615 If all functions in the list return nil, that means to use
6616 the default method of inserting the completion in BUFFER.")
6618 (defun choose-completion-string (choice &optional
6619 buffer base-position insert-function)
6620 "Switch to BUFFER and insert the completion choice CHOICE.
6621 BASE-POSITION says where to insert the completion.
6622 INSERT-FUNCTION says how to insert the completion and falls
6623 back on `completion-list-insert-choice-function' when nil."
6625 ;; If BUFFER is the minibuffer, exit the minibuffer
6626 ;; unless it is reading a file name and CHOICE is a directory,
6627 ;; or completion-no-auto-exit is non-nil.
6629 ;; Some older code may call us passing `base-size' instead of
6630 ;; `base-position'. It's difficult to make any use of `base-size',
6631 ;; so we just ignore it.
6632 (unless (consp base-position)
6633 (message "Obsolete `base-size' passed to choose-completion-string")
6634 (setq base-position nil))
6636 (let* ((buffer (or buffer completion-reference-buffer))
6637 (mini-p (minibufferp buffer)))
6638 ;; If BUFFER is a minibuffer, barf unless it's the currently
6639 ;; active minibuffer.
6640 (if (and mini-p
6641 (not (and (active-minibuffer-window)
6642 (equal buffer
6643 (window-buffer (active-minibuffer-window))))))
6644 (error "Minibuffer is not active for completion")
6645 ;; Set buffer so buffer-local choose-completion-string-functions works.
6646 (set-buffer buffer)
6647 (unless (run-hook-with-args-until-success
6648 'choose-completion-string-functions
6649 ;; The fourth arg used to be `mini-p' but was useless
6650 ;; (since minibufferp can be used on the `buffer' arg)
6651 ;; and indeed unused. The last used to be `base-size', so we
6652 ;; keep it to try and avoid breaking old code.
6653 choice buffer base-position nil)
6654 ;; This remove-text-properties should be unnecessary since `choice'
6655 ;; comes from buffer-substring-no-properties.
6656 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6657 ;; Insert the completion into the buffer where it was requested.
6658 (funcall (or insert-function completion-list-insert-choice-function)
6659 (or (car base-position) (point))
6660 (or (cadr base-position) (point))
6661 choice)
6662 ;; Update point in the window that BUFFER is showing in.
6663 (let ((window (get-buffer-window buffer t)))
6664 (set-window-point window (point)))
6665 ;; If completing for the minibuffer, exit it with this choice.
6666 (and (not completion-no-auto-exit)
6667 (minibufferp buffer)
6668 minibuffer-completion-table
6669 ;; If this is reading a file name, and the file name chosen
6670 ;; is a directory, don't exit the minibuffer.
6671 (let* ((result (buffer-substring (field-beginning) (point)))
6672 (bounds
6673 (completion-boundaries result minibuffer-completion-table
6674 minibuffer-completion-predicate
6675 "")))
6676 (if (eq (car bounds) (length result))
6677 ;; The completion chosen leads to a new set of completions
6678 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6679 (let ((mini (active-minibuffer-window)))
6680 (select-window mini)
6681 (when minibuffer-auto-raise
6682 (raise-frame (window-frame mini))))
6683 (exit-minibuffer))))))))
6685 (define-derived-mode completion-list-mode nil "Completion List"
6686 "Major mode for buffers showing lists of possible completions.
6688 to select the completion near point.
6690 with the mouse.
6693 (set (make-local-variable 'completion-base-size) nil))
6695 (defun completion-list-mode-finish ()
6696 "Finish setup of the completions buffer.
6697 Called from `temp-buffer-show-hook'."
6698 (when (eq major-mode 'completion-list-mode)
6699 (setq buffer-read-only t)))
6701 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6704 ;; Variables and faces used in `completion-setup-function'.
6706 (defcustom completion-show-help t
6707 "Non-nil means show help message in *Completions* buffer."
6708 :type 'boolean
6709 :version "22.1"
6710 :group 'completion)
6712 ;; This function goes in completion-setup-hook, so that it is called
6713 ;; after the text of the completion list buffer is written.
6714 (defun completion-setup-function ()
6715 (let* ((mainbuf (current-buffer))
6716 (base-dir
6717 ;; When reading a file name in the minibuffer,
6718 ;; try and find the right default-directory to set in the
6719 ;; completion list buffer.
6720 ;; FIXME: Why do we do that, actually? --Stef
6721 (if minibuffer-completing-file-name
6722 (file-name-as-directory
6723 (expand-file-name
6724 (substring (minibuffer-completion-contents)
6725 0 (or completion-base-size 0)))))))
6726 (with-current-buffer standard-output
6727 (let ((base-size completion-base-size) ;Read before killing localvars.
6728 (base-position completion-base-position)
6729 (insert-fun completion-list-insert-choice-function))
6730 (completion-list-mode)
6731 (set (make-local-variable 'completion-base-size) base-size)
6732 (set (make-local-variable 'completion-base-position) base-position)
6733 (set (make-local-variable 'completion-list-insert-choice-function)
6734 insert-fun))
6735 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6736 (if base-dir (setq default-directory base-dir))
6737 ;; Maybe insert help string.
6738 (when completion-show-help
6739 (goto-char (point-min))
6740 (if (display-mouse-p)
6741 (insert (substitute-command-keys
6743 (insert (substitute-command-keys
6747 (add-hook 'completion-setup-hook 'completion-setup-function)
6749 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6750 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6752 (defun switch-to-completions ()
6753 "Select the completion list window."
6754 (interactive)
6755 (let ((window (or (get-buffer-window "*Completions*" 0)
6756 ;; Make sure we have a completions window.
6757 (progn (minibuffer-completion-help)
6758 (get-buffer-window "*Completions*" 0)))))
6759 (when window
6760 (select-window window)
6761 ;; In the new buffer, go to the first completion.
6762 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6763 (when (bobp)
6764 (next-completion 1)))))
6765 \f
6766 ;;; Support keyboard commands to turn on various modifiers.
6768 ;; These functions -- which are not commands -- each add one modifier
6769 ;; to the following event.
6771 (defun event-apply-alt-modifier (_ignore-prompt)
6774 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6775 (defun event-apply-super-modifier (_ignore-prompt)
6778 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6779 (defun event-apply-hyper-modifier (_ignore-prompt)
6782 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6783 (defun event-apply-shift-modifier (_ignore-prompt)
6786 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6787 (defun event-apply-control-modifier (_ignore-prompt)
6790 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6791 (defun event-apply-meta-modifier (_ignore-prompt)
6794 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6796 (defun event-apply-modifier (event symbol lshiftby prefix)
6797 "Apply a modifier flag to event EVENT.
6798 SYMBOL is the name of this modifier, as a symbol.
6799 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6800 PREFIX is the string that represents this modifier in an event type symbol."
6801 (if (numberp event)
6802 (cond ((eq symbol 'control)
6803 (if (and (<= (downcase event) ?z)
6804 (>= (downcase event) ?a))
6805 (- (downcase event) ?a -1)
6806 (if (and (<= (downcase event) ?Z)
6807 (>= (downcase event) ?A))
6808 (- (downcase event) ?A -1)
6809 (logior (lsh 1 lshiftby) event))))
6810 ((eq symbol 'shift)
6811 (if (and (<= (downcase event) ?z)
6812 (>= (downcase event) ?a))
6813 (upcase event)
6814 (logior (lsh 1 lshiftby) event)))
6815 (t
6816 (logior (lsh 1 lshiftby) event)))
6817 (if (memq symbol (event-modifiers event))
6818 event
6819 (let ((event-type (if (symbolp event) event (car event))))
6820 (setq event-type (intern (concat prefix (symbol-name event-type))))
6821 (if (symbolp event)
6822 event-type
6823 (cons event-type (cdr event)))))))
6825 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6826 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6827 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6828 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6829 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6830 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6831 \f
6832 ;;;; Keypad support.
6834 ;; Make the keypad keys act like ordinary typing keys. If people add
6835 ;; bindings for the function key symbols, then those bindings will
6836 ;; override these, so this shouldn't interfere with any existing
6837 ;; bindings.
6839 ;; Also tell read-char how to handle these keys.
6840 (mapc
6841 (lambda (keypad-normal)
6842 (let ((keypad (nth 0 keypad-normal))
6843 (normal (nth 1 keypad-normal)))
6844 (put keypad 'ascii-character normal)
6845 (define-key function-key-map (vector keypad) (vector normal))))
6846 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6847 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6848 (kp-space ?\s)
6851 (kp-multiply ?*)
6852 (kp-add ?+)
6853 (kp-separator ?,)
6854 (kp-subtract ?-)
6855 (kp-decimal ?.)
6856 (kp-divide ?/)
6857 (kp-equal ?=)
6858 ;; Do the same for various keys that are represented as symbols under
6859 ;; GUIs but naturally correspond to characters.
6860 (backspace 127)
6861 (delete 127)
6864 (clear ?\C-l)
6865 (return ?\C-m)
6866 (escape ?\e)
6867 ))
6868 \f
6869 ;;;;
6870 ;;;; forking a twin copy of a buffer.
6871 ;;;;
6873 (defvar clone-buffer-hook nil
6874 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6876 (defvar clone-indirect-buffer-hook nil
6877 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6879 (defun clone-process (process &optional newname)
6880 "Create a twin copy of PROCESS.
6881 If NEWNAME is nil, it defaults to PROCESS' name;
6882 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6883 If PROCESS is associated with a buffer, the new process will be associated
6884 with the current buffer instead.
6885 Returns nil if PROCESS has already terminated."
6886 (setq newname (or newname (process-name process)))
6888 (setq newname (substring newname 0 (match-beginning 0))))
6889 (when (memq (process-status process) '(run stop open))
6890 (let* ((process-connection-type (process-tty-name process))
6891 (new-process
6892 (if (memq (process-status process) '(open))
6893 (let ((args (process-contact process t)))
6894 (setq args (plist-put args :name newname))
6895 (setq args (plist-put args :buffer
6896 (if (process-buffer process)
6897 (current-buffer))))
6898 (apply 'make-network-process args))
6899 (apply 'start-process newname
6900 (if (process-buffer process) (current-buffer))
6901 (process-command process)))))
6902 (set-process-query-on-exit-flag
6903 new-process (process-query-on-exit-flag process))
6904 (set-process-inherit-coding-system-flag
6905 new-process (process-inherit-coding-system-flag process))
6906 (set-process-filter new-process (process-filter process))
6907 (set-process-sentinel new-process (process-sentinel process))
6908 (set-process-plist new-process (copy-sequence (process-plist process)))
6909 new-process)))
6911 ;; things to maybe add (currently partly covered by `funcall mode'):
6912 ;; - syntax-table
6913 ;; - overlays
6914 (defun clone-buffer (&optional newname display-flag)
6915 "Create and return a twin copy of the current buffer.
6916 Unlike an indirect buffer, the new buffer can be edited
6917 independently of the old one (if it is not read-only).
6918 NEWNAME is the name of the new buffer. It may be modified by
6919 adding or incrementing <N> at the end as necessary to create a
6920 unique buffer name. If nil, it defaults to the name of the
6921 current buffer, with the proper suffix. If DISPLAY-FLAG is
6922 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6923 clone a file-visiting buffer, or a buffer whose major mode symbol
6924 has a non-nil `no-clone' property, results in an error.
6926 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6927 current buffer with appropriate suffix. However, if a prefix
6928 argument is given, then the command prompts for NEWNAME in the
6929 minibuffer.
6931 This runs the normal hook `clone-buffer-hook' in the new buffer
6932 after it has been set up properly in other respects."
6933 (interactive
6934 (progn
6935 (if buffer-file-name
6936 (error "Cannot clone a file-visiting buffer"))
6937 (if (get major-mode 'no-clone)
6938 (error "Cannot clone a buffer in %s mode" mode-name))
6939 (list (if current-prefix-arg
6940 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6941 t)))
6942 (if buffer-file-name
6943 (error "Cannot clone a file-visiting buffer"))
6944 (if (get major-mode 'no-clone)
6945 (error "Cannot clone a buffer in %s mode" mode-name))
6946 (setq newname (or newname (buffer-name)))
6948 (setq newname (substring newname 0 (match-beginning 0))))
6949 (let ((buf (current-buffer))
6950 (ptmin (point-min))
6951 (ptmax (point-max))
6952 (pt (point))
6953 (mk (if mark-active (mark t)))
6954 (modified (buffer-modified-p))
6955 (mode major-mode)
6956 (lvars (buffer-local-variables))
6957 (process (get-buffer-process (current-buffer)))
6958 (new (generate-new-buffer (or newname (buffer-name)))))
6959 (save-restriction
6960 (widen)
6961 (with-current-buffer new
6962 (insert-buffer-substring buf)))
6963 (with-current-buffer new
6964 (narrow-to-region ptmin ptmax)
6965 (goto-char pt)
6966 (if mk (set-mark mk))
6967 (set-buffer-modified-p modified)
6969 ;; Clone the old buffer's process, if any.
6970 (when process (clone-process process))
6972 ;; Now set up the major mode.
6973 (funcall mode)
6975 ;; Set up other local variables.
6976 (mapc (lambda (v)
6977 (condition-case () ;in case var is read-only
6978 (if (symbolp v)
6979 (makunbound v)
6980 (set (make-local-variable (car v)) (cdr v)))
6981 (error nil)))
6982 lvars)
6984 ;; Run any hooks (typically set up by the major mode
6985 ;; for cloning to work properly).
6986 (run-hooks 'clone-buffer-hook))
6987 (if display-flag
6988 ;; Presumably the current buffer is shown in the selected frame, so
6989 ;; we want to display the clone elsewhere.
6990 (let ((same-window-regexps nil)
6991 (same-window-buffer-names))
6992 (pop-to-buffer new)))
6993 new))
6996 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6997 "Create an indirect buffer that is a twin copy of the current buffer.
6999 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
7000 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
7001 or if not called with a prefix arg, NEWNAME defaults to the current
7002 buffer's name. The name is modified by adding a `<N>' suffix to it
7003 or by incrementing the N in an existing suffix. Trying to clone a
7004 buffer whose major mode symbol has a non-nil `no-clone-indirect'
7005 property results in an error.
7007 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
7008 This is always done when called interactively.
7010 Optional third arg NORECORD non-nil means do not put this buffer at the
7011 front of the list of recently selected ones."
7012 (interactive
7013 (progn
7014 (if (get major-mode 'no-clone-indirect)
7015 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7016 (list (if current-prefix-arg
7017 (read-buffer "Name of indirect buffer: " (current-buffer)))
7018 t)))
7019 (if (get major-mode 'no-clone-indirect)
7020 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7021 (setq newname (or newname (buffer-name)))
7023 (setq newname (substring newname 0 (match-beginning 0))))
7024 (let* ((name (generate-new-buffer-name newname))
7025 (buffer (make-indirect-buffer (current-buffer) name t)))
7026 (with-current-buffer buffer
7027 (run-hooks 'clone-indirect-buffer-hook))
7028 (when display-flag
7029 (pop-to-buffer buffer norecord))
7030 buffer))
7033 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
7034 "Like `clone-indirect-buffer' but display in another window."
7035 (interactive
7036 (progn
7037 (if (get major-mode 'no-clone-indirect)
7038 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
7039 (list (if current-prefix-arg
7040 (read-buffer "Name of indirect buffer: " (current-buffer)))
7041 t)))
7042 (let ((pop-up-windows t))
7043 (clone-indirect-buffer newname display-flag norecord)))
7045 \f
7046 ;;; Handling of Backspace and Delete keys.
7048 (defcustom normal-erase-is-backspace 'maybe
7049 "Set the default behavior of the Delete and Backspace keys.
7051 If set to t, Delete key deletes forward and Backspace key deletes
7052 backward.
7054 If set to nil, both Delete and Backspace keys delete backward.
7056 If set to 'maybe (which is the default), Emacs automatically
7057 selects a behavior. On window systems, the behavior depends on
7058 the keyboard used. If the keyboard has both a Backspace key and
7059 a Delete key, and both are mapped to their usual meanings, the
7060 option's default value is set to t, so that Backspace can be used
7061 to delete backward, and Delete can be used to delete forward.
7063 If not running under a window system, customizing this option
7064 accomplishes a similar effect by mapping C-h, which is usually
7065 generated by the Backspace key, to DEL, and by mapping DEL to C-d
7066 via `keyboard-translate'. The former functionality of C-h is
7067 available on the F1 key. You should probably not use this
7068 setting if you don't have both Backspace, Delete and F1 keys.
7070 Setting this variable with setq doesn't take effect. Programmatically,
7071 call `normal-erase-is-backspace-mode' (which see) instead."
7072 :type '(choice (const :tag "Off" nil)
7073 (const :tag "Maybe" maybe)
7074 (other :tag "On" t))
7075 :group 'editing-basics
7076 :version "21.1"
7077 :set (lambda (symbol value)
7078 ;; The fboundp is because of a problem with :set when
7079 ;; dumping Emacs. It doesn't really matter.
7080 (if (fboundp 'normal-erase-is-backspace-mode)
7081 (normal-erase-is-backspace-mode (or value 0))
7082 (set-default symbol value))))
7084 (defun normal-erase-is-backspace-setup-frame (&optional frame)
7085 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
7086 (unless frame (setq frame (selected-frame)))
7087 (with-selected-frame frame
7088 (unless (terminal-parameter nil 'normal-erase-is-backspace)
7089 (normal-erase-is-backspace-mode
7090 (if (if (eq normal-erase-is-backspace 'maybe)
7091 (and (not noninteractive)
7092 (or (memq system-type '(ms-dos windows-nt))
7093 (memq window-system '(w32 ns))
7094 (and (memq window-system '(x))
7095 (fboundp 'x-backspace-delete-keys-p)
7096 (x-backspace-delete-keys-p))
7097 ;; If the terminal Emacs is running on has erase char
7098 ;; set to ^H, use the Backspace key for deleting
7099 ;; backward, and the Delete key for deleting forward.
7100 (and (null window-system)
7101 (eq tty-erase-char ?\^H))))
7102 normal-erase-is-backspace)
7103 1 0)))))
7105 (define-minor-mode normal-erase-is-backspace-mode
7106 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
7107 With a prefix argument ARG, enable this feature if ARG is
7108 positive, and disable it otherwise. If called from Lisp, enable
7109 the mode if ARG is omitted or nil.
7111 On window systems, when this mode is on, Delete is mapped to C-d
7112 and Backspace is mapped to DEL; when this mode is off, both
7113 Delete and Backspace are mapped to DEL. (The remapping goes via
7114 `local-function-key-map', so binding Delete or Backspace in the
7115 global or local keymap will override that.)
7117 In addition, on window systems, the bindings of C-Delete, M-Delete,
7118 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
7119 the global keymap in accordance with the functionality of Delete and
7120 Backspace. For example, if Delete is remapped to C-d, which deletes
7121 forward, C-Delete is bound to `kill-word', but if Delete is remapped
7122 to DEL, which deletes backward, C-Delete is bound to
7123 `backward-kill-word'.
7125 If not running on a window system, a similar effect is accomplished by
7126 remapping C-h (normally produced by the Backspace key) and DEL via
7127 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
7128 to C-d; if it's off, the keys are not remapped.
7130 When not running on a window system, and this mode is turned on, the
7131 former functionality of C-h is available on the F1 key. You should
7132 probably not turn on this mode on a text-only terminal if you don't
7133 have both Backspace, Delete and F1 keys.
7135 See also `normal-erase-is-backspace'."
7136 :variable ((eq (terminal-parameter nil 'normal-erase-is-backspace) 1)
7137 . (lambda (v)
7138 (setf (terminal-parameter nil 'normal-erase-is-backspace)
7139 (if v 1 0))))
7140 (let ((enabled (eq 1 (terminal-parameter
7141 nil 'normal-erase-is-backspace))))
7143 (cond ((or (memq window-system '(x w32 ns pc))
7144 (memq system-type '(ms-dos windows-nt)))
7145 (let ((bindings
7146 `(([M-delete] [M-backspace])
7147 ([C-M-delete] [C-M-backspace])
7148 ([?\e C-delete] [?\e C-backspace]))))
7150 (if enabled
7151 (progn
7152 (define-key local-function-key-map [delete] [deletechar])
7153 (define-key local-function-key-map [kp-delete] [?\C-d])
7154 (define-key local-function-key-map [backspace] [?\C-?])
7155 (dolist (b bindings)
7156 ;; Not sure if input-decode-map is really right, but
7157 ;; keyboard-translate-table (used below) only works
7158 ;; for integer events, and key-translation-table is
7159 ;; global (like the global-map, used earlier).
7160 (define-key input-decode-map (car b) nil)
7161 (define-key input-decode-map (cadr b) nil)))
7162 (define-key local-function-key-map [delete] [?\C-?])
7163 (define-key local-function-key-map [kp-delete] [?\C-?])
7164 (define-key local-function-key-map [backspace] [?\C-?])
7165 (dolist (b bindings)
7166 (define-key input-decode-map (car b) (cadr b))
7167 (define-key input-decode-map (cadr b) (car b))))))
7168 (t
7169 (if enabled
7170 (progn
7171 (keyboard-translate ?\C-h ?\C-?)
7172 (keyboard-translate ?\C-? ?\C-d))
7173 (keyboard-translate ?\C-h ?\C-h)
7174 (keyboard-translate ?\C-? ?\C-?))))
7176 (if (called-interactively-p 'interactive)
7177 (message "Delete key deletes %s"
7178 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
7179 "forward" "backward")))))
7180 \f
7181 (defvar vis-mode-saved-buffer-invisibility-spec nil
7182 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
7184 (define-minor-mode read-only-mode
7185 "Change whether the current buffer is read-only.
7186 With prefix argument ARG, make the buffer read-only if ARG is
7187 positive, otherwise make it writable. If buffer is read-only
7188 and `view-read-only' is non-nil, enter view mode.
7190 Do not call this from a Lisp program unless you really intend to
7192 possibly enabling or disabling View mode. Also, note that this
7193 command works by setting the variable `buffer-read-only', which
7194 does not affect read-only regions caused by text properties. To
7195 ignore read-only status in a Lisp program (whether due to text
7196 properties or buffer state), bind `inhibit-read-only' temporarily
7197 to a non-nil value."
7198 :variable buffer-read-only
7199 (cond
7200 ((and (not buffer-read-only) view-mode)
7201 (View-exit-and-edit)
7202 (make-local-variable 'view-read-only)
7203 (setq view-read-only t)) ; Must leave view mode.
7204 ((and buffer-read-only view-read-only
7205 ;; If view-mode is already active, `view-mode-enter' is a nop.
7206 (not view-mode)
7207 (not (eq (get major-mode 'mode-class) 'special)))
7208 (view-mode-enter))))
7210 (define-minor-mode visible-mode
7211 "Toggle making all invisible text temporarily visible (Visible mode).
7212 With a prefix argument ARG, enable Visible mode if ARG is
7213 positive, and disable it otherwise. If called from Lisp, enable
7214 the mode if ARG is omitted or nil.
7216 This mode works by saving the value of `buffer-invisibility-spec'
7217 and setting it to nil."
7218 :lighter " Vis"
7219 :group 'editing-basics
7220 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
7221 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
7222 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
7223 (when visible-mode
7224 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
7225 buffer-invisibility-spec)
7226 (setq buffer-invisibility-spec nil)))
7227 \f
7228 ;; Minibuffer prompt stuff.
7230 ;;(defun minibuffer-prompt-modification (start end)
7231 ;; (error "You cannot modify the prompt"))
7232 ;;
7233 ;;
7234 ;;(defun minibuffer-prompt-insertion (start end)
7235 ;; (let ((inhibit-modification-hooks t))
7236 ;; (delete-region start end)
7237 ;; ;; Discard undo information for the text insertion itself
7238 ;; ;; and for the text deletion.above.
7239 ;; (when (consp buffer-undo-list)
7240 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
7241 ;; (message "You cannot modify the prompt")))
7242 ;;
7243 ;;
7244 ;;(setq minibuffer-prompt-properties
7245 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
7246 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
7248 \f
7249 ;;;; Problematic external packages.
7251 ;; rms says this should be done by specifying symbols that define
7252 ;; versions together with bad values. This is therefore not as
7253 ;; flexible as it could be. See the thread:
7254 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
7255 (defconst bad-packages-alist
7256 ;; Not sure exactly which semantic versions have problems.
7257 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
7259 "The version of `semantic' loaded does not work in Emacs 22.
7260 It can cause constant high CPU load.
7261 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
7262 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
7263 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
7264 ;; provided the `CUA-mode' feature. Since this is no longer true,
7265 ;; we can warn the user if the `CUA-mode' feature is ever provided.
7266 (CUA-mode t nil
7267 "CUA-mode is now part of the standard GNU Emacs distribution,
7268 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
7270 You have loaded an older version of CUA-mode which does not work
7271 correctly with this version of Emacs. You should remove the old
7272 version and use the one distributed with Emacs."))
7273 "Alist of packages known to cause problems in this version of Emacs.
7274 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
7275 PACKAGE is either a regular expression to match file names, or a
7276 symbol (a feature name); see the documentation of
7277 `after-load-alist', to which this variable adds functions.
7278 SYMBOL is either the name of a string variable, or `t'. Upon
7279 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
7280 warning using STRING as the message.")
7282 (defun bad-package-check (package)
7283 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
7284 (condition-case nil
7285 (let* ((list (assoc package bad-packages-alist))
7286 (symbol (nth 1 list)))
7287 (and list
7288 (boundp symbol)
7289 (or (eq symbol t)
7290 (and (stringp (setq symbol (eval symbol)))
7291 (string-match-p (nth 2 list) symbol)))
7292 (display-warning package (nth 3 list) :warning)))
7293 (error nil)))
7295 (mapc (lambda (elem)
7296 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
7297 bad-packages-alist)
7300 (provide 'simple)
7302 ;;; simple.el ends here