| blob | 45daf99f6147c0ca1d4de3948e4fb4721a6c316c |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2012 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: internal
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; A grab-bag of basic Emacs commands not specifically related to some
27 ;; major mode or to file-handling.
29 ;;; Code:
36 ;;; From compile.el
41 "Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
55 \f
56 ;;; next-error support framework
59 "`next-error' support framework."
65 "Face used to highlight next error locus."
70 "Highlighting of locations in selected source buffers.
71 If a number, highlight the locus in `next-error' face for the given time
72 in seconds, or until the next command is executed.
73 If t, highlight the locus until the next command is executed, or until
74 some other locus replaces it.
75 If nil, don't highlight the locus in the source buffer.
76 If `fringe-arrow', indicate the locus by the fringe arrow
77 indefinitely until some other locus replaces it."
86 "Highlighting of locations in `next-error-no-select'.
87 If number, highlight the locus in `next-error' face for given time in seconds.
88 If t, highlight the locus indefinitely until some other locus replaces it.
89 If nil, don't highlight the locus in the source buffer.
90 If `fringe-arrow', indicate the locus by the fringe arrow
91 indefinitely until some other locus replaces it."
100 "Display the line in the visited source file recentered as specified.
101 If non-nil, the value is passed directly to `recenter'."
109 "List of hook functions run by `next-error' after visiting source file."
120 "The most recent `next-error' buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
137 "Function to use to move to an error locus.
138 It takes two arguments, a buffer position in the error buffer
139 and a buffer position in the error locus buffer.
140 The buffer for the error locus should already be current.
145 &optional avoid-current
146 extra-test-inclusive
147 extra-test-exclusive)
148 "Test if BUFFER is a `next-error' capable buffer.
150 If AVOID-CURRENT is non-nil, treat the current buffer
151 as an absolute last resort only.
153 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
154 that normally would not qualify. If it returns t, the buffer
155 in question is treated as usable.
157 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
158 that would normally be considered usable. If it returns nil,
159 that buffer is rejected."
164 ;; Optionally reject some buffers.
167 t)
168 ;; Optionally accept some other buffers.
173 extra-test-inclusive
174 extra-test-exclusive)
175 "Return a `next-error' capable buffer.
177 If AVOID-CURRENT is non-nil, treat the current buffer
178 as an absolute last resort only.
180 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
181 that normally would not qualify. If it returns t, the buffer
182 in question is treated as usable.
184 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
185 that would normally be considered usable. If it returns nil,
186 that buffer is rejected."
188 ;; 1. If one window on the selected frame displays such buffer, return it.
194 avoid-current
195 extra-test-inclusive extra-test-exclusive)
200 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
203 extra-test-inclusive extra-test-exclusive))
204 next-error-last-buffer)
205 ;; 3. If the current buffer is acceptable, choose it.
207 extra-test-inclusive extra-test-exclusive)
209 ;; 4. Look for any acceptable buffer.
214 extra-test-inclusive extra-test-exclusive)))
217 ;; 5. Use the current buffer as a last resort if it qualifies,
218 ;; even despite AVOID-CURRENT.
221 extra-test-inclusive extra-test-exclusive)
225 ;; 6. Give up.
229 "Visit next `next-error' message and corresponding source code.
231 If all the error messages parsed so far have been processed already,
232 the message buffer is checked for new ones.
234 A prefix ARG specifies how many error messages to move;
235 negative means move back to previous error messages.
237 and start at the first error.
239 The RESET argument specifies that we should restart from the beginning.
242 compilation, grep, or occur buffer. It can also operate on any
244 more generally, on any buffer in Compilation mode or with
245 Compilation Minor mode enabled, or any buffer in which
246 `next-error-function' is bound to an appropriate function.
247 To specify use of a particular buffer for error messages, type
249 in the current frame.
252 runs `next-error-hook' with `run-hooks', and stays with that buffer
253 until you use it in some other buffer which uses Compilation mode
254 or Compilation Minor mode.
256 To control which errors are matched, customize the variable
257 `compilation-error-regexp-alist'."
261 ;; we know here that next-error-function is a valid symbol we can funcall
269 "Visit the source code corresponding to the `next-error' message at point."
271 ;; we know here that next-error-function is a valid symbol we can funcall
282 "Visit previous `next-error' message and corresponding source code.
284 Prefix arg N says how many error messages to move backwards (or
285 forwards, if negative).
292 "Restart at the first error.
293 Visit corresponding source code.
294 With prefix arg N, visit the source code of the Nth error.
300 "Move point to the next error in the `next-error' buffer and highlight match.
301 Prefix arg N says how many error messages to move forwards (or
302 backwards, if negative).
304 select the source buffer."
311 "Move point to the previous error in the `next-error' buffer and highlight match.
312 Prefix arg N says how many error messages to move backwards (or
313 forwards, if negative).
315 select the source buffer."
319 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
323 "Minor mode for compilation, occur and diff modes.
324 With a prefix argument ARG, enable mode if ARG is positive, and
325 disable it otherwise. If called from Lisp, enable mode if ARG is
326 omitted or nil.
327 When turned on, cursor motion in the compilation, grep, occur or diff
328 buffer causes automatic display of the corresponding source code location."
335 ;; Used as a `post-command-hook' by `next-error-follow-mode'
336 ;; for the *Compilation* *grep* and *Occur* buffers.
346 \f
347 ;;;
350 "Major mode not specialized for anything in particular.
351 Other major modes are defined by comparison with this one."
357 ;; Special major modes to view specially formatted data rather than files.
371 map))
375 "Parent major mode from which special major modes should inherit."
378 ;; Major mode meant to be the parent of programming modes.
383 map)
387 "Indent the expression after point."
394 "Major mode for editing programming language source code."
397 ;; Any programming language is always written left to right.
400 ;; Making and deleting lines.
406 "Insert a newline, and move to left margin of the new line if it's blank.
407 If `use-hard-newlines' is non-nil, the newline is marked with the
408 text-property `hard'.
409 With ARG, insert that many newlines.
410 Call `auto-fill-function' if the current column number is greater
411 than the value of `fill-column' and ARG is nil."
414 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
415 ;; Set last-command-event to tell self-insert what to insert.
419 ;; Don't auto-fill if we have a numeric argument.
422 ;; Do the rest in post-self-insert-hook, because we want to do it
423 ;; *before* other functions on that hook.
425 ;; Mark the newline(s) `hard'.
429 ;; If the newline leaves the previous line blank, and we
430 ;; have a left margin, delete that from the blank line.
438 ;; Indent the line after the newline, except in one case:
439 ;; when we added the newline at the beginning of a line which
440 ;; starts a page.
447 ;; We first used let-binding to protect the hook, but that was naive
448 ;; since add-hook affects the symbol-default value of the variable,
449 ;; whereas the let-binding might only protect the buffer-local value.
451 nil)
456 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
462 "Insert a newline and leave point before it.
463 If there is a fill prefix and/or a `left-margin', insert them
464 on the new line if the line would have been blank.
465 With arg N, insert N newlines."
470 ;; Don't expand an abbrev before point.
484 "Split current line, moving portion beyond point vertically down.
485 If the current line starts with `fill-prefix', insert it on the new
486 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
488 When called from Lisp code, ARG may be a prefix string to copy."
493 ;; What prefix should we check for (nil means don't).
497 ;; Does this line start with it?
508 "Join this line to previous and fix up whitespace at join.
509 If there is a fill prefix, delete it from the beginning of this line.
510 With argument, join this line to following line."
517 ;; If the second line started with the fill prefix,
518 ;; delete the prefix.
530 "On blank line, delete all surrounding blank lines, leaving just one.
531 On isolated blank line, delete that one.
532 On nonblank line, delete any immediately following blank lines."
538 ;; Set singleblank if there is just one blank line here.
545 ;; Delete preceding blank lines, and this one too if it's the only one.
554 ;; Delete following blank lines, unless the current line is blank
555 ;; and there are no following blank lines.
564 ;; Handle the special case where point is followed by newline and eob.
565 ;; Delete the line, leaving point at eob.
570 "Delete all the trailing whitespace across the current buffer.
571 All whitespace after the last non-whitespace character in a line is deleted.
573 A formfeed is not considered whitespace by this function.
574 If END is nil, also delete all trailing lines at the end of the buffer.
575 If the region is active, only delete whitespace within the region."
588 ;; Don't delete formfeeds, even if they are considered whitespace.
592 ;; Delete trailing empty lines.
595 ;; Really the end of buffer.
600 ;; Return nil for the benefit of `write-file-functions'.
601 nil)
604 "Insert a newline, then indent according to major mode.
605 Indentation is done using the value of `indent-line-function'.
606 In programming language modes, this is the same as TAB.
607 In some text modes, where TAB inserts a tab, this command indents to the
608 column specified by the function `current-left-margin'."
615 "Reindent current line, insert newline, then indent the new line.
616 Indentation of both lines is done according to the current major mode,
617 which means calling the current value of `indent-line-function'.
618 In programming language modes, this is the same as TAB.
619 In some text modes, where TAB inserts a tab, this indents to the
620 column specified by the function `current-left-margin'."
623 ;; Be careful to insert the newline before indenting the line.
624 ;; Otherwise, the indentation might be wrong.
628 ;; We are at EOL before the call to indent-according-to-mode, and
629 ;; after it we usually are as well, but not always. We tried to
630 ;; address it with `save-excursion' but that uses a normal marker
631 ;; whereas we need `move after insertion', so we do the save/restore
632 ;; by hand.
636 ;; Remove the trailing white-space after indentation because
637 ;; indentation may introduce the whitespace.
642 "Read next input character and insert it.
643 This is useful for inserting control characters.
644 With argument, insert ARG copies of the character.
646 If the first character you type after this command is an octal digit,
647 you should type a sequence of octal digits which specify a character code.
648 Any nondigit terminates the sequence. If the terminator is a RET,
649 it is discarded; any other terminator is used itself as input.
650 The variable `read-quoted-char-radix' specifies the radix for this feature;
651 set it to 10 or 16 to use decimal or hex instead of octal.
653 In overwrite mode, this function inserts the character anyway, and
654 does not handle octal digits specially. This means that if you use
655 overwrite as your normal editing mode, you can use this function to
656 insert characters when necessary.
658 In binary overwrite mode, this function does overwrite, and octal
659 digits are interpreted as a character code. This is intended to be
660 useful for editing binary files."
663 ;; Avoid "obsolete" warnings for translation-table-for-input.
670 ;; This used to assume character codes 0240 - 0377 stand for
671 ;; characters in some single-byte character set, and converted them
672 ;; to Emacs characters. But in 23.1 this feature is deprecated
673 ;; in favor of inserting the corresponding Unicode characters.
674 ;; (if (and enable-multibyte-characters
675 ;; (>= char ?\240)
676 ;; (<= char ?\377))
677 ;; (setq char (unibyte-char-to-multibyte char)))
686 "Move forward ARG lines and position at first nonblank character."
692 "Move backward ARG lines and position at first nonblank character."
698 "Move point to the first non-whitespace character on this line."
702 ;; Move back over chars that have whitespace syntax but have the p flag.
706 "Fixup white space between objects around point.
707 Leave one space or none, according to the context."
714 nil
718 "Delete all spaces and tabs around point.
719 If BACKWARD-ONLY is non-nil, only delete them before point."
724 orig-pos
733 "Delete all spaces and tabs around point, leaving one space (or N spaces).
734 If N is negative, delete newlines as well."
751 \f
753 "Move point to the beginning of the buffer.
754 With numeric arg N, put point N/10 of the way from the beginning.
755 If the buffer is narrowed, this command uses the beginning of the
756 accessible part of the buffer.
758 If Transient Mark mode is disabled, leave mark at previous
761 Don't use this command in Lisp programs!
762 \(goto-char (point-min)) is faster."
771 ;; Avoid overflow for large buffer sizes!
779 "Move point to the end of the buffer.
780 With numeric arg N, put point N/10 of the way from the end.
781 If the buffer is narrowed, this command uses the end of the
782 accessible part of the buffer.
784 If Transient Mark mode is disabled, leave mark at previous
787 Don't use this command in Lisp programs!
788 \(goto-char (point-max)) is faster."
795 ;; Avoid overflow for large buffer sizes!
800 ;; If we went to a place in the middle of the buffer,
801 ;; adjust it to the beginning of a line.
804 ;; If the end of the buffer is not already on the screen,
805 ;; then scroll specially to put it near, but not at, the bottom.
810 "Whether single-char deletion commands delete an active region.
811 This has an effect only if Transient Mark mode is enabled, and
812 affects `delete-forward-char' and `delete-backward-char', though
813 not `delete-char'.
815 If the value is the symbol `kill', the active region is killed
816 instead of deleted."
824 "Delete the previous N characters (following if N is negative).
825 If Transient Mark mode is enabled, the mark is active, and N is 1,
826 delete the text in the region and deactivate the mark instead.
827 To disable this, set `delete-active-region' to nil.
829 Optional second arg KILLFLAG, if non-nil, means to kill (save in
830 kill ring) instead of delete. Interactively, N is the prefix
831 arg, and KILLFLAG is set if N is explicitly specified.
833 In Overwrite mode, single character backward deletion may replace
834 tabs with spaces so as to back over columns, unless point is at
835 the end of the line."
840 delete-active-region
842 ;; If a region is active, kill or delete it.
846 ;; In Overwrite mode, maybe untabify while deleting
856 ;; Otherwise, do simple deletion.
860 "Delete the following N characters (previous if N is negative).
861 If Transient Mark mode is enabled, the mark is active, and N is 1,
862 delete the text in the region and deactivate the mark instead.
863 To disable this, set `delete-active-region' to nil.
865 Optional second arg KILLFLAG non-nil means to kill (save in kill
866 ring) instead of delete. Interactively, N is the prefix arg, and
867 KILLFLAG is set if N was explicitly specified."
872 delete-active-region
874 ;; If a region is active, kill or delete it.
878 ;; Otherwise, do simple deletion.
882 "Put point at beginning and mark at end of buffer.
883 If narrowing is in effect, only uses the accessible part of the buffer.
884 You probably should not use this function in Lisp programs;
885 it is usually a mistake for a Lisp function to use any subroutine
886 that uses or sets the mark."
891 \f
893 ;; Counting lines, one way or another.
896 "Goto LINE, counting from line 1 at beginning of buffer.
897 Normally, move point in the current buffer, and leave mark at the
899 move point in the most recently selected other buffer, and switch to it.
901 If there's a number in the buffer at point, it is the default for LINE.
903 This function is usually the wrong thing to use in a Lisp program.
904 What you probably want instead is something like:
905 (goto-char (point-min)) (forward-line (1- N))
906 If at all possible, an even better solution is to use char counts
907 rather than line counts."
911 ;; Look for a default, a number in the buffer at point.
921 ;; Decide if we're switching buffers.
929 ;; Read the argument, offering that number (if any) as default.
932 buffer-prompt
933 default)
934 default)
935 buffer))))
936 ;; Switch to the desired buffer, one way or another.
941 ;; Leave mark at previous position
943 ;; Move to the specified line number in that buffer.
952 "Count the number of words in the region.
953 If called interactively, print a message reporting the number of
954 lines, words, and chars in the region.
955 If called from Lisp, return the number of words between positions
956 START and END."
963 "Count words between START and END.
964 If called interactively, START and END are normally the start and
965 end of the buffer; but if the region is active, START and END are
966 the start and end of the region. Print a message reporting the
967 number of lines, words, and chars.
969 If called from Lisp, return the number of words between START and
970 END, without printing any message."
980 words))
991 str
999 "Print the current buffer line number and narrowed line number of point."
1012 "Return number of lines between START and END.
1013 This is usually the number of newlines between them,
1014 but can be one more if START is not equal to END
1015 and the greater of them is not at the start of a line."
1031 done)))
1035 "Return (narrowed) buffer line number at position POS.
1036 If POS is nil, use current buffer location.
1037 Counting starts at (point-min), so the value refers
1038 to the contents of the accessible portion of the buffer."
1048 "Print info on cursor position (on screen and within buffer).
1049 Also describe the character after point, and give its character code
1050 in octal, decimal and hex.
1052 For a non-ASCII multibyte character, also give its encoding in the
1053 buffer's selected coding system if the coding system encodes the
1054 character safely. If the character is encoded into one byte, that
1055 code is shown in hex. If the character is encoded into more than one
1058 In addition, with prefix argument, show details about that character
1059 in *Help* buffer. See also the command `describe-char'."
1064 ;; If the character is one of LRE, LRO, RLE, RLO, it
1065 ;; will start a directional embedding, which could
1066 ;; completely disrupt the rest of the line (e.g., RLO
1067 ;; will display the rest of the line right-to-left).
1068 ;; So we put an invisible PDF character after these
1069 ;; characters, to end the embedding, which eliminates
1070 ;; any effects on the rest of the line.
1072 ;; Strong right-to-left characters cause reordering of
1073 ;; the following numerical characters which show the
1074 ;; codepoint, so append LRM to countermand that.
1084 ;; Avoid overflow from multiplying by 100!
1088 ""
1094 pos total percent beg end col hscroll)
1096 pos total col hscroll))
1098 encoded encoding-msg display-prop under-display)
1105 ;; Check if the character is displayed with some `display'
1106 ;; text property. In that case, set under-display to the
1107 ;; buffer substring covered by that property.
1118 under-display)))
1124 char char char under-display)
1126 char char char under-display display-prop))
1129 char char char
1131 "..."
1135 ;; We show the detailed information about CHAR.
1142 bidi-fixer
1143 encoding-msg pos total percent beg end col hscroll)
1150 bidi-fixer encoding-msg pos total percent col hscroll))))))
1151 \f
1152 ;; Initialize read-expression-map. It is defined at C level.
1155 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1156 ;; too rarely useful.
1166 "The current default value or list of default values in the minibuffer.
1167 The functions `read-from-minibuffer' and `completing-read' bind
1171 "Value for `print-level' while printing value in `eval-expression'.
1172 A value of nil means no limit."
1178 "Value for `print-length' while printing value in `eval-expression'.
1179 A value of nil means no limit."
1185 "If non-nil set `debug-on-error' to t in `eval-expression'.
1186 If nil, don't change the value of `debug-on-error'."
1192 "Format VALUE as a result of evaluated expression.
1193 Return a formatted string which is displayed in the echo area
1194 in addition to the value printed by prin1 in functions which
1195 display the result of expression evaluation."
1208 ;; We define this, rather than making `eval' interactive,
1209 ;; for the sake of completion of names like eval-region, eval-buffer.
1212 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1213 When called interactively, read an Emacs Lisp expression and
1214 evaluate it.
1215 Value is also consed on to front of the variable `values'.
1216 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1217 with prefix argument) means insert the result into the current buffer
1218 instead of printing it in the echo area. Truncates long output
1219 according to the value of the variables `eval-expression-print-length'
1220 and `eval-expression-print-level'.
1222 If `eval-expression-debug-on-error' is non-nil, which is the default,
1223 this command arranges for all errors to enter the debugger."
1227 nil read-expression-map t
1229 current-prefix-arg))
1234 ;; Bind debug-on-error to something unique so that we can
1235 ;; detect when evalled code changes it.
1239 ;; If evalled code has changed the value of debug-on-error,
1240 ;; propagate that change to the global binding.
1256 "Prompting with PROMPT, let user edit COMMAND and eval result.
1257 COMMAND is a Lisp expression. Let user edit that expression in
1258 the minibuffer, then read and evaluate the result."
1265 read-expression-map t
1267 ;; If command was added to command-history as a string,
1268 ;; get rid of that. We want only evaluable expressions there.
1272 ;; If command to be redone does not match front of history,
1273 ;; add it to the history.
1279 "Edit and re-evaluate last complex command, or ARGth from last.
1280 A complex command is one which used the minibuffer.
1281 The command is placed in the minibuffer as a Lisp form for editing.
1282 The result is executed, repeating the command as changed.
1283 If the command has been changed or is not the most recent previous
1284 command it is added to the front of the command history.
1285 You can use the minibuffer history commands \
1287 to get different commands to edit and resubmit."
1290 newcmd)
1302 ;; If command was added to command-history as a
1303 ;; string, get rid of that. We want only
1304 ;; evaluable expressions there.
1308 ;; If command to be redone does not match front of history,
1309 ;; add it to the history.
1318 "Read command name to invoke in `execute-extended-command'."
1323 ;; Get a command name at point in the original buffer
1324 ;; to propose it after M-n.
1328 ;; Read a string, completing from and restricting to the set of
1329 ;; all defined commands. Don't provide any initial input.
1330 ;; Save the command read on the extended-command history list.
1341 ;; This isn't strictly correct if `execute-extended-command'
1342 ;; is bound to anything else (e.g. [menu]).
1343 ;; It could use (key-description (this-single-command-keys)),
1344 ;; but actually a prompt other than "M-x" would be confusing,
1345 ;; because "M-x" is a well-known prompt to read a command
1346 ;; and it serves as a shorthand for "Extended command: ".
1350 \f
1352 "Default minibuffer history list.
1353 This is used for all minibuffer input
1354 except when an alternate history list is specified.
1356 Maximum length of the history list is determined by the value
1359 "Control whether history list elements are expressions or strings.
1360 If the value of this variable equals current minibuffer depth,
1361 they are expressions; otherwise they are strings.
1362 \(That convention is designed to do the right thing for
1369 "Text that was in this minibuffer before any history commands.
1370 This is nil if there have not yet been any history commands
1379 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1383 "Minibuffer history variables for which matching should ignore case.
1384 If a history variable is a member of this list, then the
1386 commands ignore case when searching it, regardless of `case-fold-search'."
1391 "Find the previous history element that matches REGEXP.
1392 \(Previous history elements refer to earlier actions.)
1393 With prefix argument N, search for Nth previous match.
1394 If N is negative, find the next or Nth next match.
1395 Normally, history elements are matched case-insensitively if
1396 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1397 makes the search case-sensitive.
1398 See also `minibuffer-history-case-insensitive-variables'."
1402 nil
1403 minibuffer-local-map
1404 nil
1405 'minibuffer-history-search-history
1407 ;; Use the last regexp specified, by default, if input is empty.
1412 regexp)
1422 ;; On some systems, ignore case for file names.
1424 minibuffer-history-case-insensitive-variables)
1425 t
1426 ;; Respect the user's setting for case-fold-search:
1427 case-fold-search)
1428 nil))
1429 prevpos
1430 match-string
1431 match-offset
1438 "No later matching history item"
1459 next-matching-history-element))
1463 "Find the next history element that matches REGEXP.
1464 \(The next history element refers to a more recent action.)
1465 With prefix argument N, search for Nth next match.
1466 If N is negative, find the previous or Nth previous match.
1467 Normally, history elements are matched case-insensitively if
1468 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1469 makes the search case-sensitive."
1473 nil
1474 minibuffer-local-map
1475 nil
1476 'minibuffer-history-search-history
1478 ;; Use the last regexp specified, by default, if input is empty.
1483 regexp)
1490 "Function run by `goto-history-element' before consuming default values.
1491 This is useful to dynamically add more elements to the list of default values
1492 when `goto-history-element' reaches the end of this list.
1493 Before calling this function `goto-history-element' sets the variable
1494 `minibuffer-default-add-done' to t, so it will call this function only
1495 once. In special cases, when this function needs to be called more
1496 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1500 "When nil, add more elements to the end of the list of default values.
1501 The value nil causes `goto-history-element' to add more elements to
1502 the list of defaults when it reaches the end of this list. It does
1508 "Return a list of all completions without the default value.
1509 This function is used to add all elements of the completion table to
1510 the end of the list of defaults just after the default value."
1513 minibuffer-completion-table
1514 minibuffer-completion-predicate)))
1520 "Puts element of the minibuffer history in the minibuffer.
1521 The argument NABS specifies the absolute history position."
1535 elt minibuffer-returned-to-present)
1547 previous-history-element))
1559 minibuffer-default)))
1571 elt))
1575 "Puts next element of the minibuffer history in the minibuffer.
1576 With argument N, it uses the Nth following element."
1582 "Puts previous element of the minibuffer history in the minibuffer.
1583 With argument N, it uses the Nth previous element."
1589 "Get next history element which completes the minibuffer before the point.
1590 The contents of the minibuffer after the point are deleted, and replaced
1591 by the new completion."
1597 n)
1598 ;; next-matching-history-element always puts us at (point-min).
1599 ;; Move to the position we were at before changing the buffer contents.
1600 ;; This is still sensible, because the text before point has not changed.
1604 "\
1605 Get previous history element which completes the minibuffer before the point.
1606 The contents of the minibuffer after the point are deleted, and replaced
1607 by the new completion."
1611 ;; For compatibility with the old subr of the same name.
1613 "Return the display width of the minibuffer prompt.
1614 Return 0 if current buffer is not a minibuffer."
1615 ;; Return the width of everything before the field at the end of
1616 ;; the buffer; this should be 0 for normal buffers.
1618 \f
1619 ;; isearch minibuffer history
1626 "Set up a minibuffer for using isearch to search the minibuffer history.
1627 Intended to be added to `minibuffer-setup-hook'."
1639 "Clean up the minibuffer after terminating isearch in the minibuffer."
1644 "Return the proper search function, for isearch in minibuffer history."
1651 ;; Use standard functions to search within minibuffer text
1657 found)
1658 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1659 ;; searching forward. Lazy-highlight calls this lambda with the
1660 ;; bound arg, so skip the minibuffer prompt.
1664 ;; 1. First try searching in the initial minibuffer text
1667 noerror)
1668 ;; 2. If the above search fails, start putting next/prev history
1669 ;; elements in the minibuffer successively, and search the string
1670 ;; in them. Do this only when bound is nil (i.e. not while
1671 ;; lazy-highlighting search strings in the current minibuffer text).
1683 ;; After putting the next/prev history element, search
1684 ;; the string in them again, until next-history-element
1685 ;; or previous-history-element raises an error at the
1686 ;; beginning/end of history.
1689 ;; For backward search, don't search
1690 ;; in the minibuffer prompt
1692 noerror)))
1693 ;; Return point of the new search result
1695 ;; Return nil when next(prev)-history-element fails
1699 "Display the minibuffer history search prompt.
1700 If there are no search errors, this function displays an overlay with
1701 the isearch prompt which replaces the original minibuffer prompt.
1702 Otherwise, it displays the standard isearch message returned from
1703 `isearch-message'."
1705 ;; Use standard function `isearch-message' when not in the minibuffer,
1706 ;; or search fails, or has an error (like incomplete regexp).
1707 ;; This function overwrites minibuffer text with isearch message,
1708 ;; so it's possible to see what is wrong in the search string.
1710 ;; Otherwise, put the overlay with the standard isearch prompt over
1711 ;; the initial minibuffer prompt.
1720 ;; And clear any previous isearch message.
1724 "Wrap the minibuffer history search when search fails.
1725 Move point to the first history element for a forward search,
1726 or to the last history element for a backward search."
1728 ;; When `minibuffer-history-isearch-search' fails on reaching the
1729 ;; beginning/end of the history, wrap the search to the first/last
1730 ;; minibuffer history element.
1738 "Save a function restoring the state of minibuffer history search.
1739 Save `minibuffer-history-position' to the additional state parameter
1740 in the search status stack."
1745 "Restore the minibuffer history search state.
1746 Go to the history element by the absolute history position HIST-POS."
1749 \f
1750 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1754 "Table mapping redo records to the corresponding undo one.
1755 A redo record for undo-in-region maps to t.
1765 "Within a run of consecutive undo commands, list remaining to be undone.
1769 "Undo some previous changes.
1770 Repeat this command to undo more changes.
1771 A numeric ARG serves as a repeat count.
1773 In Transient Mark mode when the mark is active, only undo changes within
1775 as an argument limits undo to changes within the current region."
1777 ;; Make last-command indicate for the next command that this was an undo.
1778 ;; That way, another undo will undo more.
1779 ;; If we get to the end of the undo history and get an error,
1780 ;; another undo command will find the undo history empty
1781 ;; and will get another error. To begin undoing the undos,
1782 ;; you must type some other command.
1785 message)
1786 ;; If we get an error in undo-start,
1787 ;; the next command should not be a "consecutive undo".
1788 ;; So set `this-command' to something other than `undo'.
1793 ;; If something (a timer or filter?) changed the buffer
1794 ;; since the previous command, don't continue the undo seq.
1798 ;; If the last undo record made was made by undo
1799 ;; it shows nothing else happened in between.
1806 ;; get rid of initial undo boundary
1808 ;; If we got this far, the next command should be a consecutive undo.
1810 ;; Check to see whether we're hitting a redo record, and if
1811 ;; so, ask the user whether she wants to skip the redo/undo pair.
1818 ;; The equiv entry might point to another redo record if we have done
1819 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1827 ;; Record the fact that the just-generated undo records come from an
1828 ;; undo operation--that is, they are redo records.
1829 ;; In the ordinary case (not within a region), map the redo
1830 ;; record to the following undos.
1831 ;; I don't know how to do that in the undo-in-region case.
1833 ;; Strip any leading undo boundaries there might be, like we do
1834 ;; above when checking.
1838 undo-equiv-table))
1839 ;; Don't specify a position in the undo record for the undo command.
1840 ;; Instead, undoing this should move point to where the change is.
1859 ;; Record what the current undo list says,
1860 ;; so the next command can tell if the buffer was modified in between.
1863 ;; Display a message announcing success.
1868 "Make BUFFER stop keeping undo information.
1869 No argument or nil as argument means do this for the current buffer."
1875 "Undo some previous changes.
1876 Repeat this command to undo more changes.
1877 A numeric ARG serves as a repeat count.
1878 Contrary to `undo', this will not redo a previous undo."
1883 "Non-nil while performing an undo.
1887 "Undo back N undo-boundaries beyond what was already undone recently.
1888 Call `undo-start' to get ready to undo recent changes,
1889 then call `undo-more' one or more times to undo them."
1894 ;; Note: The following, while pulling elements off
1895 ;; `pending-undo-list' will call primitive change functions which
1896 ;; will push more elements onto `buffer-undo-list'.
1901 ;; Deep copy of a list
1903 "Make a copy of undo list LIST."
1909 elt))
1912 "Set `pending-undo-list' to the front of the undo list.
1913 The next call to `undo-more' will undo the most recently made change.
1914 If BEG and END are specified, then only undo elements
1915 that apply to text between BEG and END are used; other undo elements
1916 are ignored. If BEG and END are nil, all undo elements are used."
1922 buffer-undo-list)))
1927 "Return a list of undo elements for the region START to END.
1928 The elements come from `buffer-undo-list', but we keep only
1929 the elements inside this region, and discard those outside this region.
1930 If we find an element that crosses an edge of this region,
1931 we stop and ignore all further elements."
1934 undo-adjusted-markers
1935 some-rejected
1936 undo-elt temp-undo-list delta)
1941 ;; This is a "was unmodified" element.
1942 ;; Keep it if we have kept everything thus far.
1949 ;; Don't put two nils together in the list
1963 ;; Loop down the earlier events adjusting their buffer
1964 ;; positions to reflect the fact that a change to the buffer
1965 ;; isn't being undone. We only need to process those element
1966 ;; types which undo-elt-in-region will return as being in
1967 ;; the region since only those types can ever get into the
1968 ;; output
1977 ;; (TEXT . POSITION)
1984 ;; (BEGIN . END)
1989 ;; (nil PROPERTY VALUE BEG . END)
1999 "Determine whether UNDO-ELT falls inside the region START ... END.
2000 If it crosses the edge, we return nil."
2005 t)
2007 nil)
2009 ;; (TEXT . POSITION)
2013 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2014 ;; See if MARKER is inside the region.
2025 ;; (nil PROPERTY VALUE BEG . END)
2030 ;; (BEGIN . END)
2035 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2036 This assumes we have already decided that UNDO-ELT
2037 is not *inside* the region START...END."
2040 ;; (nil PROPERTY VALUE BEG . END)
2045 ;; (BEGIN . END)
2049 ;; Return the first affected buffer position and the delta for an undo element
2050 ;; delta is defined as the change in subsequent buffer positions if we *did*
2051 ;; the undo.
2055 ;; (TEXT . POSITION)
2058 ;; (BEGIN . END)
2065 "If non-nil ask about discarding undo info for the current command.
2066 Normally, Emacs discards the undo info for the current command if
2067 it exceeds `undo-outer-limit'. But if you set this option
2068 non-nil, it asks in the echo area whether to discard the info.
2069 If you answer no, there is a slight risk that Emacs might crash, so
2070 only do it if you really want to undo the command.
2072 This option is mainly intended for debugging. You have to be
2073 careful if you use it for other purposes. Garbage collection is
2074 inhibited while the question is asked, meaning that Emacs might
2075 leak memory. So you should make sure that you do not wait
2076 excessively long before answering the question."
2082 "If non-nil, an extra level of size that's ok in an undo item.
2083 We don't ask the user about truncating the undo list until the
2084 current item gets bigger than this amount.
2089 ;; When the first undo batch in an undo list is longer than
2090 ;; undo-outer-limit, this function gets called to warn the user that
2091 ;; the undo info for the current command was discarded. Garbage
2092 ;; collection is inhibited around the call, so it had better not do a
2093 ;; lot of consing.
2099 ;; Don't ask the question again unless it gets even bigger.
2100 ;; This applies, in particular, if the user quits from the question.
2101 ;; Such a quit quits out of GC, but something else will call GC
2102 ;; again momentarily. It will call this function again,
2103 ;; but we don't want to ask the question again.
2110 t)
2111 nil))
2116 "The undo info was discarded because it exceeded \
2117 `undo-outer-limit'.
2119 This is normal if you executed a command that made a huge change
2120 to the buffer. In that case, to prevent similar problems in the
2121 future, set `undo-outer-limit' to a value that is large enough to
2122 cover the maximum size of normal changes you expect a single
2123 command to make, but not so large that it might exceed the
2124 maximum memory allotted to Emacs.
2126 If you did not execute any such command, the situation is
2127 probably due to a bug and you should report it.
2129 You can disable the popping up of this buffer by adding the entry
2130 \(undo discard-info) to the user option `warning-suppress-types',
2134 t))
2135 \f
2137 "History list for some commands that read shell commands.
2139 Maximum length of the history list is determined by the value
2146 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2147 This buffer is used when `shell-command' or `shell-command-on-region'
2148 is run interactively. A value of nil means that output to stderr and
2155 "Return a list of all commands associated with the current file.
2156 This function is used to add all related commands retrieved by `mailcap'
2157 to the end of the list of defaults just after the default value."
2161 minibuffer-default))
2166 commands))
2177 map)
2181 "Read a shell command from the minibuffer.
2182 The arguments are the same as the ones of `read-from-minibuffer',
2183 except READ and KEYMAP are missing and HIST defaults
2184 to `shell-command-history'."
2192 minibuffer-local-shell-command-map
2193 nil
2195 args)))
2198 "Execute string COMMAND asynchronously in background.
2200 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2201 surrounded by whitespace and executes the command asynchronously.
2202 The output appears in the buffer `*Async Shell Command*'.
2204 In Elisp, you will often be better served by calling `start-process'
2205 directly, since it offers more control and does not impose the use of a
2206 shell (with its need to quote arguments)."
2212 current-prefix-arg
2213 shell-command-default-error-buffer))
2219 "Execute string COMMAND in inferior shell; display output, if any.
2220 With prefix argument, insert the COMMAND's output at point.
2222 If COMMAND ends in ampersand, execute it asynchronously.
2223 The output appears in the buffer `*Async Shell Command*'.
2224 That buffer is in shell mode.
2226 Otherwise, COMMAND is executed synchronously. The output appears in
2227 the buffer `*Shell Command Output*'. If the output is short enough to
2228 display in the echo area (which is determined by the variables
2229 `resize-mini-windows' and `max-mini-window-height'), it is shown
2230 there, but it is nonetheless available in buffer `*Shell Command
2231 Output*' even though that buffer is not automatically displayed.
2233 To specify a coding system for converting non-ASCII characters
2235 before this command.
2237 Noninteractive callers can specify coding systems by binding
2238 `coding-system-for-read' and `coding-system-for-write'.
2240 The optional second argument OUTPUT-BUFFER, if non-nil,
2241 says to put the output in some other buffer.
2242 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2243 If OUTPUT-BUFFER is not a buffer and not nil,
2244 insert output in current buffer. (This cannot be done asynchronously.)
2245 In either case, the buffer is first erased, and the output is
2246 inserted after point (leaving mark after it).
2248 If the command terminates without error, but generates output,
2250 the output can be displayed in the echo area or in its buffer.
2251 If the output is short enough to display in the echo area
2252 \(determined by the variable `max-mini-window-height' if
2253 `resize-mini-windows' is non-nil), it is shown there.
2254 Otherwise,the buffer containing the output is displayed.
2258 of the output.
2260 If there is no output, or if output is inserted in the current buffer,
2261 then `*Shell Command Output*' is deleted.
2263 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2264 or buffer name to which to direct the command's standard error output.
2265 If it is nil, error output is mingled with regular output.
2266 In an interactive call, the variable `shell-command-default-error-buffer'
2267 specifies the value of ERROR-BUFFER.
2269 In Elisp, you will often be better served by calling `call-process' or
2270 `start-process' directly, since it offers more control and does not impose
2271 the use of a shell (with its need to quote arguments)."
2282 current-prefix-arg
2283 shell-command-default-error-buffer))
2284 ;; Look for a handler in case default-directory is a remote file name.
2292 ;; Output goes in current buffer.
2298 temporary-file-directory)))
2299 nil)))
2302 ;; We do not use -f for csh; we will not support broken use of
2303 ;; .cshrcs. Even the BSD csh manual says to use
2304 ;; "if ($?prompt) exit" before things which are not useful
2305 ;; non-interactively. Besides, if someone wants their other
2306 ;; aliases for shell commands then they can still have them.
2310 t)
2311 nil shell-command-switch command)
2318 ;; Do no formatting while reading error file,
2319 ;; because that can run a shell command, and we
2320 ;; don't want that to cause an infinite recursion.
2322 ;; Put point after the inserted errors.
2326 ;; This is like exchange-point-and-mark, but doesn't
2327 ;; activate the mark. It is cleaner to avoid activation,
2328 ;; even though the command loop would deactivate the mark
2329 ;; because we inserted text.
2333 ;; Output goes in a separate buffer.
2334 ;; Preserve the match data in case called from a program.
2337 ;; Command ending with ampersand means asynchronous.
2341 proc)
2342 ;; Remove the ampersand.
2344 ;; If will kill a process, query first.
2352 ;; Setting buffer-read-only to nil doesn't suffice
2353 ;; if some text has a non-nil read-only property,
2354 ;; which comint sometimes adds for prompts.
2360 shell-command-switch command))
2364 ;; Use the comint filter for proper handling of carriage motion
2365 ;; (see `comint-inhibit-carriage-motion'),.
2367 ))
2368 ;; Otherwise, command is executed synchronously.
2370 output-buffer nil error-buffer)))))))
2374 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2375 MESSAGE may be either a string or a buffer.
2377 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2378 the maximum height of the echo area, as defined by `max-mini-window-height'
2379 if `resize-mini-windows' is non-nil.
2381 Returns either the string shown in the echo area, or when a pop-up
2382 buffer is used, the window used to display it.
2384 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2385 name of the buffer used to display it in the case where a pop-up buffer
2386 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2387 string and it is displayed in the echo area, it is not specified whether
2388 the contents are inserted into the buffer anyway.
2390 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2391 and only used if a buffer is displayed."
2393 ;; Trivial case where we can use the echo area
2397 ;; Trivial case where we can just remove single trailing newline
2400 ;; General case
2403 message
2412 0
2416 (<= lines
2420 max-mini-window-height))
2422 max-mini-window-height)
2426 ;; Don't use the echo area if the output buffer is
2427 ;; already displayed in the selected frame.
2429 ;; Echo area
2435 ;; Buffer
2438 not-this-window frame))))))))
2441 ;; We have a sentinel to prevent insertion of a termination message
2442 ;; in the buffer itself.
2450 &optional output-buffer replace
2451 error-buffer display-error-buffer)
2452 "Execute string COMMAND in inferior shell with region as input.
2453 Normally display output (if any) in temp buffer `*Shell Command Output*';
2454 Prefix arg means replace the region with it. Return the exit code of
2455 COMMAND.
2457 To specify a coding system for converting non-ASCII characters
2459 before this command. By default, the input (from the current buffer)
2460 is encoded in the same coding system that will be used to save the file,
2461 `buffer-file-coding-system'. If the output is going to replace the region,
2462 then it is decoded from that same coding system.
2464 The noninteractive arguments are START, END, COMMAND,
2465 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2466 Noninteractive callers can specify coding systems by binding
2467 `coding-system-for-read' and `coding-system-for-write'.
2469 If the command generates output, the output may be displayed
2470 in the echo area or in a buffer.
2471 If the output is short enough to display in the echo area
2472 \(determined by the variable `max-mini-window-height' if
2473 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2474 it is displayed in the buffer `*Shell Command Output*'. The output
2475 is available in that buffer in both cases.
2477 If there is output and an error, a message about the error
2478 appears at the end of the output.
2480 If there is no output, or if output is inserted in the current buffer,
2481 then `*Shell Command Output*' is deleted.
2483 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2484 that says to put the output in some other buffer.
2485 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2486 If OUTPUT-BUFFER is not a buffer and not nil,
2487 insert output in the current buffer.
2488 In either case, the output is inserted after point (leaving mark after it).
2490 If REPLACE, the optional fifth argument, is non-nil, that means insert
2491 the output in place of text from START to END, putting point and mark
2492 around it.
2494 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2495 or buffer name to which to direct the command's standard error output.
2496 If it is nil, error output is mingled with regular output.
2497 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2498 were any errors. (This is always t, interactively.)
2499 In an interactive call, the variable `shell-command-default-error-buffer'
2500 specifies the value of ERROR-BUFFER."
2504 ;; Do this before calling region-beginning
2505 ;; and region-end, in case subprocess output
2506 ;; relocates them while we are in the minibuffer.
2508 ;; call-interactively recognizes region-beginning and
2509 ;; region-end specially, leaving them in the history.
2511 string
2512 current-prefix-arg
2513 current-prefix-arg
2514 shell-command-default-error-buffer
2515 t)))
2521 temporary-file-directory)))
2522 nil))
2523 exit-status)
2527 ;; Replace specified region with output from command.
2529 ;; Don't muck with mark unless REPLACE says we should.
2536 t)
2537 nil shell-command-switch command))
2538 ;; It is rude to delete a buffer which the command is not using.
2539 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2540 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2541 ;; (kill-buffer shell-buffer)))
2542 ;; Don't muck with mark unless REPLACE says we should.
2544 ;; No prefix argument: put the output in a temp buffer,
2545 ;; replacing its entire contents.
2550 ;; If the input is the same buffer as the output,
2551 ;; delete everything but the specified region,
2552 ;; then replace that region with the output.
2558 shell-file-name t
2561 t)
2562 nil shell-command-switch
2563 command)))
2564 ;; Clear the output buffer, then run the command with
2565 ;; output there.
2576 buffer)
2577 nil shell-command-switch command)))
2578 ;; Report the output.
2588 ;; There's some output, display it
2590 ;; No output; error?
2597 shell-command-default-error-buffer)
2604 output))
2607 exit-status))
2610 exit-status output))))
2611 ;; Don't kill: there might be useful info in the undo-log.
2612 ;; (kill-buffer buffer)
2613 ))))
2621 ;; Do no formatting while reading error file,
2622 ;; because that can run a shell command, and we
2623 ;; don't want that to cause an infinite recursion.
2625 ;; Put point after the inserted errors.
2630 exit-status))
2633 "Execute shell command COMMAND and return its output as a string."
2636 standard-output
2640 "Process files synchronously in a separate process.
2641 Similar to `call-process', but may invoke a file handler based on
2642 `default-directory'. The current working directory of the
2643 subprocess is `default-directory'.
2645 File names in INFILE and BUFFER are handled normally, but file
2646 names in ARGS should be relative to `default-directory', as they
2647 are passed to the process verbatim. \(This is a difference to
2648 `call-process' which does not support file handlers for INFILE
2649 and BUFFER.\)
2651 Some file handlers might not support all variants, for example
2652 they might behave as if DISPLAY was nil, regardless of the actual
2653 value passed."
2655 lc stderr-file)
2665 display args)
2671 "Whether a call of `process-file' changes remote files.
2673 Per default, this variable is always set to `t', meaning that a
2674 call of `process-file' could potentially change any file on a
2675 remote host. When set to `nil', a file handler could optimize
2676 its behavior with respect to remote file attributes caching.
2678 This variable should never be changed by `setq'. Instead of, it
2682 "Start a program in a subprocess. Return the process object for it.
2684 Similar to `start-process', but may invoke a file handler based on
2685 `default-directory'. See Info node `(elisp)Magic File Names'.
2687 This handler ought to run PROGRAM, perhaps on the local host,
2688 perhaps on a remote host that corresponds to `default-directory'.
2689 In the latter case, the local part of `default-directory' becomes
2690 the working directory of the process.
2692 PROGRAM and PROGRAM-ARGS might be file names. They are not
2693 objects of file handler invocation. File handlers might not
2694 support pty association, if PROGRAM is nil."
2698 \f
2699 ;;;; Process menu
2711 "Major mode for listing the processes called by Emacs."
2723 "Recompute the list of processes for the Process List buffer.
2724 Also, delete any process that is exited or signaled."
2737 face link
2740 follow-link t
2741 process-buffer ,buf
2742 action process-menu-visit-buffer)
2751 "datagram"
2766 tabulated-list-entries))))))
2772 "Display a list of all processes.
2773 If optional argument QUERY-ONLY is non-nil, only processes with
2774 the query-on-exit flag set are listed.
2775 Any process listed as exited or signaled is actually eliminated
2776 after the listing is made.
2777 Optional argument BUFFER specifies a buffer to use, instead of
2779 The return value is always nil."
2791 nil)
2792 \f
2796 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2797 (define-key map [switch-frame] nil)
2798 (define-key map [?\C-u] 'universal-argument-more)
2799 (define-key map [?-] 'universal-argument-minus)
2800 (define-key map [?0] 'digit-argument)
2801 (define-key map [?1] 'digit-argument)
2802 (define-key map [?2] 'digit-argument)
2803 (define-key map [?3] 'digit-argument)
2804 (define-key map [?4] 'digit-argument)
2805 (define-key map [?5] 'digit-argument)
2806 (define-key map [?6] 'digit-argument)
2807 (define-key map [?7] 'digit-argument)
2808 (define-key map [?8] 'digit-argument)
2809 (define-key map [?9] 'digit-argument)
2810 (define-key map [kp-0] 'digit-argument)
2811 (define-key map [kp-1] 'digit-argument)
2812 (define-key map [kp-2] 'digit-argument)
2813 (define-key map [kp-3] 'digit-argument)
2814 (define-key map [kp-4] 'digit-argument)
2815 (define-key map [kp-5] 'digit-argument)
2816 (define-key map [kp-6] 'digit-argument)
2817 (define-key map [kp-7] 'digit-argument)
2818 (define-key map [kp-8] 'digit-argument)
2819 (define-key map [kp-9] 'digit-argument)
2820 (define-key map [kp-subtract] 'universal-argument-minus)
2821 map)
2824 (defvar universal-argument-num-events nil
2825 "Number of argument-specifying events read by `universal-argument'.
2826 `universal-argument-other-key' uses this to discard those events
2827 from (this-command-keys), and reread only the final command.")
2829 (defvar saved-overriding-map t
2830 "The saved value of `overriding-terminal-local-map'.
2834 (defun save&set-overriding-map (map)
2835 "Set `overriding-terminal-local-map' to MAP."
2836 (when (eq saved-overriding-map t)
2837 (setq saved-overriding-map overriding-terminal-local-map)
2838 (setq overriding-terminal-local-map map)))
2840 (defun restore-overriding-map ()
2841 "Restore `overriding-terminal-local-map' to its saved value."
2842 (setq overriding-terminal-local-map saved-overriding-map)
2843 (setq saved-overriding-map t))
2845 (defun universal-argument ()
2846 "Begin a numeric argument for the following command.
2851 multiplies the argument by 4 each time.
2853 which is different in effect from any particular numeric argument.
2855 (interactive)
2856 (setq prefix-arg (list 4))
2857 (setq universal-argument-num-events (length (this-command-keys)))
2858 (save&set-overriding-map universal-argument-map))
2860 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2861 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2862 (defun universal-argument-more (arg)
2863 (interactive "P")
2864 (if (consp arg)
2865 (setq prefix-arg (list (* 4 (car arg))))
2866 (if (eq arg '-)
2867 (setq prefix-arg (list -4))
2868 (setq prefix-arg arg)
2869 (restore-overriding-map)))
2870 (setq universal-argument-num-events (length (this-command-keys))))
2872 (defun negative-argument (arg)
2873 "Begin a negative numeric argument for the next command.
2875 (interactive "P")
2876 (cond ((integerp arg)
2877 (setq prefix-arg (- arg)))
2878 ((eq arg '-)
2879 (setq prefix-arg nil))
2880 (t
2881 (setq prefix-arg '-)))
2882 (setq universal-argument-num-events (length (this-command-keys)))
2883 (save&set-overriding-map universal-argument-map))
2885 (defun digit-argument (arg)
2886 "Part of the numeric argument for the next command.
2888 (interactive "P")
2889 (let* ((char (if (integerp last-command-event)
2890 last-command-event
2891 (get last-command-event 'ascii-character)))
2893 (cond ((integerp arg)
2894 (setq prefix-arg (+ (* arg 10)
2895 (if (< arg 0) (- digit) digit))))
2896 ((eq arg '-)
2897 ;; Treat -0 as just -, so that -01 will work.
2898 (setq prefix-arg (if (zerop digit) '- (- digit))))
2899 (t
2900 (setq prefix-arg digit))))
2901 (setq universal-argument-num-events (length (this-command-keys)))
2902 (save&set-overriding-map universal-argument-map))
2904 ;; For backward compatibility, minus with no modifiers is an ordinary
2905 ;; command if digits have already been entered.
2906 (defun universal-argument-minus (arg)
2907 (interactive "P")
2908 (if (integerp arg)
2909 (universal-argument-other-key arg)
2910 (negative-argument arg)))
2912 ;; Anything else terminates the argument and is left in the queue to be
2913 ;; executed as a command.
2914 (defun universal-argument-other-key (arg)
2915 (interactive "P")
2916 (setq prefix-arg arg)
2917 (let* ((key (this-command-keys))
2918 (keylist (listify-key-sequence key)))
2919 (setq unread-command-events
2920 (append (nthcdr universal-argument-num-events keylist)
2921 unread-command-events)))
2922 (reset-this-command-lengths)
2923 (restore-overriding-map))
2924 \f
2926 (defvar filter-buffer-substring-functions nil
2927 "This variable is a wrapper hook around `filter-buffer-substring'.
2928 Each member of the hook should be a function accepting four arguments:
2929 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
2930 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
2931 as those of `filter-buffer-substring' in each case.
2933 The first hook function to be called receives a FUN equivalent
2934 to the default operation of `filter-buffer-substring',
2935 i.e. one that returns the buffer-substring between BEG and
2936 END (processed by any `buffer-substring-filters'). Normally,
2937 the hook function will call FUN and then do its own processing
2938 of the result. The next hook function receives a FUN equivalent
2939 to the previous hook function, calls it, and does its own
2940 processing, and so on. The overall result is that of all hook
2941 functions acting in sequence.
2943 Any hook may choose not to call FUN though, in which case it
2944 effectively replaces the default behavior with whatever it chooses.
2945 Of course, a later hook function may do the same thing.")
2947 (defvar buffer-substring-filters nil
2948 "List of filter functions for `filter-buffer-substring'.
2949 Each function must accept a single argument, a string, and return
2950 a string. The buffer substring is passed to the first function
2951 in the list, and the return value of each function is passed to
2952 the next. The final result (if `buffer-substring-filters' is
2953 nil, this is the unfiltered buffer-substring) is passed to the
2954 first function on `filter-buffer-substring-functions'.
2956 As a special convention, point is set to the start of the buffer text
2957 being operated on (i.e., the first argument of `filter-buffer-substring')
2958 before these functions are called.")
2959 (make-obsolete-variable 'buffer-substring-filters
2960 'filter-buffer-substring-functions "24.1")
2962 (defun filter-buffer-substring (beg end &optional delete)
2963 "Return the buffer substring between BEG and END, after filtering.
2964 The wrapper hook `filter-buffer-substring-functions' performs
2965 the actual filtering. The obsolete variable `buffer-substring-filters'
2966 is also consulted. If both of these are nil, no filtering is done.
2968 If DELETE is non-nil, the text between BEG and END is deleted
2969 from the buffer.
2971 This function should be used instead of `buffer-substring',
2972 `buffer-substring-no-properties', or `delete-and-extract-region'
2973 when you want to allow filtering to take place. For example,
2974 major or minor modes can use `filter-buffer-substring-functions' to
2975 extract characters that are special to a buffer, and should not
2976 be copied into other buffers."
2977 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2978 (cond
2979 ((or delete buffer-substring-filters)
2980 (save-excursion
2981 (goto-char beg)
2982 (let ((string (if delete (delete-and-extract-region beg end)
2983 (buffer-substring beg end))))
2984 (dolist (filter buffer-substring-filters)
2985 (setq string (funcall filter string)))
2986 string)))
2987 (t
2988 (buffer-substring beg end)))))
2991 ;;;; Window system cut and paste hooks.
2993 (defvar interprogram-cut-function nil
2994 "Function to call to make a killed region available to other programs.
2996 Most window systems provide some sort of facility for cutting and
2997 pasting text between the windows of different programs.
2998 This variable holds a function that Emacs calls whenever text
2999 is put in the kill ring, to make the new kill available to other
3000 programs.
3002 The function takes one argument, TEXT, which is a string containing
3003 the text which should be made available.")
3005 (defvar interprogram-paste-function nil
3006 "Function to call to get text cut from other programs.
3008 Most window systems provide some sort of facility for cutting and
3009 pasting text between the windows of different programs.
3010 This variable holds a function that Emacs calls to obtain
3011 text that other programs have provided for pasting.
3013 The function should be called with no arguments. If the function
3014 returns nil, then no other program has provided such text, and the top
3015 of the Emacs kill ring should be used. If the function returns a
3016 string, then the caller of the function \(usually `current-kill')
3017 should put this string in the kill ring as the latest kill.
3019 This function may also return a list of strings if the window
3020 system supports multiple selections. The first string will be
3021 used as the pasted text, but the other will be placed in the
3022 kill ring for easy access via `yank-pop'.
3024 Note that the function should return a string only if a program other
3025 than Emacs has provided a string for pasting; if Emacs provided the
3026 most recent string, the function should return nil. If it is
3027 difficult to tell whether Emacs or some other program provided the
3028 current string, it is probably good enough to return nil if the string
3029 is equal (according to `string=') to the last text Emacs provided.")
3030 \f
3033 ;;;; The kill ring data structure.
3035 (defvar kill-ring nil
3036 "List of killed text sequences.
3037 Since the kill ring is supposed to interact nicely with cut-and-paste
3038 facilities offered by window systems, use of this variable should
3039 interact nicely with `interprogram-cut-function' and
3040 `interprogram-paste-function'. The functions `kill-new',
3041 `kill-append', and `current-kill' are supposed to implement this
3042 interaction; you may want to use them instead of manipulating the kill
3043 ring directly.")
3045 (defcustom kill-ring-max 60
3046 "Maximum length of kill ring before oldest elements are thrown away."
3047 :type 'integer
3048 :group 'killing)
3050 (defvar kill-ring-yank-pointer nil
3051 "The tail of the kill ring whose car is the last thing yanked.")
3053 (defcustom save-interprogram-paste-before-kill nil
3054 "Save clipboard strings into kill ring before replacing them.
3055 When one selects something in another program to paste it into Emacs,
3056 but kills something in Emacs before actually pasting it,
3057 this selection is gone unless this variable is non-nil,
3058 in which case the other program's selection is saved in the `kill-ring'
3060 :type 'boolean
3061 :group 'killing
3062 :version "23.2")
3064 (defcustom kill-do-not-save-duplicates nil
3065 "Do not add a new string to `kill-ring' when it is the same as the last one."
3066 :type 'boolean
3067 :group 'killing
3068 :version "23.2")
3070 (defun kill-new (string &optional replace yank-handler)
3071 "Make STRING the latest kill in the kill ring.
3072 Set `kill-ring-yank-pointer' to point to it.
3073 If `interprogram-cut-function' is non-nil, apply it to STRING.
3074 Optional second argument REPLACE non-nil means that STRING will replace
3075 the front of the kill ring, rather than being added to the list.
3077 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3078 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3079 STRING.
3081 When the yank handler has a non-nil PARAM element, the original STRING
3082 argument is not used by `insert-for-yank'. However, since Lisp code
3083 may access and use elements from the kill ring directly, the STRING
3085 (if (> (length string) 0)
3086 (if yank-handler
3087 (put-text-property 0 (length string)
3088 'yank-handler yank-handler string))
3089 (if yank-handler
3090 (signal 'args-out-of-range
3091 (list string "yank-handler specified for empty string"))))
3092 (unless (and kill-do-not-save-duplicates
3093 (equal string (car kill-ring)))
3094 (if (fboundp 'menu-bar-update-yank-menu)
3095 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3096 (when save-interprogram-paste-before-kill
3097 (let ((interprogram-paste (and interprogram-paste-function
3098 (funcall interprogram-paste-function))))
3099 (when interprogram-paste
3100 (dolist (s (if (listp interprogram-paste)
3101 (nreverse interprogram-paste)
3102 (list interprogram-paste)))
3103 (unless (and kill-do-not-save-duplicates
3104 (equal s (car kill-ring)))
3105 (push s kill-ring))))))
3106 (unless (and kill-do-not-save-duplicates
3107 (equal string (car kill-ring)))
3108 (if (and replace kill-ring)
3109 (setcar kill-ring string)
3110 (push string kill-ring)
3111 (if (> (length kill-ring) kill-ring-max)
3112 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3113 (setq kill-ring-yank-pointer kill-ring)
3114 (if interprogram-cut-function
3115 (funcall interprogram-cut-function string)))
3116 (set-advertised-calling-convention
3117 'kill-new '(string &optional replace) "23.3")
3119 (defun kill-append (string before-p &optional yank-handler)
3120 "Append STRING to the end of the latest kill in the kill ring.
3121 If BEFORE-P is non-nil, prepend STRING to the kill.
3122 If `interprogram-cut-function' is set, pass the resulting kill to it."
3123 (let* ((cur (car kill-ring)))
3124 (kill-new (if before-p (concat string cur) (concat cur string))
3125 (or (= (length cur) 0)
3126 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3127 yank-handler)))
3128 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3130 (defcustom yank-pop-change-selection nil
3131 "If non-nil, rotating the kill ring changes the window system selection."
3132 :type 'boolean
3133 :group 'killing
3134 :version "23.1")
3136 (defun current-kill (n &optional do-not-move)
3137 "Rotate the yanking point by N places, and then return that kill.
3138 If N is zero and `interprogram-paste-function' is set to a
3139 function that returns a string or a list of strings, and if that
3140 function doesn't return nil, then that string (or list) is added
3141 to the front of the kill ring and the string (or first string in
3142 the list) is returned as the latest kill.
3144 If N is not zero, and if `yank-pop-change-selection' is
3145 non-nil, use `interprogram-cut-function' to transfer the
3146 kill at the new yank point into the window system selection.
3148 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3149 move the yanking point; just return the Nth kill forward."
3151 (let ((interprogram-paste (and (= n 0)
3152 interprogram-paste-function
3153 (funcall interprogram-paste-function))))
3154 (if interprogram-paste
3155 (progn
3156 ;; Disable the interprogram cut function when we add the new
3157 ;; text to the kill ring, so Emacs doesn't try to own the
3158 ;; selection, with identical text.
3159 (let ((interprogram-cut-function nil))
3160 (if (listp interprogram-paste)
3161 (mapc 'kill-new (nreverse interprogram-paste))
3162 (kill-new interprogram-paste)))
3163 (car kill-ring))
3164 (or kill-ring (error "Kill ring is empty"))
3165 (let ((ARGth-kill-element
3166 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3167 (length kill-ring))
3168 kill-ring)))
3169 (unless do-not-move
3170 (setq kill-ring-yank-pointer ARGth-kill-element)
3171 (when (and yank-pop-change-selection
3172 (> n 0)
3173 interprogram-cut-function)
3174 (funcall interprogram-cut-function (car ARGth-kill-element))))
3175 (car ARGth-kill-element)))))
3179 ;;;; Commands for manipulating the kill ring.
3181 (defcustom kill-read-only-ok nil
3182 "Non-nil means don't signal an error for killing read-only text."
3183 :type 'boolean
3184 :group 'killing)
3186 (put 'text-read-only 'error-conditions
3187 '(text-read-only buffer-read-only error))
3188 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3190 (defun kill-region (beg end &optional yank-handler)
3192 This deletes the text from the buffer and saves it in the kill ring.
3196 If you want to append the killed region to the last killed text,
3199 If the buffer is read-only, Emacs will beep and refrain from deleting
3200 the text, but put the text in the kill ring anyway. This means that
3201 you can use the killing commands to copy text from a read-only buffer.
3203 Lisp programs should use this function for killing text.
3204 (To delete text, use `delete-region'.)
3205 Supply two arguments, character positions indicating the stretch of text
3206 to be killed.
3208 If the previous command was also a kill command,
3209 the text killed this time appends to the text killed last time
3210 to make one entry in the kill ring."
3211 ;; Pass point first, then mark, because the order matters
3212 ;; when calling kill-append.
3213 (interactive (list (point) (mark)))
3214 (unless (and beg end)
3215 (error "The mark is not set now, so there is no region"))
3216 (condition-case nil
3217 (let ((string (filter-buffer-substring beg end t)))
3218 (when string ;STRING is nil if BEG = END
3219 ;; Add that string to the kill ring, one way or another.
3220 (if (eq last-command 'kill-region)
3221 (kill-append string (< end beg) yank-handler)
3222 (kill-new string nil yank-handler)))
3223 (when (or string (eq last-command 'kill-region))
3224 (setq this-command 'kill-region))
3225 nil)
3226 ((buffer-read-only text-read-only)
3227 ;; The code above failed because the buffer, or some of the characters
3228 ;; in the region, are read-only.
3229 ;; We should beep, in case the user just isn't aware of this.
3230 ;; However, there's no harm in putting
3231 ;; the region's text in the kill ring, anyway.
3232 (copy-region-as-kill beg end)
3233 ;; Set this-command now, so it will be set even if we get an error.
3234 (setq this-command 'kill-region)
3235 ;; This should barf, if appropriate, and give us the correct error.
3236 (if kill-read-only-ok
3237 (progn (message "Read only text copied to kill ring") nil)
3238 ;; Signal an error if the buffer is read-only.
3239 (barf-if-buffer-read-only)
3240 ;; If the buffer isn't read-only, the text is.
3241 (signal 'text-read-only (list (current-buffer)))))))
3242 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3244 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3245 ;; to get two copies of the text when the user accidentally types M-w and
3246 ;; then corrects it with the intended C-w.
3247 (defun copy-region-as-kill (beg end)
3248 "Save the region as if killed, but don't kill it.
3249 In Transient Mark mode, deactivate the mark.
3250 If `interprogram-cut-function' is non-nil, also save the text for a window
3251 system cut and paste.
3253 This command's old key binding has been given to `kill-ring-save'."
3254 (interactive "r")
3255 (if (eq last-command 'kill-region)
3256 (kill-append (filter-buffer-substring beg end) (< end beg))
3257 (kill-new (filter-buffer-substring beg end)))
3258 (setq deactivate-mark t)
3259 nil)
3261 (defun kill-ring-save (beg end)
3262 "Save the region as if killed, but don't kill it.
3263 In Transient Mark mode, deactivate the mark.
3264 If `interprogram-cut-function' is non-nil, also save the text for a window
3265 system cut and paste.
3267 If you want to append the killed line to the last killed text,
3270 This command is similar to `copy-region-as-kill', except that it gives
3271 visual feedback indicating the extent of the region being copied."
3272 (interactive "r")
3273 (copy-region-as-kill beg end)
3274 ;; This use of called-interactively-p is correct
3275 ;; because the code it controls just gives the user visual feedback.
3276 (if (called-interactively-p 'interactive)
3277 (let ((other-end (if (= (point) beg) end beg))
3278 (opoint (point))
3279 ;; Inhibit quitting so we can make a quit here
3280 ;; look like a C-g typed as a command.
3281 (inhibit-quit t))
3282 (if (pos-visible-in-window-p other-end (selected-window))
3283 ;; Swap point-and-mark quickly so as to show the region that
3284 ;; was selected. Don't do it if the region is highlighted.
3285 (unless (and (region-active-p)
3286 (face-background 'region))
3287 ;; Swap point and mark.
3288 (set-marker (mark-marker) (point) (current-buffer))
3289 (goto-char other-end)
3290 (sit-for blink-matching-delay)
3291 ;; Swap back.
3292 (set-marker (mark-marker) other-end (current-buffer))
3293 (goto-char opoint)
3294 ;; If user quit, deactivate the mark
3295 ;; as C-g would as a command.
3296 (and quit-flag mark-active
3297 (deactivate-mark)))
3298 (let* ((killed-text (current-kill 0))
3299 (message-len (min (length killed-text) 40)))
3300 (if (= (point) beg)
3301 ;; Don't say "killed"; that is misleading.
3303 (substring killed-text (- message-len)))
3305 (substring killed-text 0 message-len))))))))
3307 (defun append-next-kill (&optional interactive)
3308 "Cause following command, if it kills, to append to previous kill.
3309 The argument is used for internal purposes; do not supply one."
3310 (interactive "p")
3311 ;; We don't use (interactive-p), since that breaks kbd macros.
3312 (if interactive
3313 (progn
3314 (setq this-command 'kill-region)
3315 (message "If the next command is a kill, it will append"))
3316 (setq last-command 'kill-region)))
3317 \f
3318 ;; Yanking.
3320 ;; This is actually used in subr.el but defcustom does not work there.
3321 (defcustom yank-excluded-properties
3322 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3323 yank-handler follow-link fontified)
3324 "Text properties to discard when yanking.
3325 The value should be a list of text properties to discard or t,
3326 which means to discard all text properties."
3327 :type '(choice (const :tag "All" t) (repeat symbol))
3328 :group 'killing
3329 :version "22.1")
3331 (defvar yank-window-start nil)
3332 (defvar yank-undo-function nil
3333 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3334 Function is called with two parameters, START and END corresponding to
3335 the value of the mark and point; it is guaranteed that START <= END.
3336 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3338 (defun yank-pop (&optional arg)
3339 "Replace just-yanked stretch of killed text with a different stretch.
3340 This command is allowed only immediately after a `yank' or a `yank-pop'.
3341 At such a time, the region contains a stretch of reinserted
3342 previously-killed text. `yank-pop' deletes that text and inserts in its
3343 place a different stretch of killed text.
3345 With no argument, the previous kill is inserted.
3346 With argument N, insert the Nth previous kill.
3347 If N is negative, this is a more recent kill.
3349 The sequence of kills wraps around, so that after the oldest one
3350 comes the newest one.
3352 When this command inserts killed text into the buffer, it honors
3353 `yank-excluded-properties' and `yank-handler' as described in the
3354 doc string for `insert-for-yank-1', which see."
3355 (interactive "*p")
3356 (if (not (eq last-command 'yank))
3357 (error "Previous command was not a yank"))
3358 (setq this-command 'yank)
3359 (unless arg (setq arg 1))
3360 (let ((inhibit-read-only t)
3361 (before (< (point) (mark t))))
3362 (if before
3363 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3364 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3365 (setq yank-undo-function nil)
3366 (set-marker (mark-marker) (point) (current-buffer))
3367 (insert-for-yank (current-kill arg))
3368 ;; Set the window start back where it was in the yank command,
3369 ;; if possible.
3370 (set-window-start (selected-window) yank-window-start t)
3371 (if before
3372 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3373 ;; It is cleaner to avoid activation, even though the command
3374 ;; loop would deactivate the mark because we inserted text.
3375 (goto-char (prog1 (mark t)
3376 (set-marker (mark-marker) (point) (current-buffer))))))
3377 nil)
3379 (defun yank (&optional arg)
3381 More precisely, reinsert the stretch of killed text most recently
3382 killed OR yanked. Put point at end, and set mark at beginning.
3383 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3384 With argument N, reinsert the Nth most recently killed stretch of killed
3385 text.
3387 When this command inserts killed text into the buffer, it honors
3388 `yank-excluded-properties' and `yank-handler' as described in the
3389 doc string for `insert-for-yank-1', which see.
3392 (interactive "*P")
3393 (setq yank-window-start (window-start))
3394 ;; If we don't get all the way thru, make last-command indicate that
3395 ;; for the following command.
3396 (setq this-command t)
3397 (push-mark (point))
3398 (insert-for-yank (current-kill (cond
3399 ((listp arg) 0)
3400 ((eq arg '-) -2)
3401 (t (1- arg)))))
3402 (if (consp arg)
3403 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3404 ;; It is cleaner to avoid activation, even though the command
3405 ;; loop would deactivate the mark because we inserted text.
3406 (goto-char (prog1 (mark t)
3407 (set-marker (mark-marker) (point) (current-buffer)))))
3408 ;; If we do get all the way thru, make this-command indicate that.
3409 (if (eq this-command t)
3410 (setq this-command 'yank))
3411 nil)
3413 (defun rotate-yank-pointer (arg)
3414 "Rotate the yanking point in the kill ring.
3415 With ARG, rotate that many kills forward (or backward, if negative)."
3416 (interactive "p")
3417 (current-kill arg))
3418 \f
3419 ;; Some kill commands.
3421 ;; Internal subroutine of delete-char
3422 (defun kill-forward-chars (arg)
3423 (if (listp arg) (setq arg (car arg)))
3424 (if (eq arg '-) (setq arg -1))
3425 (kill-region (point) (+ (point) arg)))
3427 ;; Internal subroutine of backward-delete-char
3428 (defun kill-backward-chars (arg)
3429 (if (listp arg) (setq arg (car arg)))
3430 (if (eq arg '-) (setq arg -1))
3431 (kill-region (point) (- (point) arg)))
3433 (defcustom backward-delete-char-untabify-method 'untabify
3434 "The method for untabifying when deleting backward.
3435 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3436 `hungry' -- delete all whitespace, both tabs and spaces;
3437 `all' -- delete all whitespace, including tabs, spaces and newlines;
3438 nil -- just delete one character."
3439 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3440 :version "20.3"
3441 :group 'killing)
3443 (defun backward-delete-char-untabify (arg &optional killp)
3444 "Delete characters backward, changing tabs into spaces.
3445 The exact behavior depends on `backward-delete-char-untabify-method'.
3446 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3447 Interactively, ARG is the prefix arg (default 1)
3448 and KILLP is t if a prefix arg was specified."
3450 (when (eq backward-delete-char-untabify-method 'untabify)
3451 (let ((count arg))
3452 (save-excursion
3453 (while (and (> count 0) (not (bobp)))
3455 (let ((col (current-column)))
3456 (forward-char -1)
3457 (setq col (- col (current-column)))
3458 (insert-char ?\s col)
3459 (delete-char 1)))
3460 (forward-char -1)
3461 (setq count (1- count))))))
3463 ((eq backward-delete-char-untabify-method 'all)
3465 (n (if skip
3466 (let* ((oldpt (point))
3467 (wh (- oldpt (save-excursion
3468 (skip-chars-backward skip)
3469 (constrain-to-field nil oldpt)))))
3470 (+ arg (if (zerop wh) 0 (1- wh))))
3471 arg)))
3472 ;; Avoid warning about delete-backward-char
3473 (with-no-warnings (delete-backward-char n killp))))
3475 (defun zap-to-char (arg char)
3476 "Kill up to and including ARGth occurrence of CHAR.
3477 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3478 Goes backward if ARG is negative; error if CHAR not found."
3480 ;; Avoid "obsolete" warnings for translation-table-for-input.
3481 (with-no-warnings
3482 (if (char-table-p translation-table-for-input)
3483 (setq char (or (aref translation-table-for-input char) char))))
3484 (kill-region (point) (progn
3485 (search-forward (char-to-string char) nil nil arg)
3486 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3487 (point))))
3489 ;; kill-line and its subroutines.
3491 (defcustom kill-whole-line nil
3492 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3493 :type 'boolean
3494 :group 'killing)
3496 (defun kill-line (&optional arg)
3497 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3498 With prefix argument ARG, kill that many lines from point.
3499 Negative arguments kill lines backward.
3500 With zero argument, kills the text before point on the current line.
3503 a number counts as a prefix arg.
3505 To kill a whole line, when point is not at the beginning, type \
3508 If `show-trailing-whitespace' is non-nil, this command will just
3509 kill the rest of the current line, even if there are only
3510 nonblanks there.
3512 If `kill-whole-line' is non-nil, then this command kills the whole line
3513 including its terminating newline, when used at the beginning of a line
3514 with no argument. As a consequence, you can always kill a whole line
3517 If you want to append the killed line to the last killed text,
3520 If the buffer is read-only, Emacs will beep and refrain from deleting
3521 the line, but put the line in the kill ring anyway. This means that
3522 you can use this command to copy text from a read-only buffer.
3523 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3524 even beep.)"
3525 (interactive "P")
3526 (kill-region (point)
3527 ;; It is better to move point to the other end of the kill
3528 ;; before killing. That way, in a read-only buffer, point
3529 ;; moves across the text that is copied to the kill ring.
3530 ;; The choice has no effect on undo now that undo records
3531 ;; the value of point from before the command was run.
3532 (progn
3533 (if arg
3534 (forward-visible-line (prefix-numeric-value arg))
3535 (if (eobp)
3536 (signal 'end-of-buffer nil))
3537 (let ((end
3538 (save-excursion
3539 (end-of-visible-line) (point))))
3540 (if (or (save-excursion
3541 ;; If trailing whitespace is visible,
3542 ;; don't treat it as nothing.
3543 (unless show-trailing-whitespace
3545 (= (point) end))
3546 (and kill-whole-line (bolp)))
3547 (forward-visible-line 1)
3548 (goto-char end))))
3549 (point))))
3551 (defun kill-whole-line (&optional arg)
3552 "Kill current line.
3553 With prefix ARG, kill that many lines starting from the current line.
3554 If ARG is negative, kill backward. Also kill the preceding newline.
3556 If ARG is zero, kill current line but exclude the trailing newline."
3557 (interactive "p")
3558 (or arg (setq arg 1))
3559 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3560 (signal 'end-of-buffer nil))
3561 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3562 (signal 'beginning-of-buffer nil))
3563 (unless (eq last-command 'kill-region)
3564 (kill-new "")
3565 (setq last-command 'kill-region))
3566 (cond ((zerop arg)
3567 ;; We need to kill in two steps, because the previous command
3568 ;; could have been a kill command, in which case the text
3569 ;; before point needs to be prepended to the current kill
3570 ;; ring entry and the text after point appended. Also, we
3571 ;; need to use save-excursion to avoid copying the same text
3572 ;; twice to the kill ring in read-only buffers.
3573 (save-excursion
3574 (kill-region (point) (progn (forward-visible-line 0) (point))))
3575 (kill-region (point) (progn (end-of-visible-line) (point))))
3576 ((< arg 0)
3577 (save-excursion
3578 (kill-region (point) (progn (end-of-visible-line) (point))))
3579 (kill-region (point)
3580 (progn (forward-visible-line (1+ arg))
3581 (unless (bobp) (backward-char))
3582 (point))))
3583 (t
3584 (save-excursion
3585 (kill-region (point) (progn (forward-visible-line 0) (point))))
3586 (kill-region (point)
3587 (progn (forward-visible-line arg) (point))))))
3589 (defun forward-visible-line (arg)
3590 "Move forward by ARG lines, ignoring currently invisible newlines only.
3591 If ARG is negative, move backward -ARG lines.
3592 If ARG is zero, move to the beginning of the current line."
3593 (condition-case nil
3594 (if (> arg 0)
3595 (progn
3596 (while (> arg 0)
3597 (or (zerop (forward-line 1))
3598 (signal 'end-of-buffer nil))
3599 ;; If the newline we just skipped is invisible,
3600 ;; don't count it.
3601 (let ((prop
3602 (get-char-property (1- (point)) 'invisible)))
3603 (if (if (eq buffer-invisibility-spec t)
3604 prop
3605 (or (memq prop buffer-invisibility-spec)
3606 (assq prop buffer-invisibility-spec)))
3607 (setq arg (1+ arg))))
3608 (setq arg (1- arg)))
3609 ;; If invisible text follows, and it is a number of complete lines,
3610 ;; skip it.
3611 (let ((opoint (point)))
3612 (while (and (not (eobp))
3613 (let ((prop
3614 (get-char-property (point) 'invisible)))
3615 (if (eq buffer-invisibility-spec t)
3616 prop
3617 (or (memq prop buffer-invisibility-spec)
3618 (assq prop buffer-invisibility-spec)))))
3619 (goto-char
3620 (if (get-text-property (point) 'invisible)
3621 (or (next-single-property-change (point) 'invisible)
3622 (point-max))
3623 (next-overlay-change (point)))))
3624 (unless (bolp)
3625 (goto-char opoint))))
3626 (let ((first t))
3627 (while (or first (<= arg 0))
3628 (if first
3629 (beginning-of-line)
3630 (or (zerop (forward-line -1))
3631 (signal 'beginning-of-buffer nil)))
3632 ;; If the newline we just moved to is invisible,
3633 ;; don't count it.
3634 (unless (bobp)
3635 (let ((prop
3636 (get-char-property (1- (point)) 'invisible)))
3637 (unless (if (eq buffer-invisibility-spec t)
3638 prop
3639 (or (memq prop buffer-invisibility-spec)
3640 (assq prop buffer-invisibility-spec)))
3641 (setq arg (1+ arg)))))
3642 (setq first nil))
3643 ;; If invisible text follows, and it is a number of complete lines,
3644 ;; skip it.
3645 (let ((opoint (point)))
3646 (while (and (not (bobp))
3647 (let ((prop
3648 (get-char-property (1- (point)) 'invisible)))
3649 (if (eq buffer-invisibility-spec t)
3650 prop
3651 (or (memq prop buffer-invisibility-spec)
3652 (assq prop buffer-invisibility-spec)))))
3653 (goto-char
3654 (if (get-text-property (1- (point)) 'invisible)
3655 (or (previous-single-property-change (point) 'invisible)
3656 (point-min))
3657 (previous-overlay-change (point)))))
3658 (unless (bolp)
3659 (goto-char opoint)))))
3660 ((beginning-of-buffer end-of-buffer)
3661 nil)))
3663 (defun end-of-visible-line ()
3664 "Move to end of current visible line."
3665 (end-of-line)
3666 ;; If the following character is currently invisible,
3667 ;; skip all characters with that same `invisible' property value,
3668 ;; then find the next newline.
3669 (while (and (not (eobp))
3670 (save-excursion
3672 (let ((prop
3673 (get-char-property (point) 'invisible)))
3674 (if (eq buffer-invisibility-spec t)
3675 prop
3676 (or (memq prop buffer-invisibility-spec)
3677 (assq prop buffer-invisibility-spec))))))
3679 (if (get-text-property (point) 'invisible)
3680 (goto-char (next-single-property-change (point) 'invisible))
3681 (goto-char (next-overlay-change (point))))
3682 (end-of-line)))
3683 \f
3684 (defun insert-buffer (buffer)
3685 "Insert after point the contents of BUFFER.
3686 Puts mark after the inserted text.
3687 BUFFER may be a buffer or a buffer name.
3689 This function is meant for the user to run interactively.
3690 Don't call it from programs: use `insert-buffer-substring' instead!"
3691 (interactive
3692 (list
3693 (progn
3694 (barf-if-buffer-read-only)
3695 (read-buffer "Insert buffer: "
3696 (if (eq (selected-window) (next-window (selected-window)))
3697 (other-buffer (current-buffer))
3698 (window-buffer (next-window (selected-window))))
3699 t))))
3700 (push-mark
3701 (save-excursion
3702 (insert-buffer-substring (get-buffer buffer))
3703 (point)))
3704 nil)
3706 (defun append-to-buffer (buffer start end)
3707 "Append to specified buffer the text of the region.
3708 It is inserted into that buffer before its point.
3710 When calling from a program, give three arguments:
3711 BUFFER (or buffer name), START and END.
3712 START and END specify the portion of the current buffer to be copied."
3713 (interactive
3714 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3715 (region-beginning) (region-end)))
3716 (let* ((oldbuf (current-buffer))
3717 (append-to (get-buffer-create buffer))
3718 (windows (get-buffer-window-list append-to t t))
3719 point)
3720 (save-excursion
3721 (with-current-buffer append-to
3722 (setq point (point))
3723 (barf-if-buffer-read-only)
3724 (insert-buffer-substring oldbuf start end)
3725 (dolist (window windows)
3726 (when (= (window-point window) point)
3727 (set-window-point window (point))))))))
3729 (defun prepend-to-buffer (buffer start end)
3730 "Prepend to specified buffer the text of the region.
3731 It is inserted into that buffer after its point.
3733 When calling from a program, give three arguments:
3734 BUFFER (or buffer name), START and END.
3735 START and END specify the portion of the current buffer to be copied."
3737 (let ((oldbuf (current-buffer)))
3738 (with-current-buffer (get-buffer-create buffer)
3739 (barf-if-buffer-read-only)
3740 (save-excursion
3741 (insert-buffer-substring oldbuf start end)))))
3743 (defun copy-to-buffer (buffer start end)
3744 "Copy to specified buffer the text of the region.
3745 It is inserted into that buffer, replacing existing text there.
3747 When calling from a program, give three arguments:
3748 BUFFER (or buffer name), START and END.
3749 START and END specify the portion of the current buffer to be copied."
3751 (let ((oldbuf (current-buffer)))
3752 (with-current-buffer (get-buffer-create buffer)
3753 (barf-if-buffer-read-only)
3754 (erase-buffer)
3755 (save-excursion
3756 (insert-buffer-substring oldbuf start end)))))
3757 \f
3758 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3759 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3761 (defvar activate-mark-hook nil
3762 "Hook run when the mark becomes active.
3763 It is also run at the end of a command, if the mark is active and
3764 it is possible that the region may have changed.")
3766 (defvar deactivate-mark-hook nil
3767 "Hook run when the mark becomes inactive.")
3769 (defun mark (&optional force)
3770 "Return this buffer's mark value as integer, or nil if never set.
3772 In Transient Mark mode, this function signals an error if
3773 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3774 or the argument FORCE is non-nil, it disregards whether the mark
3775 is active, and returns an integer or nil in the usual way.
3777 If you are using this in an editing command, you are most likely making
3778 a mistake; see the documentation of `set-mark'."
3779 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3780 (marker-position (mark-marker))
3781 (signal 'mark-inactive nil)))
3783 (defsubst deactivate-mark (&optional force)
3784 "Deactivate the mark.
3785 If Transient Mark mode is disabled, this function normally does
3786 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3788 Deactivating the mark sets `mark-active' to nil, updates the
3789 primary selection according to `select-active-regions', and runs
3790 `deactivate-mark-hook'.
3792 If Transient Mark mode was temporarily enabled, reset the value
3793 of the variable `transient-mark-mode'; if this causes Transient
3794 Mark mode to be disabled, don't change `mark-active' to nil or
3795 run `deactivate-mark-hook'."
3796 (when (or transient-mark-mode force)
3797 (when (and (if (eq select-active-regions 'only)
3798 (eq (car-safe transient-mark-mode) 'only)
3799 select-active-regions)
3800 (region-active-p)
3801 (display-selections-p))
3802 ;; The var `saved-region-selection', if non-nil, is the text in
3803 ;; the region prior to the last command modifying the buffer.
3804 ;; Set the selection to that, or to the current region.
3805 (cond (saved-region-selection
3806 (x-set-selection 'PRIMARY saved-region-selection)
3807 (setq saved-region-selection nil))
3808 ((/= (region-beginning) (region-end))
3809 (x-set-selection 'PRIMARY
3810 (buffer-substring-no-properties
3811 (region-beginning)
3812 (region-end))))))
3813 (if (and (null force)
3814 (or (eq transient-mark-mode 'lambda)
3815 (and (eq (car-safe transient-mark-mode) 'only)
3816 (null (cdr transient-mark-mode)))))
3817 ;; When deactivating a temporary region, don't change
3818 ;; `mark-active' or run `deactivate-mark-hook'.
3819 (setq transient-mark-mode nil)
3820 (if (eq (car-safe transient-mark-mode) 'only)
3821 (setq transient-mark-mode (cdr transient-mark-mode)))
3822 (setq mark-active nil)
3823 (run-hooks 'deactivate-mark-hook))))
3825 (defun activate-mark ()
3826 "Activate the mark."
3827 (when (mark t)
3828 (setq mark-active t)
3829 (unless transient-mark-mode
3830 (setq transient-mark-mode 'lambda))))
3832 (defun set-mark (pos)
3833 "Set this buffer's mark to POS. Don't use this function!
3834 That is to say, don't use this function unless you want
3835 the user to see that the mark has moved, and you want the previous
3836 mark position to be lost.
3838 Normally, when a new mark is set, the old one should go on the stack.
3839 This is why most applications should use `push-mark', not `set-mark'.
3841 Novice Emacs Lisp programmers often try to use the mark for the wrong
3842 purposes. The mark saves a location for the user's convenience.
3843 Most editing commands should not alter the mark.
3844 To remember a location for internal use in the Lisp program,
3845 store it in a Lisp variable. Example:
3847 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3849 (if pos
3850 (progn
3851 (setq mark-active t)
3852 (run-hooks 'activate-mark-hook)
3853 (set-marker (mark-marker) pos (current-buffer)))
3854 ;; Normally we never clear mark-active except in Transient Mark mode.
3855 ;; But when we actually clear out the mark value too, we must
3856 ;; clear mark-active in any mode.
3857 (deactivate-mark t)
3858 (set-marker (mark-marker) nil)))
3860 (defcustom use-empty-active-region nil
3862 If nil, region-aware commands treat empty regions as inactive.
3863 If non-nil, region-aware commands treat the region as active as
3864 long as the mark is active, even if the region is empty.
3866 Region-aware commands are those that act on the region if it is
3867 active and Transient Mark mode is enabled, and on the text near
3868 point otherwise."
3869 :type 'boolean
3870 :version "23.1"
3871 :group 'editing-basics)
3873 (defun use-region-p ()
3874 "Return t if the region is active and it is appropriate to act on it.
3875 This is used by commands that act specially on the region under
3876 Transient Mark mode.
3878 The return value is t if Transient Mark mode is enabled and the
3879 mark is active; furthermore, if `use-empty-active-region' is nil,
3880 the region must not be empty. Otherwise, the return value is nil.
3882 For some commands, it may be appropriate to ignore the value of
3883 `use-empty-active-region'; in that case, use `region-active-p'."
3884 (and (region-active-p)
3885 (or use-empty-active-region (> (region-end) (region-beginning)))))
3887 (defun region-active-p ()
3888 "Return t if Transient Mark mode is enabled and the mark is active.
3890 Some commands act specially on the region when Transient Mark
3891 mode is enabled. Usually, such commands should use
3892 `use-region-p' instead of this function, because `use-region-p'
3893 also checks the value of `use-empty-active-region'."
3894 (and transient-mark-mode mark-active))
3896 (defvar mark-ring nil
3897 "The list of former marks of the current buffer, most recent first.")
3898 (make-variable-buffer-local 'mark-ring)
3899 (put 'mark-ring 'permanent-local t)
3901 (defcustom mark-ring-max 16
3902 "Maximum size of mark ring. Start discarding off end if gets this big."
3903 :type 'integer
3904 :group 'editing-basics)
3906 (defvar global-mark-ring nil
3907 "The list of saved global marks, most recent first.")
3909 (defcustom global-mark-ring-max 16
3910 "Maximum size of global mark ring. \
3911 Start discarding off end if gets this big."
3912 :type 'integer
3913 :group 'editing-basics)
3915 (defun pop-to-mark-command ()
3916 "Jump to mark, and pop a new position for mark off the ring.
3917 \(Does not affect global mark ring\)."
3918 (interactive)
3919 (if (null (mark t))
3920 (error "No mark set in this buffer")
3921 (if (= (point) (mark t))
3922 (message "Mark popped"))
3923 (goto-char (mark t))
3924 (pop-mark)))
3926 (defun push-mark-command (arg &optional nomsg)
3927 "Set mark at where point is.
3928 If no prefix ARG and mark is already set there, just activate it.
3929 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3930 (interactive "P")
3931 (let ((mark (marker-position (mark-marker))))
3932 (if (or arg (null mark) (/= mark (point)))
3933 (push-mark nil nomsg t)
3934 (setq mark-active t)
3935 (run-hooks 'activate-mark-hook)
3936 (unless nomsg
3937 (message "Mark activated")))))
3939 (defcustom set-mark-command-repeat-pop nil
3942 will pop the mark twice, and
3944 will pop the mark three times.
3948 :type 'boolean
3949 :group 'editing-basics)
3951 (defcustom set-mark-default-inactive nil
3952 "If non-nil, setting the mark does not activate it.
3954 behave the same whether or not `transient-mark-mode' is enabled."
3955 :type 'boolean
3956 :group 'editing-basics
3957 :version "23.1")
3959 (defun set-mark-command (arg)
3960 "Set the mark where point is, or jump to the mark.
3961 Setting the mark also alters the region, which is the text
3962 between point and mark; this is the closest equivalent in
3965 With no prefix argument, set the mark at point, and push the
3966 old mark position on local mark ring. Also push the old mark on
3967 global mark ring, if the previous mark was set in another buffer.
3969 When Transient Mark Mode is off, immediately repeating this
3970 command activates `transient-mark-mode' temporarily.
3973 jump to the mark, and set the mark from
3974 position popped off the local mark ring \(this does not affect the global
3976 mark ring \(see `pop-global-mark'\).
3978 If `set-mark-command-repeat-pop' is non-nil, repeating
3980 off the local (or global) mark ring and jumps there.
3983 argument, unconditionally set mark where point is, even if
3984 `set-mark-command-repeat-pop' is non-nil.
3986 Novice Emacs Lisp programmers often try to use the mark for the wrong
3987 purposes. See the documentation of `set-mark' for more information."
3988 (interactive "P")
3989 (cond ((eq transient-mark-mode 'lambda)
3990 (setq transient-mark-mode nil))
3991 ((eq (car-safe transient-mark-mode) 'only)
3992 (deactivate-mark)))
3993 (cond
3994 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3995 (push-mark-command nil))
3996 ((not (eq this-command 'set-mark-command))
3997 (if arg
3998 (pop-to-mark-command)
3999 (push-mark-command t)))
4000 ((and set-mark-command-repeat-pop
4001 (eq last-command 'pop-to-mark-command))
4002 (setq this-command 'pop-to-mark-command)
4003 (pop-to-mark-command))
4004 ((and set-mark-command-repeat-pop
4005 (eq last-command 'pop-global-mark)
4006 (not arg))
4007 (setq this-command 'pop-global-mark)
4008 (pop-global-mark))
4009 (arg
4010 (setq this-command 'pop-to-mark-command)
4011 (pop-to-mark-command))
4012 ((eq last-command 'set-mark-command)
4013 (if (region-active-p)
4014 (progn
4015 (deactivate-mark)
4016 (message "Mark deactivated"))
4017 (activate-mark)
4018 (message "Mark activated")))
4019 (t
4020 (push-mark-command nil)
4021 (if set-mark-default-inactive (deactivate-mark)))))
4023 (defun push-mark (&optional location nomsg activate)
4024 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4025 If the last global mark pushed was not in the current buffer,
4026 also push LOCATION on the global mark ring.
4027 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4029 Novice Emacs Lisp programmers often try to use the mark for the wrong
4030 purposes. See the documentation of `set-mark' for more information.
4032 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4033 (unless (null (mark t))
4034 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4035 (when (> (length mark-ring) mark-ring-max)
4036 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4037 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4038 (set-marker (mark-marker) (or location (point)) (current-buffer))
4039 ;; Now push the mark on the global mark ring.
4040 (if (and global-mark-ring
4041 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4042 ;; The last global mark pushed was in this same buffer.
4043 ;; Don't push another one.
4044 nil
4045 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4046 (when (> (length global-mark-ring) global-mark-ring-max)
4047 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4048 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4049 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4050 (message "Mark set"))
4051 (if (or activate (not transient-mark-mode))
4052 (set-mark (mark t)))
4053 nil)
4055 (defun pop-mark ()
4056 "Pop off mark ring into the buffer's actual mark.
4057 Does not set point. Does nothing if mark ring is empty."
4058 (when mark-ring
4059 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4060 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4061 (move-marker (car mark-ring) nil)
4062 (if (null (mark t)) (ding))
4063 (setq mark-ring (cdr mark-ring)))
4064 (deactivate-mark))
4066 (define-obsolete-function-alias
4067 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4068 (defun exchange-point-and-mark (&optional arg)
4069 "Put the mark where point is now, and point where the mark is now.
4070 This command works even when the mark is not active,
4071 and it reactivates the mark.
4073 If Transient Mark mode is on, a prefix ARG deactivates the mark
4074 if it is active, and otherwise avoids reactivating it. If
4075 Transient Mark mode is off, a prefix ARG enables Transient Mark
4076 mode temporarily."
4077 (interactive "P")
4078 (let ((omark (mark t))
4079 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4080 (if (null omark)
4081 (error "No mark set in this buffer"))
4082 (deactivate-mark)
4083 (set-mark (point))
4084 (goto-char omark)
4085 (if set-mark-default-inactive (deactivate-mark))
4086 (cond (temp-highlight
4087 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4088 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4089 (not (or arg (region-active-p))))
4090 (deactivate-mark))
4091 (t (activate-mark)))
4092 nil))
4094 (defcustom shift-select-mode t
4095 "When non-nil, shifted motion keys activate the mark momentarily.
4097 While the mark is activated in this way, any shift-translated point
4098 motion key extends the region, and if Transient Mark mode was off, it
4099 is temporarily turned on. Furthermore, the mark will be deactivated
4100 by any subsequent point motion key that was not shift-translated, or
4101 by any action that normally deactivates the mark in Transient Mark mode.
4103 See `this-command-keys-shift-translated' for the meaning of
4104 shift-translation."
4105 :type 'boolean
4106 :group 'editing-basics)
4108 (defun handle-shift-selection ()
4109 "Activate/deactivate mark depending on invocation thru shift translation.
4110 This function is called by `call-interactively' when a command
4111 with a `^' character in its `interactive' spec is invoked, before
4112 running the command itself.
4114 If `shift-select-mode' is enabled and the command was invoked
4115 through shift translation, set the mark and activate the region
4116 temporarily, unless it was already set in this way. See
4117 `this-command-keys-shift-translated' for the meaning of shift
4118 translation.
4120 Otherwise, if the region has been activated temporarily,
4121 deactivate it, and restore the variable `transient-mark-mode' to
4122 its earlier value."
4123 (cond ((and shift-select-mode this-command-keys-shift-translated)
4124 (unless (and mark-active
4125 (eq (car-safe transient-mark-mode) 'only))
4126 (setq transient-mark-mode
4127 (cons 'only
4128 (unless (eq transient-mark-mode 'lambda)
4129 transient-mark-mode)))
4130 (push-mark nil nil t)))
4131 ((eq (car-safe transient-mark-mode) 'only)
4132 (setq transient-mark-mode (cdr transient-mark-mode))
4133 (deactivate-mark))))
4135 (define-minor-mode transient-mark-mode
4136 "Toggle Transient Mark mode.
4137 With a prefix argument ARG, enable Transient Mark mode if ARG is
4138 positive, and disable it otherwise. If called from Lisp, enable
4139 Transient Mark mode if ARG is omitted or nil.
4141 Transient Mark mode is a global minor mode. When enabled, the
4142 region is highlighted whenever the mark is active. The mark is
4144 operations that set the mark but whose main purpose is something
4150 Many commands change their behavior when Transient Mark mode is in effect
4151 and the mark is active, by acting on the region instead of their usual
4152 default part of the buffer's text. Examples of such commands include
4157 commands which are sensitive to the Transient Mark mode."
4158 :global t
4159 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4160 :variable transient-mark-mode)
4162 (defvar widen-automatically t
4163 "Non-nil means it is ok for commands to call `widen' when they want to.
4164 Some commands will do this in order to go to positions outside
4165 the current accessible part of the buffer.
4167 If `widen-automatically' is nil, these commands will do something else
4168 as a fallback, and won't change the buffer bounds.")
4170 (defvar non-essential nil
4171 "Whether the currently executing code is performing an essential task.
4172 This variable should be non-nil only when running code which should not
4173 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4174 user for a password when we are simply scanning a set of files in the
4175 background or displaying possible completions before the user even asked
4176 for it.")
4178 (defun pop-global-mark ()
4179 "Pop off global mark ring and jump to the top location."
4180 (interactive)
4181 ;; Pop entries which refer to non-existent buffers.
4182 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4183 (setq global-mark-ring (cdr global-mark-ring)))
4184 (or global-mark-ring
4185 (error "No global mark set"))
4186 (let* ((marker (car global-mark-ring))
4187 (buffer (marker-buffer marker))
4188 (position (marker-position marker)))
4189 (setq global-mark-ring (nconc (cdr global-mark-ring)
4190 (list (car global-mark-ring))))
4191 (set-buffer buffer)
4192 (or (and (>= position (point-min))
4193 (<= position (point-max)))
4194 (if widen-automatically
4195 (widen)
4196 (error "Global mark position is outside accessible part of buffer")))
4197 (goto-char position)
4198 (switch-to-buffer buffer)))
4199 \f
4200 (defcustom next-line-add-newlines nil
4201 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4202 :type 'boolean
4203 :version "21.1"
4204 :group 'editing-basics)
4206 (defun next-line (&optional arg try-vscroll)
4207 "Move cursor vertically down ARG lines.
4208 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4209 If there is no character in the target line exactly under the current column,
4210 the cursor is positioned after the character in that line which spans this
4211 column, or at the end of the line if it is not long enough.
4212 If there is no line in the buffer after this one, behavior depends on the
4213 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4214 to create a line, and moves the cursor to that line. Otherwise it moves the
4215 cursor to the end of the buffer.
4217 If the variable `line-move-visual' is non-nil, this command moves
4218 by display lines. Otherwise, it moves by buffer lines, without
4219 taking variable-width characters or continued lines into account.
4222 a semipermanent goal column for this command.
4223 Then instead of trying to move exactly vertically (or as close as possible),
4224 this command moves to the specified goal column (or as close as possible).
4225 The goal column is stored in the variable `goal-column', which is nil
4226 when there is no goal column. Note that setting `goal-column'
4227 overrides `line-move-visual' and causes this command to move by buffer
4228 lines rather than by display lines.
4230 If you are thinking of using this in a Lisp program, consider
4231 using `forward-line' instead. It is usually easier to use
4232 and more reliable (no dependence on goal column, etc.)."
4234 (or arg (setq arg 1))
4235 (if (and next-line-add-newlines (= arg 1))
4236 (if (save-excursion (end-of-line) (eobp))
4237 ;; When adding a newline, don't expand an abbrev.
4238 (let ((abbrev-mode nil))
4239 (end-of-line)
4241 (line-move arg nil nil try-vscroll))
4242 (if (called-interactively-p 'interactive)
4243 (condition-case err
4244 (line-move arg nil nil try-vscroll)
4245 ((beginning-of-buffer end-of-buffer)
4246 (signal (car err) (cdr err))))
4247 (line-move arg nil nil try-vscroll)))
4248 nil)
4250 (defun previous-line (&optional arg try-vscroll)
4251 "Move cursor vertically up ARG lines.
4252 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4253 If there is no character in the target line exactly over the current column,
4254 the cursor is positioned after the character in that line which spans this
4255 column, or at the end of the line if it is not long enough.
4257 If the variable `line-move-visual' is non-nil, this command moves
4258 by display lines. Otherwise, it moves by buffer lines, without
4259 taking variable-width characters or continued lines into account.
4262 a semipermanent goal column for this command.
4263 Then instead of trying to move exactly vertically (or as close as possible),
4264 this command moves to the specified goal column (or as close as possible).
4265 The goal column is stored in the variable `goal-column', which is nil
4266 when there is no goal column. Note that setting `goal-column'
4267 overrides `line-move-visual' and causes this command to move by buffer
4268 lines rather than by display lines.
4270 If you are thinking of using this in a Lisp program, consider using
4271 `forward-line' with a negative argument instead. It is usually easier
4272 to use and more reliable (no dependence on goal column, etc.)."
4274 (or arg (setq arg 1))
4275 (if (called-interactively-p 'interactive)
4276 (condition-case err
4277 (line-move (- arg) nil nil try-vscroll)
4278 ((beginning-of-buffer end-of-buffer)
4279 (signal (car err) (cdr err))))
4280 (line-move (- arg) nil nil try-vscroll))
4281 nil)
4283 (defcustom track-eol nil
4284 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4285 This means moving to the end of each line moved onto.
4286 The beginning of a blank line does not count as the end of a line.
4287 This has no effect when `line-move-visual' is non-nil."
4288 :type 'boolean
4289 :group 'editing-basics)
4291 (defcustom goal-column nil
4293 A non-nil setting overrides `line-move-visual', which see."
4294 :type '(choice integer
4295 (const :tag "None" nil))
4296 :group 'editing-basics)
4297 (make-variable-buffer-local 'goal-column)
4299 (defvar temporary-goal-column 0
4300 "Current goal column for vertical motion.
4301 It is the column where point was at the start of the current run
4302 of vertical motion commands.
4304 When moving by visual lines via `line-move-visual', it is a cons
4305 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4306 divided by the default column width, and HSCROLL is the number of
4307 columns by which window is scrolled from left margin.
4309 When the `track-eol' feature is doing its job, the value is
4310 `most-positive-fixnum'.")
4312 (defcustom line-move-ignore-invisible t
4314 Outline mode sets this."
4315 :type 'boolean
4316 :group 'editing-basics)
4318 (defcustom line-move-visual t
4319 "When non-nil, `line-move' moves point by visual lines.
4320 This movement is based on where the cursor is displayed on the
4321 screen, instead of relying on buffer contents alone. It takes
4322 into account variable-width characters and line continuation.
4323 If nil, `line-move' moves point by logical lines.
4324 A non-nil setting of `goal-column' overrides the value of this variable
4325 and forces movement by logical lines.
4326 A window that is horizontally scrolled also forces movement by logical
4327 lines."
4328 :type 'boolean
4329 :group 'editing-basics
4330 :version "23.1")
4332 ;; Returns non-nil if partial move was done.
4333 (defun line-move-partial (arg noerror to-end)
4334 (if (< arg 0)
4335 ;; Move backward (up).
4336 ;; If already vscrolled, reduce vscroll
4337 (let ((vs (window-vscroll nil t)))
4338 (when (> vs (frame-char-height))
4339 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4341 ;; Move forward (down).
4342 (let* ((lh (window-line-height -1))
4343 (vpos (nth 1 lh))
4344 (ypos (nth 2 lh))
4345 (rbot (nth 3 lh))
4346 py vs)
4347 (when (or (null lh)
4348 (>= rbot (frame-char-height))
4349 (<= ypos (- (frame-char-height))))
4350 (unless lh
4351 (let ((wend (pos-visible-in-window-p t nil t)))
4352 (setq rbot (nth 3 wend)
4353 vpos (nth 5 wend))))
4354 (cond
4355 ;; If last line of window is fully visible, move forward.
4356 ((or (null rbot) (= rbot 0))
4357 nil)
4358 ;; If cursor is not in the bottom scroll margin, move forward.
4359 ((and (> vpos 0)
4360 (< (setq py
4361 (or (nth 1 (window-line-height))
4362 (let ((ppos (posn-at-point)))
4363 (cdr (or (posn-actual-col-row ppos)
4364 (posn-col-row ppos))))))
4365 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4366 nil)
4367 ;; When already vscrolled, we vscroll some more if we can,
4368 ;; or clear vscroll and move forward at end of tall image.
4369 ((> (setq vs (window-vscroll nil t)) 0)
4370 (when (> rbot 0)
4371 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4372 ;; If cursor just entered the bottom scroll margin, move forward,
4373 ;; but also vscroll one line so redisplay won't recenter.
4374 ((and (> vpos 0)
4375 (= py (min (- (window-text-height) scroll-margin 1)
4376 (1- vpos))))
4377 (set-window-vscroll nil (frame-char-height) t)
4378 (line-move-1 arg noerror to-end)
4379 t)
4380 ;; If there are lines above the last line, scroll-up one line.
4381 ((> vpos 0)
4382 (scroll-up 1)
4383 t)
4384 ;; Finally, start vscroll.
4385 (t
4386 (set-window-vscroll nil (frame-char-height) t)))))))
4389 ;; This is like line-move-1 except that it also performs
4390 ;; vertical scrolling of tall images if appropriate.
4391 ;; That is not really a clean thing to do, since it mixes
4392 ;; scrolling with cursor motion. But so far we don't have
4393 ;; a cleaner solution to the problem of making C-n do something
4394 ;; useful given a tall image.
4395 (defun line-move (arg &optional noerror to-end try-vscroll)
4396 (unless (and auto-window-vscroll try-vscroll
4397 ;; Only vscroll for single line moves
4398 (= (abs arg) 1)
4399 ;; But don't vscroll in a keyboard macro.
4400 (not defining-kbd-macro)
4401 (not executing-kbd-macro)
4402 (line-move-partial arg noerror to-end))
4403 (set-window-vscroll nil 0 t)
4404 (if (and line-move-visual
4405 ;; Display-based column are incompatible with goal-column.
4406 (not goal-column)
4407 ;; When the text in the window is scrolled to the left,
4408 ;; display-based motion doesn't make sense (because each
4409 ;; logical line occupies exactly one screen line).
4410 (not (> (window-hscroll) 0)))
4411 (line-move-visual arg noerror)
4412 (line-move-1 arg noerror to-end))))
4414 ;; Display-based alternative to line-move-1.
4415 ;; Arg says how many lines to move. The value is t if we can move the
4416 ;; specified number of lines.
4417 (defun line-move-visual (arg &optional noerror)
4418 (let ((opoint (point))
4419 (hscroll (window-hscroll))
4420 target-hscroll)
4421 ;; Check if the previous command was a line-motion command, or if
4422 ;; we were called from some other command.
4423 (if (and (consp temporary-goal-column)
4424 (memq last-command `(next-line previous-line ,this-command)))
4425 ;; If so, there's no need to reset `temporary-goal-column',
4426 ;; but we may need to hscroll.
4427 (if (or (/= (cdr temporary-goal-column) hscroll)
4428 (> (cdr temporary-goal-column) 0))
4429 (setq target-hscroll (cdr temporary-goal-column)))
4430 ;; Otherwise, we should reset `temporary-goal-column'.
4431 (let ((posn (posn-at-point)))
4432 (cond
4433 ;; Handle the `overflow-newline-into-fringe' case:
4434 ((eq (nth 1 posn) 'right-fringe)
4435 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4436 ((car (posn-x-y posn))
4437 (setq temporary-goal-column
4438 (cons (/ (float (car (posn-x-y posn)))
4439 (frame-char-width)) hscroll))))))
4440 (if target-hscroll
4441 (set-window-hscroll (selected-window) target-hscroll))
4442 (or (and (= (vertical-motion
4443 (cons (or goal-column
4444 (if (consp temporary-goal-column)
4445 (car temporary-goal-column)
4446 temporary-goal-column))
4447 arg))
4448 arg)
4449 (or (>= arg 0)
4450 (/= (point) opoint)
4451 ;; If the goal column lies on a display string,
4452 ;; `vertical-motion' advances the cursor to the end
4453 ;; of the string. For arg < 0, this can cause the
4454 ;; cursor to get stuck. (Bug#3020).
4455 (= (vertical-motion arg) arg)))
4456 (unless noerror
4457 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4458 nil)))))
4460 ;; This is the guts of next-line and previous-line.
4461 ;; Arg says how many lines to move.
4462 ;; The value is t if we can move the specified number of lines.
4463 (defun line-move-1 (arg &optional noerror _to-end)
4464 ;; Don't run any point-motion hooks, and disregard intangibility,
4465 ;; for intermediate positions.
4466 (let ((inhibit-point-motion-hooks t)
4467 (opoint (point))
4468 (orig-arg arg))
4469 (if (consp temporary-goal-column)
4470 (setq temporary-goal-column (+ (car temporary-goal-column)
4471 (cdr temporary-goal-column))))
4472 (unwind-protect
4473 (progn
4474 (if (not (memq last-command '(next-line previous-line)))
4475 (setq temporary-goal-column
4476 (if (and track-eol (eolp)
4477 ;; Don't count beg of empty line as end of line
4478 ;; unless we just did explicit end-of-line.
4479 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4480 most-positive-fixnum
4481 (current-column))))
4483 (if (not (or (integerp selective-display)
4484 line-move-ignore-invisible))
4485 ;; Use just newline characters.
4486 ;; Set ARG to 0 if we move as many lines as requested.
4487 (or (if (> arg 0)
4488 (progn (if (> arg 1) (forward-line (1- arg)))
4489 ;; This way of moving forward ARG lines
4490 ;; verifies that we have a newline after the last one.
4491 ;; It doesn't get confused by intangible text.
4492 (end-of-line)
4493 (if (zerop (forward-line 1))
4494 (setq arg 0)))
4495 (and (zerop (forward-line arg))
4496 (bolp)
4497 (setq arg 0)))
4498 (unless noerror
4499 (signal (if (< arg 0)
4500 'beginning-of-buffer
4501 'end-of-buffer)
4502 nil)))
4503 ;; Move by arg lines, but ignore invisible ones.
4504 (let (done)
4505 (while (and (> arg 0) (not done))
4506 ;; If the following character is currently invisible,
4507 ;; skip all characters with that same `invisible' property value.
4508 (while (and (not (eobp)) (invisible-p (point)))
4509 (goto-char (next-char-property-change (point))))
4510 ;; Move a line.
4511 ;; We don't use `end-of-line', since we want to escape
4512 ;; from field boundaries occurring exactly at point.
4513 (goto-char (constrain-to-field
4514 (let ((inhibit-field-text-motion t))
4515 (line-end-position))
4516 (point) t t
4517 'inhibit-line-move-field-capture))
4518 ;; If there's no invisibility here, move over the newline.
4519 (cond
4520 ((eobp)
4521 (if (not noerror)
4522 (signal 'end-of-buffer nil)
4523 (setq done t)))
4524 ((and (> arg 1) ;; Use vertical-motion for last move
4525 (not (integerp selective-display))
4526 (not (invisible-p (point))))
4527 ;; We avoid vertical-motion when possible
4528 ;; because that has to fontify.
4529 (forward-line 1))
4530 ;; Otherwise move a more sophisticated way.
4531 ((zerop (vertical-motion 1))
4532 (if (not noerror)
4533 (signal 'end-of-buffer nil)
4534 (setq done t))))
4535 (unless done
4536 (setq arg (1- arg))))
4537 ;; The logic of this is the same as the loop above,
4538 ;; it just goes in the other direction.
4539 (while (and (< arg 0) (not done))
4540 ;; For completely consistency with the forward-motion
4541 ;; case, we should call beginning-of-line here.
4542 ;; However, if point is inside a field and on a
4543 ;; continued line, the call to (vertical-motion -1)
4544 ;; below won't move us back far enough; then we return
4545 ;; to the same column in line-move-finish, and point
4546 ;; gets stuck -- cyd
4547 (forward-line 0)
4548 (cond
4549 ((bobp)
4550 (if (not noerror)
4551 (signal 'beginning-of-buffer nil)
4552 (setq done t)))
4553 ((and (< arg -1) ;; Use vertical-motion for last move
4554 (not (integerp selective-display))
4555 (not (invisible-p (1- (point)))))
4556 (forward-line -1))
4557 ((zerop (vertical-motion -1))
4558 (if (not noerror)
4559 (signal 'beginning-of-buffer nil)
4560 (setq done t))))
4561 (unless done
4562 (setq arg (1+ arg))
4563 (while (and ;; Don't move over previous invis lines
4564 ;; if our target is the middle of this line.
4565 (or (zerop (or goal-column temporary-goal-column))
4566 (< arg 0))
4567 (not (bobp)) (invisible-p (1- (point))))
4568 (goto-char (previous-char-property-change (point))))))))
4569 ;; This is the value the function returns.
4570 (= arg 0))
4572 (cond ((> arg 0)
4573 ;; If we did not move down as far as desired, at least go
4574 ;; to end of line. Be sure to call point-entered and
4575 ;; point-left-hooks.
4576 (let* ((npoint (prog1 (line-end-position)
4577 (goto-char opoint)))
4578 (inhibit-point-motion-hooks nil))
4579 (goto-char npoint)))
4580 ((< arg 0)
4581 ;; If we did not move up as far as desired,
4582 ;; at least go to beginning of line.
4583 (let* ((npoint (prog1 (line-beginning-position)
4584 (goto-char opoint)))
4585 (inhibit-point-motion-hooks nil))
4586 (goto-char npoint)))
4587 (t
4588 (line-move-finish (or goal-column temporary-goal-column)
4589 opoint (> orig-arg 0)))))))
4591 (defun line-move-finish (column opoint forward)
4592 (let ((repeat t))
4593 (while repeat
4594 ;; Set REPEAT to t to repeat the whole thing.
4595 (setq repeat nil)
4597 (let (new
4598 (old (point))
4599 (line-beg (line-beginning-position))
4600 (line-end
4601 ;; Compute the end of the line
4602 ;; ignoring effectively invisible newlines.
4603 (save-excursion
4604 ;; Like end-of-line but ignores fields.
4606 (while (and (not (eobp)) (invisible-p (point)))
4607 (goto-char (next-char-property-change (point)))
4609 (point))))
4611 ;; Move to the desired column.
4612 (line-move-to-column (truncate column))
4614 ;; Corner case: suppose we start out in a field boundary in
4615 ;; the middle of a continued line. When we get to
4616 ;; line-move-finish, point is at the start of a new *screen*
4617 ;; line but the same text line; then line-move-to-column would
4618 ;; move us backwards. Test using C-n with point on the "x" in
4619 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4620 (and forward
4621 (< (point) old)
4622 (goto-char old))
4624 (setq new (point))
4626 ;; Process intangibility within a line.
4627 ;; With inhibit-point-motion-hooks bound to nil, a call to
4628 ;; goto-char moves point past intangible text.
4630 ;; However, inhibit-point-motion-hooks controls both the
4631 ;; intangibility and the point-entered/point-left hooks. The
4632 ;; following hack avoids calling the point-* hooks
4633 ;; unnecessarily. Note that we move *forward* past intangible
4634 ;; text when the initial and final points are the same.
4635 (goto-char new)
4636 (let ((inhibit-point-motion-hooks nil))
4637 (goto-char new)
4639 ;; If intangibility moves us to a different (later) place
4640 ;; in the same line, use that as the destination.
4641 (if (<= (point) line-end)
4642 (setq new (point))
4643 ;; If that position is "too late",
4644 ;; try the previous allowable position.
4645 ;; See if it is ok.
4646 (backward-char)
4647 (if (if forward
4648 ;; If going forward, don't accept the previous
4649 ;; allowable position if it is before the target line.
4650 (< line-beg (point))
4651 ;; If going backward, don't accept the previous
4652 ;; allowable position if it is still after the target line.
4653 (<= (point) line-end))
4654 (setq new (point))
4655 ;; As a last resort, use the end of the line.
4656 (setq new line-end))))
4658 ;; Now move to the updated destination, processing fields
4659 ;; as well as intangibility.
4660 (goto-char opoint)
4661 (let ((inhibit-point-motion-hooks nil))
4662 (goto-char
4663 ;; Ignore field boundaries if the initial and final
4664 ;; positions have the same `field' property, even if the
4665 ;; fields are non-contiguous. This seems to be "nicer"
4666 ;; behavior in many situations.
4667 (if (eq (get-char-property new 'field)
4668 (get-char-property opoint 'field))
4669 new
4670 (constrain-to-field new opoint t t
4671 'inhibit-line-move-field-capture))))
4673 ;; If all this moved us to a different line,
4674 ;; retry everything within that new line.
4675 (when (or (< (point) line-beg) (> (point) line-end))
4676 ;; Repeat the intangibility and field processing.
4677 (setq repeat t))))))
4679 (defun line-move-to-column (col)
4680 "Try to find column COL, considering invisibility.
4681 This function works only in certain cases,
4682 because what we really need is for `move-to-column'
4683 and `current-column' to be able to ignore invisible text."
4684 (if (zerop col)
4685 (beginning-of-line)
4686 (move-to-column col))
4688 (when (and line-move-ignore-invisible
4689 (not (bolp)) (invisible-p (1- (point))))
4690 (let ((normal-location (point))
4691 (normal-column (current-column)))
4692 ;; If the following character is currently invisible,
4693 ;; skip all characters with that same `invisible' property value.
4694 (while (and (not (eobp))
4695 (invisible-p (point)))
4696 (goto-char (next-char-property-change (point))))
4697 ;; Have we advanced to a larger column position?
4698 (if (> (current-column) normal-column)
4699 ;; We have made some progress towards the desired column.
4700 ;; See if we can make any further progress.
4701 (line-move-to-column (+ (current-column) (- col normal-column)))
4702 ;; Otherwise, go to the place we originally found
4703 ;; and move back over invisible text.
4704 ;; that will get us to the same place on the screen
4705 ;; but with a more reasonable buffer position.
4706 (goto-char normal-location)
4707 (let ((line-beg (line-beginning-position)))
4708 (while (and (not (bolp)) (invisible-p (1- (point))))
4709 (goto-char (previous-char-property-change (point) line-beg))))))))
4711 (defun move-end-of-line (arg)
4712 "Move point to end of current line as displayed.
4713 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4714 If point reaches the beginning or end of buffer, it stops there.
4716 To ignore the effects of the `intangible' text or overlay
4717 property, bind `inhibit-point-motion-hooks' to t.
4718 If there is an image in the current line, this function
4719 disregards newlines that are part of the text on which the image
4720 rests."
4721 (interactive "^p")
4722 (or arg (setq arg 1))
4723 (let (done)
4724 (while (not done)
4725 (let ((newpos
4726 (save-excursion
4727 (let ((goal-column 0)
4728 (line-move-visual nil))
4729 (and (line-move arg t)
4730 ;; With bidi reordering, we may not be at bol,
4731 ;; so make sure we are.
4733 (not (bobp))
4734 (progn
4735 (while (and (not (bobp)) (invisible-p (1- (point))))
4736 (goto-char (previous-single-char-property-change
4737 (point) 'invisible)))
4738 (backward-char 1)))
4739 (point)))))
4740 (goto-char newpos)
4741 (if (and (> (point) newpos)
4743 (backward-char 1)
4744 (if (and (> (point) newpos) (not (eobp))
4746 ;; If we skipped something intangible and now we're not
4747 ;; really at eol, keep going.
4748 (setq arg 1)
4749 (setq done t)))))))
4751 (defun move-beginning-of-line (arg)
4752 "Move point to beginning of current line as displayed.
4753 \(If there's an image in the line, this disregards newlines
4754 which are part of the text that the image rests on.)
4756 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4757 If point reaches the beginning or end of buffer, it stops there.
4758 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4759 (interactive "^p")
4760 (or arg (setq arg 1))
4762 (let ((orig (point))
4763 first-vis first-vis-field-value)
4765 ;; Move by lines, if ARG is not 1 (the default).
4766 (if (/= arg 1)
4767 (let ((line-move-visual nil))
4768 (line-move (1- arg) t)))
4770 ;; Move to beginning-of-line, ignoring fields and invisible text.
4772 (while (and (not (bobp)) (invisible-p (1- (point))))
4773 (goto-char (previous-char-property-change (point)))
4776 ;; Now find first visible char in the line
4777 (while (and (not (eobp)) (invisible-p (point)))
4778 (goto-char (next-char-property-change (point))))
4779 (setq first-vis (point))
4781 ;; See if fields would stop us from reaching FIRST-VIS.
4782 (setq first-vis-field-value
4783 (constrain-to-field first-vis orig (/= arg 1) t nil))
4785 (goto-char (if (/= first-vis-field-value first-vis)
4786 ;; If yes, obey them.
4787 first-vis-field-value
4788 ;; Otherwise, move to START with attention to fields.
4789 ;; (It is possible that fields never matter in this case.)
4790 (constrain-to-field (point) orig
4791 (/= arg 1) t nil)))))
4794 ;; Many people have said they rarely use this feature, and often type
4795 ;; it by accident. Maybe it shouldn't even be on a key.
4796 (put 'set-goal-column 'disabled t)
4798 (defun set-goal-column (arg)
4800 Those commands will move to this position in the line moved to
4801 rather than trying to keep the same horizontal position.
4802 With a non-nil argument ARG, clears out the goal column
4804 The goal column is stored in the variable `goal-column'."
4805 (interactive "P")
4806 (if arg
4807 (progn
4808 (setq goal-column nil)
4809 (message "No goal column"))
4810 (setq goal-column (current-column))
4811 ;; The older method below can be erroneous if `set-goal-column' is bound
4812 ;; to a sequence containing %
4813 ;;(message (substitute-command-keys
4815 ;;goal-column)
4816 (message "%s"
4817 (concat
4818 (format "Goal column %d " goal-column)
4819 (substitute-command-keys
4822 )
4823 nil)
4824 \f
4825 ;;; Editing based on visual lines, as opposed to logical lines.
4827 (defun end-of-visual-line (&optional n)
4828 "Move point to end of current visual line.
4829 With argument N not nil or 1, move forward N - 1 visual lines first.
4830 If point reaches the beginning or end of buffer, it stops there.
4831 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4832 (interactive "^p")
4833 (or n (setq n 1))
4834 (if (/= n 1)
4835 (let ((line-move-visual t))
4836 (line-move (1- n) t)))
4837 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4838 ;; constrain to field boundaries, so we don't either.
4839 (vertical-motion (cons (window-width) 0)))
4841 (defun beginning-of-visual-line (&optional n)
4842 "Move point to beginning of current visual line.
4843 With argument N not nil or 1, move forward N - 1 visual lines first.
4844 If point reaches the beginning or end of buffer, it stops there.
4845 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4846 (interactive "^p")
4847 (or n (setq n 1))
4848 (let ((opoint (point)))
4849 (if (/= n 1)
4850 (let ((line-move-visual t))
4851 (line-move (1- n) t)))
4852 (vertical-motion 0)
4853 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4854 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4856 (defun kill-visual-line (&optional arg)
4857 "Kill the rest of the visual line.
4858 With prefix argument ARG, kill that many visual lines from point.
4859 If ARG is negative, kill visual lines backward.
4860 If ARG is zero, kill the text before point on the current visual
4861 line.
4863 If you want to append the killed line to the last killed text,
4866 If the buffer is read-only, Emacs will beep and refrain from deleting
4867 the line, but put the line in the kill ring anyway. This means that
4868 you can use this command to copy text from a read-only buffer.
4869 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4870 even beep.)"
4871 (interactive "P")
4872 ;; Like in `kill-line', it's better to move point to the other end
4873 ;; of the kill before killing.
4874 (let ((opoint (point))
4875 (kill-whole-line (and kill-whole-line (bolp))))
4876 (if arg
4877 (vertical-motion (prefix-numeric-value arg))
4878 (end-of-visual-line 1)
4879 (if (= (point) opoint)
4880 (vertical-motion 1)
4881 ;; Skip any trailing whitespace at the end of the visual line.
4882 ;; We used to do this only if `show-trailing-whitespace' is
4883 ;; nil, but that's wrong; the correct thing would be to check
4884 ;; whether the trailing whitespace is highlighted. But, it's
4885 ;; OK to just do this unconditionally.
4888 (1+ (point))
4889 (point)))))
4891 (defun next-logical-line (&optional arg try-vscroll)
4892 "Move cursor vertically down ARG lines.
4893 This is identical to `next-line', except that it always moves
4894 by logical lines instead of visual lines, ignoring the value of
4895 the variable `line-move-visual'."
4897 (let ((line-move-visual nil))
4898 (with-no-warnings
4899 (next-line arg try-vscroll))))
4901 (defun previous-logical-line (&optional arg try-vscroll)
4902 "Move cursor vertically up ARG lines.
4903 This is identical to `previous-line', except that it always moves
4904 by logical lines instead of visual lines, ignoring the value of
4905 the variable `line-move-visual'."
4907 (let ((line-move-visual nil))
4908 (with-no-warnings
4909 (previous-line arg try-vscroll))))
4911 (defgroup visual-line nil
4912 "Editing based on visual lines."
4913 :group 'convenience
4914 :version "23.1")
4916 (defvar visual-line-mode-map
4917 (let ((map (make-sparse-keymap)))
4918 (define-key map [remap kill-line] 'kill-visual-line)
4919 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4920 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4921 ;; These keybindings interfere with xterm function keys. Are
4922 ;; there any other suitable bindings?
4923 ;; (define-key map "\M-[" 'previous-logical-line)
4924 ;; (define-key map "\M-]" 'next-logical-line)
4925 map))
4927 (defcustom visual-line-fringe-indicators '(nil nil)
4928 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4929 The value should be a list of the form (LEFT RIGHT), where LEFT
4930 and RIGHT are symbols representing the bitmaps to display, to
4931 indicate wrapped lines, in the left and right fringes respectively.
4932 See also `fringe-indicator-alist'.
4933 The default is not to display fringe indicators for wrapped lines.
4934 This variable does not affect fringe indicators displayed for
4935 other purposes."
4936 :type '(list (choice (const :tag "Hide left indicator" nil)
4937 (const :tag "Left curly arrow" left-curly-arrow)
4938 (symbol :tag "Other bitmap"))
4939 (choice (const :tag "Hide right indicator" nil)
4940 (const :tag "Right curly arrow" right-curly-arrow)
4941 (symbol :tag "Other bitmap")))
4942 :set (lambda (symbol value)
4943 (dolist (buf (buffer-list))
4944 (with-current-buffer buf
4945 (when (and (boundp 'visual-line-mode)
4946 (symbol-value 'visual-line-mode))
4947 (setq fringe-indicator-alist
4948 (cons (cons 'continuation value)
4949 (assq-delete-all
4950 'continuation
4951 (copy-tree fringe-indicator-alist)))))))
4952 (set-default symbol value)))
4954 (defvar visual-line--saved-state nil)
4956 (define-minor-mode visual-line-mode
4957 "Toggle visual line based editing (Visual Line mode).
4958 With a prefix argument ARG, enable Visual Line mode if ARG is
4959 positive, and disable it otherwise. If called from Lisp, enable
4960 the mode if ARG is omitted or nil.
4962 When Visual Line mode is enabled, `word-wrap' is turned on in
4963 this buffer, and simple editing commands are redefined to act on
4964 visual lines, not logical lines. See Info node `Visual Line
4965 Mode' for details."
4966 :keymap visual-line-mode-map
4967 :group 'visual-line
4968 :lighter " Wrap"
4969 (if visual-line-mode
4970 (progn
4971 (set (make-local-variable 'visual-line--saved-state) nil)
4972 ;; Save the local values of some variables, to be restored if
4973 ;; visual-line-mode is turned off.
4974 (dolist (var '(line-move-visual truncate-lines
4975 truncate-partial-width-windows
4976 word-wrap fringe-indicator-alist))
4977 (if (local-variable-p var)
4978 (push (cons var (symbol-value var))
4979 visual-line--saved-state)))
4980 (set (make-local-variable 'line-move-visual) t)
4981 (set (make-local-variable 'truncate-partial-width-windows) nil)
4982 (setq truncate-lines nil
4983 word-wrap t
4984 fringe-indicator-alist
4985 (cons (cons 'continuation visual-line-fringe-indicators)
4986 fringe-indicator-alist)))
4987 (kill-local-variable 'line-move-visual)
4988 (kill-local-variable 'word-wrap)
4989 (kill-local-variable 'truncate-lines)
4990 (kill-local-variable 'truncate-partial-width-windows)
4991 (kill-local-variable 'fringe-indicator-alist)
4992 (dolist (saved visual-line--saved-state)
4993 (set (make-local-variable (car saved)) (cdr saved)))
4994 (kill-local-variable 'visual-line--saved-state)))
4996 (defun turn-on-visual-line-mode ()
4997 (visual-line-mode 1))
4999 (define-globalized-minor-mode global-visual-line-mode
5000 visual-line-mode turn-on-visual-line-mode
5001 :lighter " vl")
5003 \f
5004 (defun transpose-chars (arg)
5005 "Interchange characters around point, moving forward one character.
5006 With prefix arg ARG, effect is to take character before point
5007 and drag it forward past ARG other characters (backward if ARG negative).
5008 If no argument and at end of line, the previous two chars are exchanged."
5009 (interactive "*P")
5010 (and (null arg) (eolp) (forward-char -1))
5011 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5013 (defun transpose-words (arg)
5014 "Interchange words around point, leaving point at end of them.
5015 With prefix arg ARG, effect is to take word before or around point
5016 and drag it forward past ARG other words (backward if ARG negative).
5017 If ARG is zero, the words around or after point and around or after mark
5018 are interchanged."
5019 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5020 (interactive "*p")
5021 (transpose-subr 'forward-word arg))
5023 (defun transpose-sexps (arg)
5025 Does not work on a sexp that point is in the middle of
5026 if it is a list or string."
5027 (interactive "*p")
5028 (transpose-subr
5029 (lambda (arg)
5030 ;; Here we should try to simulate the behavior of
5031 ;; (cons (progn (forward-sexp x) (point))
5032 ;; (progn (forward-sexp (- x)) (point)))
5033 ;; Except that we don't want to rely on the second forward-sexp
5034 ;; putting us back to where we want to be, since forward-sexp-function
5035 ;; might do funny things like infix-precedence.
5036 (if (if (> arg 0)
5038 (and (not (bobp))
5040 ;; Jumping over a symbol. We might be inside it, mind you.
5041 (progn (funcall (if (> arg 0)
5042 'skip-syntax-backward 'skip-syntax-forward)
5043 "w_")
5044 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5045 ;; Otherwise, we're between sexps. Take a step back before jumping
5046 ;; to make sure we'll obey the same precedence no matter which direction
5047 ;; we're going.
5048 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5049 (cons (save-excursion (forward-sexp arg) (point))
5050 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5051 (not (zerop (funcall (if (> arg 0)
5052 'skip-syntax-forward
5053 'skip-syntax-backward)
5054 ".")))))
5055 (point)))))
5056 arg 'special))
5058 (defun transpose-lines (arg)
5059 "Exchange current line and previous line, leaving point after both.
5060 With argument ARG, takes previous line and moves it past ARG lines.
5061 With argument 0, interchanges line point is in with line mark is in."
5062 (interactive "*p")
5063 (transpose-subr (function
5064 (lambda (arg)
5065 (if (> arg 0)
5066 (progn
5067 ;; Move forward over ARG lines,
5068 ;; but create newlines if necessary.
5069 (setq arg (forward-line arg))
5071 (setq arg (1+ arg)))
5072 (if (> arg 0)
5073 (newline arg)))
5074 (forward-line arg))))
5075 arg))
5077 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5078 ;; which seems inconsistent with the ARG /= 0 case.
5079 ;; FIXME document SPECIAL.
5080 (defun transpose-subr (mover arg &optional special)
5081 "Subroutine to do the work of transposing objects.
5082 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5083 moves forward by units of the given object (e.g. forward-sentence,
5084 forward-paragraph). If ARG is zero, exchanges the current object
5085 with the one containing mark. If ARG is an integer, moves the
5086 current object past ARG following (if ARG is positive) or
5087 preceding (if ARG is negative) objects, leaving point after the
5088 current object."
5089 (let ((aux (if special mover
5090 (lambda (x)
5091 (cons (progn (funcall mover x) (point))
5092 (progn (funcall mover (- x)) (point))))))
5093 pos1 pos2)
5094 (cond
5095 ((= arg 0)
5096 (save-excursion
5097 (setq pos1 (funcall aux 1))
5098 (goto-char (or (mark) (error "No mark set in this buffer")))
5099 (setq pos2 (funcall aux 1))
5100 (transpose-subr-1 pos1 pos2))
5101 (exchange-point-and-mark))
5102 ((> arg 0)
5103 (setq pos1 (funcall aux -1))
5104 (setq pos2 (funcall aux arg))
5105 (transpose-subr-1 pos1 pos2)
5106 (goto-char (car pos2)))
5107 (t
5108 (setq pos1 (funcall aux -1))
5109 (goto-char (car pos1))
5110 (setq pos2 (funcall aux arg))
5111 (transpose-subr-1 pos1 pos2)))))
5113 (defun transpose-subr-1 (pos1 pos2)
5114 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5115 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5116 (when (> (car pos1) (car pos2))
5117 (let ((swap pos1))
5118 (setq pos1 pos2 pos2 swap)))
5119 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5120 (atomic-change-group
5121 (let (word2)
5122 ;; FIXME: We first delete the two pieces of text, so markers that
5123 ;; used to point to after the text end up pointing to before it :-(
5124 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5125 (goto-char (car pos2))
5126 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5127 (goto-char (car pos1))
5128 (insert word2))))
5129 \f
5130 (defun backward-word (&optional arg)
5131 "Move backward until encountering the beginning of a word.
5132 With argument ARG, do this that many times."
5133 (interactive "^p")
5134 (forward-word (- (or arg 1))))
5136 (defun mark-word (&optional arg allow-extend)
5137 "Set mark ARG words away from point.
5139 move to with the same argument.
5140 Interactively, if this command is repeated
5141 or (in Transient Mark mode) if the mark is active,
5142 it marks the next ARG words after the ones already marked."
5144 (cond ((and allow-extend
5145 (or (and (eq last-command this-command) (mark t))
5146 (region-active-p)))
5147 (setq arg (if arg (prefix-numeric-value arg)
5148 (if (< (mark) (point)) -1 1)))
5149 (set-mark
5150 (save-excursion
5151 (goto-char (mark))
5152 (forward-word arg)
5153 (point))))
5154 (t
5155 (push-mark
5156 (save-excursion
5157 (forward-word (prefix-numeric-value arg))
5158 (point))
5159 nil t))))
5161 (defun kill-word (arg)
5162 "Kill characters forward until encountering the end of a word.
5163 With argument ARG, do this that many times."
5164 (interactive "p")
5165 (kill-region (point) (progn (forward-word arg) (point))))
5167 (defun backward-kill-word (arg)
5168 "Kill characters backward until encountering the beginning of a word.
5169 With argument ARG, do this that many times."
5170 (interactive "p")
5171 (kill-word (- arg)))
5173 (defun current-word (&optional strict really-word)
5174 "Return the symbol or word that point is on (or a nearby one) as a string.
5175 The return value includes no text properties.
5176 If optional arg STRICT is non-nil, return nil unless point is within
5177 or adjacent to a symbol or word. In all cases the value can be nil
5178 if there is no word nearby.
5179 The function, belying its name, normally finds a symbol.
5180 If optional arg REALLY-WORD is non-nil, it finds just a word."
5181 (save-excursion
5182 (let* ((oldpoint (point)) (start (point)) (end (point))
5183 (syntaxes (if really-word "w" "w_"))
5184 (not-syntaxes (concat "^" syntaxes)))
5185 (skip-syntax-backward syntaxes) (setq start (point))
5186 (goto-char oldpoint)
5187 (skip-syntax-forward syntaxes) (setq end (point))
5188 (when (and (eq start oldpoint) (eq end oldpoint)
5189 ;; Point is neither within nor adjacent to a word.
5190 (not strict))
5191 ;; Look for preceding word in same line.
5192 (skip-syntax-backward not-syntaxes (line-beginning-position))
5193 (if (bolp)
5194 ;; No preceding word in same line.
5195 ;; Look for following word in same line.
5196 (progn
5197 (skip-syntax-forward not-syntaxes (line-end-position))
5198 (setq start (point))
5199 (skip-syntax-forward syntaxes)
5200 (setq end (point)))
5201 (setq end (point))
5202 (skip-syntax-backward syntaxes)
5203 (setq start (point))))
5204 ;; If we found something nonempty, return it as a string.
5205 (unless (= start end)
5206 (buffer-substring-no-properties start end)))))
5207 \f
5208 (defcustom fill-prefix nil
5209 "String for filling to insert at front of new line, or nil for none."
5210 :type '(choice (const :tag "None" nil)
5211 string)
5212 :group 'fill)
5213 (make-variable-buffer-local 'fill-prefix)
5214 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5216 (defcustom auto-fill-inhibit-regexp nil
5217 "Regexp to match lines which should not be auto-filled."
5218 :type '(choice (const :tag "None" nil)
5219 regexp)
5220 :group 'fill)
5222 (defun do-auto-fill ()
5223 "The default value for `normal-auto-fill-function'.
5224 This is the default auto-fill function, some major modes use a different one.
5225 Returns t if it really did any work."
5226 (let (fc justify give-up
5227 (fill-prefix fill-prefix))
5228 (if (or (not (setq justify (current-justification)))
5229 (null (setq fc (current-fill-column)))
5230 (and (eq justify 'left)
5231 (<= (current-column) fc))
5232 (and auto-fill-inhibit-regexp
5233 (save-excursion (beginning-of-line)
5234 (looking-at auto-fill-inhibit-regexp))))
5235 nil ;; Auto-filling not required
5236 (if (memq justify '(full center right))
5237 (save-excursion (unjustify-current-line)))
5239 ;; Choose a fill-prefix automatically.
5240 (when (and adaptive-fill-mode
5241 (or (null fill-prefix) (string= fill-prefix "")))
5242 (let ((prefix
5243 (fill-context-prefix
5244 (save-excursion (fill-forward-paragraph -1) (point))
5245 (save-excursion (fill-forward-paragraph 1) (point)))))
5246 (and prefix (not (equal prefix ""))
5247 ;; Use auto-indentation rather than a guessed empty prefix.
5248 (not (and fill-indent-according-to-mode
5250 (setq fill-prefix prefix))))
5252 (while (and (not give-up) (> (current-column) fc))
5253 ;; Determine where to split the line.
5254 (let* (after-prefix
5255 (fill-point
5256 (save-excursion
5257 (beginning-of-line)
5258 (setq after-prefix (point))
5259 (and fill-prefix
5260 (looking-at (regexp-quote fill-prefix))
5261 (setq after-prefix (match-end 0)))
5262 (move-to-column (1+ fc))
5263 (fill-move-to-break-point after-prefix)
5264 (point))))
5266 ;; See whether the place we found is any good.
5267 (if (save-excursion
5268 (goto-char fill-point)
5269 (or (bolp)
5270 ;; There is no use breaking at end of line.
5271 (save-excursion (skip-chars-forward " ") (eolp))
5272 ;; It is futile to split at the end of the prefix
5273 ;; since we would just insert the prefix again.
5274 (and after-prefix (<= (point) after-prefix))
5275 ;; Don't split right after a comment starter
5276 ;; since we would just make another comment starter.
5277 (and comment-start-skip
5278 (let ((limit (point)))
5279 (beginning-of-line)
5280 (and (re-search-forward comment-start-skip
5281 limit t)
5282 (eq (point) limit))))))
5283 ;; No good place to break => stop trying.
5284 (setq give-up t)
5285 ;; Ok, we have a useful place to break the line. Do it.
5286 (let ((prev-column (current-column)))
5287 ;; If point is at the fill-point, do not `save-excursion'.
5288 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5289 ;; point will end up before it rather than after it.
5290 (if (save-excursion
5292 (= (point) fill-point))
5293 (default-indent-new-line t)
5294 (save-excursion
5295 (goto-char fill-point)
5296 (default-indent-new-line t)))
5297 ;; Now do justification, if required
5298 (if (not (eq justify 'left))
5299 (save-excursion
5300 (end-of-line 0)
5301 (justify-current-line justify nil t)))
5302 ;; If making the new line didn't reduce the hpos of
5303 ;; the end of the line, then give up now;
5304 ;; trying again will not help.
5305 (if (>= (current-column) prev-column)
5306 (setq give-up t))))))
5307 ;; Justify last line.
5308 (justify-current-line justify t t)
5309 t)))
5311 (defvar comment-line-break-function 'comment-indent-new-line
5312 "*Mode-specific function which line breaks and continues a comment.
5313 This function is called during auto-filling when a comment syntax
5314 is defined.
5315 The function should take a single optional argument, which is a flag
5316 indicating whether it should use soft newlines.")
5318 (defun default-indent-new-line (&optional soft)
5319 "Break line at point and indent.
5320 If a comment syntax is defined, call `comment-indent-new-line'.
5322 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5323 unless optional argument SOFT is non-nil."
5324 (interactive)
5325 (if comment-start
5326 (funcall comment-line-break-function soft)
5327 ;; Insert the newline before removing empty space so that markers
5328 ;; get preserved better.
5330 (save-excursion (forward-char -1) (delete-horizontal-space))
5331 (delete-horizontal-space)
5333 (if (and fill-prefix (not adaptive-fill-mode))
5334 ;; Blindly trust a non-adaptive fill-prefix.
5335 (progn
5336 (indent-to-left-margin)
5337 (insert-before-markers-and-inherit fill-prefix))
5339 (cond
5340 ;; If there's an adaptive prefix, use it unless we're inside
5341 ;; a comment and the prefix is not a comment starter.
5342 (fill-prefix
5343 (indent-to-left-margin)
5344 (insert-and-inherit fill-prefix))
5345 ;; If we're not inside a comment, just try to indent.
5346 (t (indent-according-to-mode))))))
5348 (defvar normal-auto-fill-function 'do-auto-fill
5349 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5350 Some major modes set this.")
5352 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5353 ;; `functions' and `hooks' are usually unsafe to set, but setting
5354 ;; auto-fill-function to nil in a file-local setting is safe and
5355 ;; can be useful to prevent auto-filling.
5356 (put 'auto-fill-function 'safe-local-variable 'null)
5358 (define-minor-mode auto-fill-mode
5359 "Toggle automatic line breaking (Auto Fill mode).
5360 With a prefix argument ARG, enable Auto Fill mode if ARG is
5361 positive, and disable it otherwise. If called from Lisp, enable
5362 the mode if ARG is omitted or nil.
5364 When Auto Fill mode is enabled, inserting a space at a column
5365 beyond `current-fill-column' automatically breaks the line at a
5366 previous space.
5368 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5369 non-`nil'.
5371 The value of `normal-auto-fill-function' specifies the function to use
5372 for `auto-fill-function' when turning Auto Fill mode on."
5373 :variable (eq auto-fill-function normal-auto-fill-function))
5375 ;; This holds a document string used to document auto-fill-mode.
5376 (defun auto-fill-function ()
5377 "Automatically break line at a previous space, in insertion of text."
5378 nil)
5380 (defun turn-on-auto-fill ()
5381 "Unconditionally turn on Auto Fill mode."
5382 (auto-fill-mode 1))
5384 (defun turn-off-auto-fill ()
5385 "Unconditionally turn off Auto Fill mode."
5386 (auto-fill-mode -1))
5388 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5390 (defun set-fill-column (arg)
5391 "Set `fill-column' to specified argument.
5394 (interactive
5395 (list (or current-prefix-arg
5396 ;; We used to use current-column silently, but C-x f is too easily
5397 ;; typed as a typo for C-x C-f, so we turned it into an error and
5398 ;; now an interactive prompt.
5399 (read-number "Set fill-column to: " (current-column)))))
5400 (if (consp arg)
5401 (setq arg (current-column)))
5402 (if (not (integerp arg))
5403 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5404 (error "set-fill-column requires an explicit argument")
5405 (message "Fill column set to %d (was %d)" arg fill-column)
5406 (setq fill-column arg)))
5407 \f
5408 (defun set-selective-display (arg)
5409 "Set `selective-display' to ARG; clear it if no arg.
5410 When the value of `selective-display' is a number > 0,
5411 lines whose indentation is >= that value are not displayed.
5412 The variable `selective-display' has a separate value for each buffer."
5413 (interactive "P")
5414 (if (eq selective-display t)
5415 (error "selective-display already in use for marked lines"))
5416 (let ((current-vpos
5417 (save-restriction
5418 (narrow-to-region (point-min) (point))
5419 (goto-char (window-start))
5420 (vertical-motion (window-height)))))
5421 (setq selective-display
5422 (and arg (prefix-numeric-value arg)))
5423 (recenter current-vpos))
5424 (set-window-start (selected-window) (window-start (selected-window)))
5425 (princ "selective-display set to " t)
5426 (prin1 selective-display t)
5427 (princ "." t))
5429 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5431 (defun toggle-truncate-lines (&optional arg)
5432 "Toggle truncating of long lines for the current buffer.
5433 When truncating is off, long lines are folded.
5434 With prefix argument ARG, truncate long lines if ARG is positive,
5435 otherwise fold them. Note that in side-by-side windows, this
5436 command has no effect if `truncate-partial-width-windows' is
5437 non-nil."
5438 (interactive "P")
5439 (setq truncate-lines
5440 (if (null arg)
5441 (not truncate-lines)
5442 (> (prefix-numeric-value arg) 0)))
5443 (force-mode-line-update)
5444 (unless truncate-lines
5445 (let ((buffer (current-buffer)))
5446 (walk-windows (lambda (window)
5447 (if (eq buffer (window-buffer window))
5448 (set-window-hscroll window 0)))
5449 nil t)))
5450 (message "Truncate long lines %s"
5451 (if truncate-lines "enabled" "disabled")))
5453 (defun toggle-word-wrap (&optional arg)
5454 "Toggle whether to use word-wrapping for continuation lines.
5455 With prefix argument ARG, wrap continuation lines at word boundaries
5456 if ARG is positive, otherwise wrap them at the right screen edge.
5457 This command toggles the value of `word-wrap'. It has no effect
5458 if long lines are truncated."
5459 (interactive "P")
5460 (setq word-wrap
5461 (if (null arg)
5462 (not word-wrap)
5463 (> (prefix-numeric-value arg) 0)))
5464 (force-mode-line-update)
5465 (message "Word wrapping %s"
5466 (if word-wrap "enabled" "disabled")))
5468 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5469 "The string displayed in the mode line when in overwrite mode.")
5470 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5471 "The string displayed in the mode line when in binary overwrite mode.")
5473 (define-minor-mode overwrite-mode
5474 "Toggle Overwrite mode.
5475 With a prefix argument ARG, enable Overwrite mode if ARG is
5476 positive, and disable it otherwise. If called from Lisp, enable
5477 the mode if ARG is omitted or nil.
5479 When Overwrite mode is enabled, printing characters typed in
5480 replace existing text on a one-for-one basis, rather than pushing
5481 it to the right. At the end of a line, such characters extend
5482 the line. Before a tab, such characters insert until the tab is
5484 overwrite mode; this is supposed to make it easier to insert
5485 characters when necessary."
5486 :variable (eq overwrite-mode 'overwrite-mode-textual))
5488 (define-minor-mode binary-overwrite-mode
5489 "Toggle Binary Overwrite mode.
5490 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5491 is positive, and disable it otherwise. If called from Lisp,
5492 enable the mode if ARG is omitted or nil.
5494 When Binary Overwrite mode is enabled, printing characters typed
5495 in replace existing text. Newlines are not treated specially, so
5496 typing at the end of a line joins the line to the next, with the
5497 typed character between them. Typing before a tab character
5498 simply replaces the tab with the character typed.
5500 ordinary typing characters do.
5502 Note that Binary Overwrite mode is not its own minor mode; it is
5503 a specialization of overwrite mode, entered by setting the
5504 `overwrite-mode' variable to `overwrite-mode-binary'."
5505 :variable (eq overwrite-mode 'overwrite-mode-binary))
5507 (define-minor-mode line-number-mode
5508 "Toggle line number display in the mode line (Line Number mode).
5509 With a prefix argument ARG, enable Line Number mode if ARG is
5510 positive, and disable it otherwise. If called from Lisp, enable
5511 the mode if ARG is omitted or nil.
5513 Line numbers do not appear for very large buffers and buffers
5514 with very long lines; see variables `line-number-display-limit'
5515 and `line-number-display-limit-width'."
5516 :init-value t :global t :group 'mode-line)
5518 (define-minor-mode column-number-mode
5519 "Toggle column number display in the mode line (Column Number mode).
5520 With a prefix argument ARG, enable Column Number mode if ARG is
5521 positive, and disable it otherwise.
5523 If called from Lisp, enable the mode if ARG is omitted or nil."
5524 :global t :group 'mode-line)
5526 (define-minor-mode size-indication-mode
5527 "Toggle buffer size display in the mode line (Size Indication mode).
5528 With a prefix argument ARG, enable Size Indication mode if ARG is
5529 positive, and disable it otherwise.
5531 If called from Lisp, enable the mode if ARG is omitted or nil."
5532 :global t :group 'mode-line)
5534 (define-minor-mode auto-save-mode
5535 "Toggle auto-saving in the current buffer (Auto Save mode).
5536 With a prefix argument ARG, enable Auto Save mode if ARG is
5537 positive, and disable it otherwise.
5539 If called from Lisp, enable the mode if ARG is omitted or nil."
5540 :variable ((and buffer-auto-save-file-name
5541 ;; If auto-save is off because buffer has shrunk,
5542 ;; then toggling should turn it on.
5543 (>= buffer-saved-size 0))
5544 . (lambda (val)
5545 (setq buffer-auto-save-file-name
5546 (cond
5547 ((null val) nil)
5548 ((and buffer-file-name auto-save-visited-file-name
5549 (not buffer-read-only))
5550 buffer-file-name)
5551 (t (make-auto-save-file-name))))))
5552 ;; If -1 was stored here, to temporarily turn off saving,
5553 ;; turn it back on.
5554 (and (< buffer-saved-size 0)
5555 (setq buffer-saved-size 0)))
5556 \f
5557 (defgroup paren-blinking nil
5558 "Blinking matching of parens and expressions."
5559 :prefix "blink-matching-"
5560 :group 'paren-matching)
5562 (defcustom blink-matching-paren t
5563 "Non-nil means show matching open-paren when close-paren is inserted."
5564 :type 'boolean
5565 :group 'paren-blinking)
5567 (defcustom blink-matching-paren-on-screen t
5568 "Non-nil means show matching open-paren when it is on screen.
5569 If nil, don't show it (but the open-paren can still be shown
5570 when it is off screen).
5572 This variable has no effect if `blink-matching-paren' is nil.
5573 \(In that case, the open-paren is never shown.)
5574 It is also ignored if `show-paren-mode' is enabled."
5575 :type 'boolean
5576 :group 'paren-blinking)
5578 (defcustom blink-matching-paren-distance (* 100 1024)
5579 "If non-nil, maximum distance to search backwards for matching open-paren.
5580 If nil, search stops at the beginning of the accessible portion of the buffer."
5581 :version "23.2" ; 25->100k
5582 :type '(choice (const nil) integer)
5583 :group 'paren-blinking)
5585 (defcustom blink-matching-delay 1
5586 "Time in seconds to delay after showing a matching paren."
5587 :type 'number
5588 :group 'paren-blinking)
5590 (defcustom blink-matching-paren-dont-ignore-comments nil
5591 "If nil, `blink-matching-paren' ignores comments.
5592 More precisely, when looking for the matching parenthesis,
5593 it skips the contents of comments that end before point."
5594 :type 'boolean
5595 :group 'paren-blinking)
5597 (defun blink-matching-check-mismatch (start end)
5598 "Return whether or not START...END are matching parens.
5599 END is the current point and START is the blink position.
5600 START might be nil if no matching starter was found.
5601 Returns non-nil if we find there is a mismatch."
5602 (let* ((end-syntax (syntax-after (1- end)))
5603 (matching-paren (and (consp end-syntax)
5604 (eq (syntax-class end-syntax) 5)
5605 (cdr end-syntax))))
5606 ;; For self-matched chars like " and $, we can't know when they're
5607 ;; mismatched or unmatched, so we can only do it for parens.
5608 (when matching-paren
5609 (not (and start
5610 (or
5611 (eq (char-after start) matching-paren)
5612 ;; The cdr might hold a new paren-class info rather than
5613 ;; a matching-char info, in which case the two CDRs
5614 ;; should match.
5615 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5617 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5618 "Function to check parentheses mismatches.
5619 The function takes two arguments (START and END) where START is the
5620 position just before the opening token and END is the position right after.
5621 START can be nil, if it was not found.
5622 The function should return non-nil if the two tokens do not match.")
5624 (defun blink-matching-open ()
5625 "Move cursor momentarily to the beginning of the sexp before point."
5626 (interactive)
5627 (when (and (not (bobp))
5628 blink-matching-paren)
5629 (let* ((oldpos (point))
5630 (message-log-max nil) ; Don't log messages about paren matching.
5631 (blinkpos
5632 (save-excursion
5633 (save-restriction
5634 (if blink-matching-paren-distance
5635 (narrow-to-region
5636 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5637 (- (point) blink-matching-paren-distance))
5638 oldpos))
5639 (let ((parse-sexp-ignore-comments
5640 (and parse-sexp-ignore-comments
5641 (not blink-matching-paren-dont-ignore-comments))))
5642 (condition-case ()
5643 (progn
5644 (forward-sexp -1)
5645 ;; backward-sexp skips backward over prefix chars,
5646 ;; so move back to the matching paren.
5647 (while (and (< (point) (1- oldpos))
5648 (let ((code (syntax-after (point))))
5649 (or (eq (syntax-class code) 6)
5650 (eq (logand 1048576 (car code))
5651 1048576))))
5652 (forward-char 1))
5653 (point))
5654 (error nil))))))
5655 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5656 (cond
5657 (mismatch
5658 (if blinkpos
5659 (if (minibufferp)
5660 (minibuffer-message "Mismatched parentheses")
5661 (message "Mismatched parentheses"))
5662 (if (minibufferp)
5663 (minibuffer-message "No matching parenthesis found")
5664 (message "No matching parenthesis found"))))
5665 ((not blinkpos) nil)
5666 ((pos-visible-in-window-p blinkpos)
5667 ;; Matching open within window, temporarily move to blinkpos but only
5668 ;; if `blink-matching-paren-on-screen' is non-nil.
5669 (and blink-matching-paren-on-screen
5670 (not show-paren-mode)
5671 (save-excursion
5672 (goto-char blinkpos)
5673 (sit-for blink-matching-delay))))
5674 (t
5675 (save-excursion
5676 (goto-char blinkpos)
5677 (let ((open-paren-line-string
5678 ;; Show what precedes the open in its line, if anything.
5679 (cond
5681 (buffer-substring (line-beginning-position)
5682 (1+ blinkpos)))
5683 ;; Show what follows the open in its line, if anything.
5684 ((save-excursion
5685 (forward-char 1)
5687 (not (eolp)))
5688 (buffer-substring blinkpos
5689 (line-end-position)))
5690 ;; Otherwise show the previous nonblank line,
5691 ;; if there is one.
5693 (concat
5694 (buffer-substring (progn
5696 (line-beginning-position))
5697 (progn (end-of-line)
5699 (point)))
5700 ;; Replace the newline and other whitespace with `...'.
5701 "..."
5702 (buffer-substring blinkpos (1+ blinkpos))))
5703 ;; There is nothing to show except the char itself.
5704 (t (buffer-substring blinkpos (1+ blinkpos))))))
5705 (message "Matches %s"
5706 (substring-no-properties open-paren-line-string)))))))))
5708 (defvar blink-paren-function 'blink-matching-open
5709 "Function called, if non-nil, whenever a close parenthesis is inserted.
5710 More precisely, a char with closeparen syntax is self-inserted.")
5712 (defun blink-paren-post-self-insert-function ()
5713 (when (and (eq (char-before) last-command-event) ; Sanity check.
5714 (memq (char-syntax last-command-event) '(?\) ?\$))
5715 blink-paren-function
5716 (not executing-kbd-macro)
5717 (not noninteractive)
5718 ;; Verify an even number of quoting characters precede the close.
5719 (= 1 (logand 1 (- (point)
5720 (save-excursion
5721 (forward-char -1)
5723 (point))))))
5724 (funcall blink-paren-function)))
5726 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5727 ;; Most likely, this hook is nil, so this arg doesn't matter,
5728 ;; but I use it as a reminder that this function usually
5729 ;; likes to be run after others since it does `sit-for'.
5730 'append)
5731 \f
5732 ;; This executes C-g typed while Emacs is waiting for a command.
5733 ;; Quitting out of a program does not go through here;
5734 ;; that happens in the QUIT macro at the C code level.
5735 (defun keyboard-quit ()
5736 "Signal a `quit' condition.
5737 During execution of Lisp code, this character causes a quit directly.
5738 At top-level, as an editor command, this simply beeps."
5739 (interactive)
5740 ;; Avoid adding the region to the window selection.
5741 (setq saved-region-selection nil)
5742 (let (select-active-regions)
5743 (deactivate-mark))
5744 (if (fboundp 'kmacro-keyboard-quit)
5745 (kmacro-keyboard-quit))
5746 (setq defining-kbd-macro nil)
5747 (let ((debug-on-quit nil))
5748 (signal 'quit nil)))
5750 (defvar buffer-quit-function nil
5753 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5755 (defun keyboard-escape-quit ()
5757 This command can exit an interactive command such as `query-replace',
5758 can clear out a prefix argument or a region,
5759 can get out of the minibuffer or other recursive edit,
5760 cancel the use of the current buffer (for special-purpose buffers),
5761 or go back to just one window (by deleting all but the selected window)."
5762 (interactive)
5763 (cond ((eq last-command 'mode-exited) nil)
5764 ((region-active-p)
5765 (deactivate-mark))
5766 ((> (minibuffer-depth) 0)
5767 (abort-recursive-edit))
5768 (current-prefix-arg
5769 nil)
5770 ((> (recursion-depth) 0)
5771 (exit-recursive-edit))
5772 (buffer-quit-function
5773 (funcall buffer-quit-function))
5774 ((not (one-window-p t))
5775 (delete-other-windows))
5777 (bury-buffer))))
5779 (defun play-sound-file (file &optional volume device)
5780 "Play sound stored in FILE.
5781 VOLUME and DEVICE correspond to the keywords of the sound
5782 specification for `play-sound'."
5783 (interactive "fPlay sound file: ")
5784 (let ((sound (list :file file)))
5785 (if volume
5786 (plist-put sound :volume volume))
5787 (if device
5788 (plist-put sound :device device))
5789 (push 'sound sound)
5790 (play-sound sound)))
5792 \f
5793 (defcustom read-mail-command 'rmail
5794 "Your preference for a mail reading package.
5795 This is used by some keybindings which support reading mail.
5796 See also `mail-user-agent' concerning sending mail."
5799 (function-item :tag "Emacs interface to MH"
5801 (function :tag "Other"))
5802 :version "21.1"
5803 :group 'mail)
5805 (defcustom mail-user-agent 'message-user-agent
5806 "Your preference for a mail composition package.
5807 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5808 outgoing email message. This variable lets you specify which
5809 mail-sending package you prefer.
5811 Valid values include:
5813 `message-user-agent' -- use the Message package.
5814 See Info node `(message)'.
5815 `sendmail-user-agent' -- use the Mail package.
5816 See Info node `(emacs)Sending Mail'.
5817 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5818 See Info node `(mh-e)'.
5819 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5820 paraphernalia if Gnus is running, particularly
5821 the Gcc: header for archiving.
5823 Additional valid symbols may be available; check with the author of
5824 your package for details. The function should return non-nil if it
5825 succeeds.
5827 See also `read-mail-command' concerning reading mail."
5828 :type '(radio (function-item :tag "Message package"
5830 message-user-agent)
5831 (function-item :tag "Mail package"
5833 sendmail-user-agent)
5834 (function-item :tag "Emacs interface to MH"
5836 mh-e-user-agent)
5837 (function-item :tag "Message with full Gnus features"
5839 gnus-user-agent)
5840 (function :tag "Other"))
5841 :version "23.2" ; sendmail->message
5842 :group 'mail)
5844 (defcustom compose-mail-user-agent-warnings t
5845 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5846 If the value of `mail-user-agent' is the default, and the user
5847 appears to have customizations applying to the old default,
5848 `compose-mail' issues a warning."
5849 :type 'boolean
5850 :version "23.2"
5851 :group 'mail)
5853 (defun rfc822-goto-eoh ()
5854 "If the buffer starts with a mail header, move point to the header's end.
5855 Otherwise, moves to `point-min'.
5856 The end of the header is the start of the next line, if there is one,
5857 else the end of the last line. This function obeys RFC822."
5858 (goto-char (point-min))
5859 (when (re-search-forward
5861 (goto-char (match-beginning 0))))
5863 ;; Used by Rmail (e.g., rmail-forward).
5864 (defvar mail-encode-mml nil
5865 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5866 the outgoing message before sending it.")
5868 (defun compose-mail (&optional to subject other-headers continue
5869 switch-function yank-action send-actions
5870 return-action)
5871 "Start composing a mail message to send.
5872 This uses the user's chosen mail composition package
5873 as selected with the variable `mail-user-agent'.
5874 The optional arguments TO and SUBJECT specify recipients
5875 and the initial Subject field, respectively.
5877 OTHER-HEADERS is an alist specifying additional
5878 header fields. Elements look like (HEADER . VALUE) where both
5879 HEADER and VALUE are strings.
5881 CONTINUE, if non-nil, says to continue editing a message already
5882 being composed. Interactively, CONTINUE is the prefix argument.
5884 SWITCH-FUNCTION, if non-nil, is a function to use to
5885 switch to and display the buffer used for mail composition.
5887 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5888 to insert the raw text of the message being replied to.
5889 It has the form (FUNCTION . ARGS). The user agent will apply
5890 FUNCTION to ARGS, to insert the raw text of the original message.
5891 \(The user agent will also run `mail-citation-hook', *after* the
5892 original text has been inserted in this way.)
5894 SEND-ACTIONS is a list of actions to call when the message is sent.
5895 Each action has the form (FUNCTION . ARGS).
5897 RETURN-ACTION, if non-nil, is an action for returning to the
5898 caller. It has the form (FUNCTION . ARGS). The function is
5899 called after the mail has been sent or put aside, and the mail
5900 buffer buried."
5901 (interactive
5902 (list nil nil nil current-prefix-arg))
5904 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5905 ;; from sendmail-user-agent to message-user-agent. Some users may
5906 ;; encounter incompatibilities. This hack tries to detect problems
5907 ;; and warn about them.
5908 (and compose-mail-user-agent-warnings
5909 (eq mail-user-agent 'message-user-agent)
5910 (let (warn-vars)
5911 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5912 mail-yank-hooks mail-archive-file-name
5913 mail-default-reply-to mail-mailing-lists
5914 mail-self-blind))
5915 (and (boundp var)
5916 (symbol-value var)
5917 (push var warn-vars)))
5918 (when warn-vars
5919 (display-warning 'mail
5920 (format "\
5921 The default mail mode is now Message mode.
5922 You have the following Mail mode variable%s customized:
5924 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5925 (if (> (length warn-vars) 1) "s" "")
5926 (mapconcat 'symbol-name
5927 warn-vars " "))))))
5929 (let ((function (get mail-user-agent 'composefunc)))
5930 (funcall function to subject other-headers continue switch-function
5931 yank-action send-actions return-action)))
5933 (defun compose-mail-other-window (&optional to subject other-headers continue
5934 yank-action send-actions
5935 return-action)
5937 (interactive (list nil nil nil current-prefix-arg))
5938 (compose-mail to subject other-headers continue
5939 'switch-to-buffer-other-window yank-action send-actions
5940 return-action))
5942 (defun compose-mail-other-frame (&optional to subject other-headers continue
5943 yank-action send-actions
5944 return-action)
5946 (interactive (list nil nil nil current-prefix-arg))
5947 (compose-mail to subject other-headers continue
5948 'switch-to-buffer-other-frame yank-action send-actions
5949 return-action))
5951 \f
5952 (defvar set-variable-value-history nil
5953 "History of values entered with `set-variable'.
5955 Maximum length of the history list is determined by the value
5956 of `history-length', which see.")
5958 (defun set-variable (variable value &optional make-local)
5959 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5960 VARIABLE should be a user option variable name, a Lisp variable
5961 meant to be customized by users. You should enter VALUE in Lisp syntax,
5962 so if you want VALUE to be a string, you must surround it with doublequotes.
5963 VALUE is used literally, not evaluated.
5965 If VARIABLE has a `variable-interactive' property, that is used as if
5966 it were the arg to `interactive' (which see) to interactively read VALUE.
5968 If VARIABLE has been defined with `defcustom', then the type information
5969 in the definition is used to check that VALUE is valid.
5971 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5972 (interactive
5973 (let* ((default-var (variable-at-point))
5974 (var (if (user-variable-p default-var)
5975 (read-variable (format "Set variable (default %s): " default-var)
5976 default-var)
5977 (read-variable "Set variable: ")))
5978 (minibuffer-help-form '(describe-variable var))
5979 (prop (get var 'variable-interactive))
5980 (obsolete (car (get var 'byte-obsolete-variable)))
5981 (prompt (format "Set %s %s to value: " var
5982 (cond ((local-variable-p var)
5983 "(buffer-local)")
5984 ((or current-prefix-arg
5985 (local-variable-if-set-p var))
5986 "buffer-locally")
5987 (t "globally"))))
5988 (val (progn
5989 (when obsolete
5990 (message (concat "`%S' is obsolete; "
5991 (if (symbolp obsolete) "use `%S' instead" "%s"))
5992 var obsolete)
5993 (sit-for 3))
5994 (if prop
5995 ;; Use VAR's `variable-interactive' property
5996 ;; as an interactive spec for prompting.
5997 (call-interactively `(lambda (arg)
5998 (interactive ,prop)
5999 arg))
6000 (read
6001 (read-string prompt nil
6002 'set-variable-value-history
6003 (format "%S" (symbol-value var))))))))
6004 (list var val current-prefix-arg)))
6006 (and (custom-variable-p variable)
6007 (not (get variable 'custom-type))
6008 (custom-load-symbol variable))
6009 (let ((type (get variable 'custom-type)))
6010 (when type
6011 ;; Match with custom type.
6012 (require 'cus-edit)
6013 (setq type (widget-convert type))
6014 (unless (widget-apply type :match value)
6015 (error "Value `%S' does not match type %S of %S"
6016 value (car type) variable))))
6018 (if make-local
6019 (make-local-variable variable))
6021 (set variable value)
6023 ;; Force a thorough redisplay for the case that the variable
6024 ;; has an effect on the display, like `tab-width' has.
6025 (force-mode-line-update))
6026 \f
6027 ;; Define the major mode for lists of completions.
6029 (defvar completion-list-mode-map
6030 (let ((map (make-sparse-keymap)))
6031 (define-key map [mouse-2] 'mouse-choose-completion)
6032 (define-key map [follow-link] 'mouse-face)
6033 (define-key map [down-mouse-2] nil)
6034 (define-key map "\C-m" 'choose-completion)
6035 (define-key map "\e\e\e" 'delete-completion-window)
6036 (define-key map [left] 'previous-completion)
6037 (define-key map [right] 'next-completion)
6038 (define-key map "q" 'quit-window)
6039 (define-key map "z" 'kill-this-buffer)
6040 map)
6041 "Local map for completion list buffers.")
6043 ;; Completion mode is suitable only for specially formatted data.
6044 (put 'completion-list-mode 'mode-class 'special)
6046 (defvar completion-reference-buffer nil
6047 "Record the buffer that was current when the completion list was requested.
6048 This is a local variable in the completion list buffer.
6049 Initial value is nil to avoid some compiler warnings.")
6051 (defvar completion-no-auto-exit nil
6052 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6053 This also applies to other functions such as `choose-completion'.")
6055 (defvar completion-base-position nil
6056 "Position of the base of the text corresponding to the shown completions.
6057 This variable is used in the *Completions* buffers.
6058 Its value is a list of the form (START END) where START is the place
6059 where the completion should be inserted and END (if non-nil) is the end
6060 of the text to replace. If END is nil, point is used instead.")
6062 (defvar completion-list-insert-choice-function #'completion--replace
6063 "Function to use to insert the text chosen in *Completions*.
6064 Called with three arguments (BEG END TEXT), it should replace the text
6065 between BEG and END with TEXT. Expected to be set buffer-locally
6066 in the *Completions* buffer.")
6068 (defvar completion-base-size nil
6069 "Number of chars before point not involved in completion.
6070 This is a local variable in the completion list buffer.
6071 It refers to the chars in the minibuffer if completing in the
6072 minibuffer, or in `completion-reference-buffer' otherwise.
6073 Only characters in the field at point are included.
6075 If nil, Emacs determines which part of the tail end of the
6076 buffer's text is involved in completion by comparing the text
6077 directly.")
6078 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6080 (defun delete-completion-window ()
6081 "Delete the completion list window.
6082 Go to the window from which completion was requested."
6083 (interactive)
6084 (let ((buf completion-reference-buffer))
6085 (if (one-window-p t)
6086 (if (window-dedicated-p (selected-window))
6087 (delete-frame (selected-frame)))
6088 (delete-window (selected-window))
6089 (if (get-buffer-window buf)
6090 (select-window (get-buffer-window buf))))))
6092 (defun previous-completion (n)
6093 "Move to the previous item in the completion list."
6094 (interactive "p")
6095 (next-completion (- n)))
6097 (defun next-completion (n)
6098 "Move to the next item in the completion list.
6099 With prefix argument N, move N items (negative N means move backward)."
6100 (interactive "p")
6101 (let ((beg (point-min)) (end (point-max)))
6102 (while (and (> n 0) (not (eobp)))
6103 ;; If in a completion, move to the end of it.
6104 (when (get-text-property (point) 'mouse-face)
6105 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6106 ;; Move to start of next one.
6107 (unless (get-text-property (point) 'mouse-face)
6108 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6109 (setq n (1- n)))
6110 (while (and (< n 0) (not (bobp)))
6111 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6112 ;; If in a completion, move to the start of it.
6113 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6114 (goto-char (previous-single-property-change
6115 (point) 'mouse-face nil beg)))
6116 ;; Move to end of the previous completion.
6117 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6118 (goto-char (previous-single-property-change
6119 (point) 'mouse-face nil beg)))
6120 ;; Move to the start of that one.
6121 (goto-char (previous-single-property-change
6122 (point) 'mouse-face nil beg))
6123 (setq n (1+ n))))))
6125 (defun choose-completion (&optional event)
6126 "Choose the completion at point."
6127 (interactive (list last-nonmenu-event))
6128 ;; In case this is run via the mouse, give temporary modes such as
6129 ;; isearch a chance to turn off.
6130 (run-hooks 'mouse-leave-buffer-hook)
6131 (with-current-buffer (window-buffer (posn-window (event-start event)))
6132 (let ((buffer completion-reference-buffer)
6133 (base-size completion-base-size)
6134 (base-position completion-base-position)
6135 (insert-function completion-list-insert-choice-function)
6136 (choice
6137 (save-excursion
6138 (goto-char (posn-point (event-start event)))
6139 (let (beg end)
6140 (cond
6141 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6142 (setq end (point) beg (1+ (point))))
6143 ((and (not (bobp))
6144 (get-text-property (1- (point)) 'mouse-face))
6145 (setq end (1- (point)) beg (point)))
6146 (t (error "No completion here")))
6147 (setq beg (previous-single-property-change beg 'mouse-face))
6148 (setq end (or (next-single-property-change end 'mouse-face)
6149 (point-max)))
6150 (buffer-substring-no-properties beg end))))
6151 (owindow (selected-window)))
6153 (unless (buffer-live-p buffer)
6154 (error "Destination buffer is dead"))
6155 (select-window (posn-window (event-start event)))
6156 (if (and (one-window-p t 'selected-frame)
6157 (window-dedicated-p (selected-window)))
6158 ;; This is a special buffer's frame
6159 (iconify-frame (selected-frame))
6160 (or (window-dedicated-p (selected-window))
6161 (bury-buffer)))
6162 (select-window
6163 (or (get-buffer-window buffer 0)
6164 owindow))
6166 (with-current-buffer buffer
6167 (choose-completion-string
6168 choice buffer
6169 (or base-position
6170 (when base-size
6171 ;; Someone's using old completion code that doesn't know
6172 ;; about base-position yet.
6173 (list (+ base-size (field-beginning))))
6174 ;; If all else fails, just guess.
6175 (list (choose-completion-guess-base-position choice)))
6176 insert-function)))))
6178 ;; Delete the longest partial match for STRING
6179 ;; that can be found before POINT.
6180 (defun choose-completion-guess-base-position (string)
6181 (save-excursion
6182 (let ((opoint (point))
6183 len)
6184 ;; Try moving back by the length of the string.
6185 (goto-char (max (- (point) (length string))
6186 (minibuffer-prompt-end)))
6187 ;; See how far back we were actually able to move. That is the
6188 ;; upper bound on how much we can match and delete.
6189 (setq len (- opoint (point)))
6190 (if completion-ignore-case
6191 (setq string (downcase string)))
6192 (while (and (> len 0)
6193 (let ((tail (buffer-substring (point) opoint)))
6194 (if completion-ignore-case
6195 (setq tail (downcase tail)))
6196 (not (string= tail (substring string 0 len)))))
6197 (setq len (1- len))
6198 (forward-char 1))
6199 (point))))
6201 (defun choose-completion-delete-max-match (string)
6202 (delete-region (choose-completion-guess-base-position string) (point)))
6203 (make-obsolete 'choose-completion-delete-max-match
6204 'choose-completion-guess-base-position "23.2")
6206 (defvar choose-completion-string-functions nil
6207 "Functions that may override the normal insertion of a completion choice.
6208 These functions are called in order with four arguments:
6209 CHOICE - the string to insert in the buffer,
6210 BUFFER - the buffer in which the choice should be inserted,
6211 MINI-P - non-nil if BUFFER is a minibuffer, and
6212 BASE-SIZE - the number of characters in BUFFER before
6213 the string being completed.
6215 If a function in the list returns non-nil, that function is supposed
6216 to have inserted the CHOICE in the BUFFER, and possibly exited
6217 the minibuffer; no further functions will be called.
6219 If all functions in the list return nil, that means to use
6220 the default method of inserting the completion in BUFFER.")
6222 (defun choose-completion-string (choice &optional
6223 buffer base-position insert-function)
6224 "Switch to BUFFER and insert the completion choice CHOICE.
6225 BASE-POSITION, says where to insert the completion."
6227 ;; If BUFFER is the minibuffer, exit the minibuffer
6228 ;; unless it is reading a file name and CHOICE is a directory,
6229 ;; or completion-no-auto-exit is non-nil.
6231 ;; Some older code may call us passing `base-size' instead of
6232 ;; `base-position'. It's difficult to make any use of `base-size',
6233 ;; so we just ignore it.
6234 (unless (consp base-position)
6235 (message "Obsolete `base-size' passed to choose-completion-string")
6236 (setq base-position nil))
6238 (let* ((buffer (or buffer completion-reference-buffer))
6239 (mini-p (minibufferp buffer)))
6240 ;; If BUFFER is a minibuffer, barf unless it's the currently
6241 ;; active minibuffer.
6242 (if (and mini-p
6243 (not (and (active-minibuffer-window)
6244 (equal buffer
6245 (window-buffer (active-minibuffer-window))))))
6246 (error "Minibuffer is not active for completion")
6247 ;; Set buffer so buffer-local choose-completion-string-functions works.
6248 (set-buffer buffer)
6249 (unless (run-hook-with-args-until-success
6250 'choose-completion-string-functions
6251 ;; The fourth arg used to be `mini-p' but was useless
6252 ;; (since minibufferp can be used on the `buffer' arg)
6253 ;; and indeed unused. The last used to be `base-size', so we
6254 ;; keep it to try and avoid breaking old code.
6255 choice buffer base-position nil)
6256 ;; This remove-text-properties should be unnecessary since `choice'
6257 ;; comes from buffer-substring-no-properties.
6258 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6259 ;; Insert the completion into the buffer where it was requested.
6260 (funcall (or insert-function completion-list-insert-choice-function)
6261 (or (car base-position) (point))
6262 (or (cadr base-position) (point))
6263 choice)
6264 ;; Update point in the window that BUFFER is showing in.
6265 (let ((window (get-buffer-window buffer t)))
6266 (set-window-point window (point)))
6267 ;; If completing for the minibuffer, exit it with this choice.
6268 (and (not completion-no-auto-exit)
6269 (minibufferp buffer)
6270 minibuffer-completion-table
6271 ;; If this is reading a file name, and the file name chosen
6272 ;; is a directory, don't exit the minibuffer.
6273 (let* ((result (buffer-substring (field-beginning) (point)))
6274 (bounds
6275 (completion-boundaries result minibuffer-completion-table
6276 minibuffer-completion-predicate
6277 "")))
6278 (if (eq (car bounds) (length result))
6279 ;; The completion chosen leads to a new set of completions
6280 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6281 (let ((mini (active-minibuffer-window)))
6282 (select-window mini)
6283 (when minibuffer-auto-raise
6284 (raise-frame (window-frame mini))))
6285 (exit-minibuffer))))))))
6287 (define-derived-mode completion-list-mode nil "Completion List"
6288 "Major mode for buffers showing lists of possible completions.
6290 to select the completion near point.
6292 with the mouse.
6295 (set (make-local-variable 'completion-base-size) nil))
6297 (defun completion-list-mode-finish ()
6298 "Finish setup of the completions buffer.
6299 Called from `temp-buffer-show-hook'."
6300 (when (eq major-mode 'completion-list-mode)
6301 (toggle-read-only 1)))
6303 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6306 ;; Variables and faces used in `completion-setup-function'.
6308 (defcustom completion-show-help t
6309 "Non-nil means show help message in *Completions* buffer."
6310 :type 'boolean
6311 :version "22.1"
6312 :group 'completion)
6314 ;; This function goes in completion-setup-hook, so that it is called
6315 ;; after the text of the completion list buffer is written.
6316 (defun completion-setup-function ()
6317 (let* ((mainbuf (current-buffer))
6318 (base-dir
6319 ;; When reading a file name in the minibuffer,
6320 ;; try and find the right default-directory to set in the
6321 ;; completion list buffer.
6322 ;; FIXME: Why do we do that, actually? --Stef
6323 (if minibuffer-completing-file-name
6324 (file-name-as-directory
6325 (expand-file-name
6326 (substring (minibuffer-completion-contents)
6327 0 (or completion-base-size 0)))))))
6328 (with-current-buffer standard-output
6329 (let ((base-size completion-base-size) ;Read before killing localvars.
6330 (base-position completion-base-position)
6331 (insert-fun completion-list-insert-choice-function))
6332 (completion-list-mode)
6333 (set (make-local-variable 'completion-base-size) base-size)
6334 (set (make-local-variable 'completion-base-position) base-position)
6335 (set (make-local-variable 'completion-list-insert-choice-function)
6336 insert-fun))
6337 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6338 (if base-dir (setq default-directory base-dir))
6339 ;; Maybe insert help string.
6340 (when completion-show-help
6341 (goto-char (point-min))
6342 (if (display-mouse-p)
6343 (insert (substitute-command-keys
6345 (insert (substitute-command-keys
6349 (add-hook 'completion-setup-hook 'completion-setup-function)
6351 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6352 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6354 (defun switch-to-completions ()
6355 "Select the completion list window."
6356 (interactive)
6357 (let ((window (or (get-buffer-window "*Completions*" 0)
6358 ;; Make sure we have a completions window.
6359 (progn (minibuffer-completion-help)
6360 (get-buffer-window "*Completions*" 0)))))
6361 (when window
6362 (select-window window)
6363 ;; In the new buffer, go to the first completion.
6364 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6365 (when (bobp)
6366 (next-completion 1)))))
6367 \f
6368 ;;; Support keyboard commands to turn on various modifiers.
6370 ;; These functions -- which are not commands -- each add one modifier
6371 ;; to the following event.
6373 (defun event-apply-alt-modifier (_ignore-prompt)
6376 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6377 (defun event-apply-super-modifier (_ignore-prompt)
6380 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6381 (defun event-apply-hyper-modifier (_ignore-prompt)
6384 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6385 (defun event-apply-shift-modifier (_ignore-prompt)
6388 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6389 (defun event-apply-control-modifier (_ignore-prompt)
6392 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6393 (defun event-apply-meta-modifier (_ignore-prompt)
6396 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6398 (defun event-apply-modifier (event symbol lshiftby prefix)
6399 "Apply a modifier flag to event EVENT.
6400 SYMBOL is the name of this modifier, as a symbol.
6401 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6402 PREFIX is the string that represents this modifier in an event type symbol."
6403 (if (numberp event)
6404 (cond ((eq symbol 'control)
6405 (if (and (<= (downcase event) ?z)
6406 (>= (downcase event) ?a))
6407 (- (downcase event) ?a -1)
6408 (if (and (<= (downcase event) ?Z)
6409 (>= (downcase event) ?A))
6410 (- (downcase event) ?A -1)
6411 (logior (lsh 1 lshiftby) event))))
6412 ((eq symbol 'shift)
6413 (if (and (<= (downcase event) ?z)
6414 (>= (downcase event) ?a))
6415 (upcase event)
6416 (logior (lsh 1 lshiftby) event)))
6417 (t
6418 (logior (lsh 1 lshiftby) event)))
6419 (if (memq symbol (event-modifiers event))
6420 event
6421 (let ((event-type (if (symbolp event) event (car event))))
6422 (setq event-type (intern (concat prefix (symbol-name event-type))))
6423 (if (symbolp event)
6424 event-type
6425 (cons event-type (cdr event)))))))
6427 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6428 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6429 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6430 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6431 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6432 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6433 \f
6434 ;;;; Keypad support.
6436 ;; Make the keypad keys act like ordinary typing keys. If people add
6437 ;; bindings for the function key symbols, then those bindings will
6438 ;; override these, so this shouldn't interfere with any existing
6439 ;; bindings.
6441 ;; Also tell read-char how to handle these keys.
6442 (mapc
6443 (lambda (keypad-normal)
6444 (let ((keypad (nth 0 keypad-normal))
6445 (normal (nth 1 keypad-normal)))
6446 (put keypad 'ascii-character normal)
6447 (define-key function-key-map (vector keypad) (vector normal))))
6448 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6449 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6450 (kp-space ?\s)
6453 (kp-multiply ?*)
6454 (kp-add ?+)
6455 (kp-separator ?,)
6456 (kp-subtract ?-)
6457 (kp-decimal ?.)
6458 (kp-divide ?/)
6459 (kp-equal ?=)
6460 ;; Do the same for various keys that are represented as symbols under
6461 ;; GUIs but naturally correspond to characters.
6462 (backspace 127)
6463 (delete 127)
6466 (clear ?\C-l)
6467 (return ?\C-m)
6468 (escape ?\e)
6469 ))
6470 \f
6471 ;;;;
6472 ;;;; forking a twin copy of a buffer.
6473 ;;;;
6475 (defvar clone-buffer-hook nil
6476 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6478 (defvar clone-indirect-buffer-hook nil
6479 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6481 (defun clone-process (process &optional newname)
6482 "Create a twin copy of PROCESS.
6483 If NEWNAME is nil, it defaults to PROCESS' name;
6484 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6485 If PROCESS is associated with a buffer, the new process will be associated
6486 with the current buffer instead.
6487 Returns nil if PROCESS has already terminated."
6488 (setq newname (or newname (process-name process)))
6490 (setq newname (substring newname 0 (match-beginning 0))))
6491 (when (memq (process-status process) '(run stop open))
6492 (let* ((process-connection-type (process-tty-name process))
6493 (new-process
6494 (if (memq (process-status process) '(open))
6495 (let ((args (process-contact process t)))
6496 (setq args (plist-put args :name newname))
6497 (setq args (plist-put args :buffer
6498 (if (process-buffer process)
6499 (current-buffer))))
6500 (apply 'make-network-process args))
6501 (apply 'start-process newname
6502 (if (process-buffer process) (current-buffer))
6503 (process-command process)))))
6504 (set-process-query-on-exit-flag
6505 new-process (process-query-on-exit-flag process))
6506 (set-process-inherit-coding-system-flag
6507 new-process (process-inherit-coding-system-flag process))
6508 (set-process-filter new-process (process-filter process))
6509 (set-process-sentinel new-process (process-sentinel process))
6510 (set-process-plist new-process (copy-sequence (process-plist process)))
6511 new-process)))
6513 ;; things to maybe add (currently partly covered by `funcall mode'):
6514 ;; - syntax-table
6515 ;; - overlays
6516 (defun clone-buffer (&optional newname display-flag)
6517 "Create and return a twin copy of the current buffer.
6518 Unlike an indirect buffer, the new buffer can be edited
6519 independently of the old one (if it is not read-only).
6520 NEWNAME is the name of the new buffer. It may be modified by
6521 adding or incrementing <N> at the end as necessary to create a
6522 unique buffer name. If nil, it defaults to the name of the
6523 current buffer, with the proper suffix. If DISPLAY-FLAG is
6524 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6525 clone a file-visiting buffer, or a buffer whose major mode symbol
6526 has a non-nil `no-clone' property, results in an error.
6528 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6529 current buffer with appropriate suffix. However, if a prefix
6530 argument is given, then the command prompts for NEWNAME in the
6531 minibuffer.
6533 This runs the normal hook `clone-buffer-hook' in the new buffer
6534 after it has been set up properly in other respects."
6535 (interactive
6536 (progn
6537 (if buffer-file-name
6538 (error "Cannot clone a file-visiting buffer"))
6539 (if (get major-mode 'no-clone)
6540 (error "Cannot clone a buffer in %s mode" mode-name))
6541 (list (if current-prefix-arg
6542 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6543 t)))
6544 (if buffer-file-name
6545 (error "Cannot clone a file-visiting buffer"))
6546 (if (get major-mode 'no-clone)
6547 (error "Cannot clone a buffer in %s mode" mode-name))
6548 (setq newname (or newname (buffer-name)))
6550 (setq newname (substring newname 0 (match-beginning 0))))
6551 (let ((buf (current-buffer))
6552 (ptmin (point-min))
6553 (ptmax (point-max))
6554 (pt (point))
6555 (mk (if mark-active (mark t)))
6556 (modified (buffer-modified-p))
6557 (mode major-mode)
6558 (lvars (buffer-local-variables))
6559 (process (get-buffer-process (current-buffer)))
6560 (new (generate-new-buffer (or newname (buffer-name)))))
6561 (save-restriction
6562 (widen)
6563 (with-current-buffer new
6564 (insert-buffer-substring buf)))
6565 (with-current-buffer new
6566 (narrow-to-region ptmin ptmax)
6567 (goto-char pt)
6568 (if mk (set-mark mk))
6569 (set-buffer-modified-p modified)
6571 ;; Clone the old buffer's process, if any.
6572 (when process (clone-process process))
6574 ;; Now set up the major mode.
6575 (funcall mode)
6577 ;; Set up other local variables.
6578 (mapc (lambda (v)
6579 (condition-case () ;in case var is read-only
6580 (if (symbolp v)
6581 (makunbound v)
6582 (set (make-local-variable (car v)) (cdr v)))
6583 (error nil)))
6584 lvars)
6586 ;; Run any hooks (typically set up by the major mode
6587 ;; for cloning to work properly).
6588 (run-hooks 'clone-buffer-hook))
6589 (if display-flag
6590 ;; Presumably the current buffer is shown in the selected frame, so
6591 ;; we want to display the clone elsewhere.
6592 (let ((same-window-regexps nil)
6593 (same-window-buffer-names))
6594 (pop-to-buffer new)))
6595 new))
6598 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6599 "Create an indirect buffer that is a twin copy of the current buffer.
6601 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6602 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6603 or if not called with a prefix arg, NEWNAME defaults to the current
6604 buffer's name. The name is modified by adding a `<N>' suffix to it
6605 or by incrementing the N in an existing suffix. Trying to clone a
6606 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6607 property results in an error.
6609 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6610 This is always done when called interactively.
6612 Optional third arg NORECORD non-nil means do not put this buffer at the
6613 front of the list of recently selected ones."
6614 (interactive
6615 (progn
6616 (if (get major-mode 'no-clone-indirect)
6617 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6618 (list (if current-prefix-arg
6619 (read-buffer "Name of indirect buffer: " (current-buffer)))
6620 t)))
6621 (if (get major-mode 'no-clone-indirect)
6622 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6623 (setq newname (or newname (buffer-name)))
6625 (setq newname (substring newname 0 (match-beginning 0))))
6626 (let* ((name (generate-new-buffer-name newname))
6627 (buffer (make-indirect-buffer (current-buffer) name t)))
6628 (with-current-buffer buffer
6629 (run-hooks 'clone-indirect-buffer-hook))
6630 (when display-flag
6631 (pop-to-buffer buffer norecord))
6632 buffer))
6635 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6636 "Like `clone-indirect-buffer' but display in another window."
6637 (interactive
6638 (progn
6639 (if (get major-mode 'no-clone-indirect)
6640 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6641 (list (if current-prefix-arg
6642 (read-buffer "Name of indirect buffer: " (current-buffer)))
6643 t)))
6644 (let ((pop-up-windows t))
6645 (clone-indirect-buffer newname display-flag norecord)))
6647 \f
6648 ;;; Handling of Backspace and Delete keys.
6650 (defcustom normal-erase-is-backspace 'maybe
6651 "Set the default behavior of the Delete and Backspace keys.
6653 If set to t, Delete key deletes forward and Backspace key deletes
6654 backward.
6656 If set to nil, both Delete and Backspace keys delete backward.
6658 If set to 'maybe (which is the default), Emacs automatically
6659 selects a behavior. On window systems, the behavior depends on
6660 the keyboard used. If the keyboard has both a Backspace key and
6661 a Delete key, and both are mapped to their usual meanings, the
6662 option's default value is set to t, so that Backspace can be used
6663 to delete backward, and Delete can be used to delete forward.
6665 If not running under a window system, customizing this option
6666 accomplishes a similar effect by mapping C-h, which is usually
6667 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6668 via `keyboard-translate'. The former functionality of C-h is
6669 available on the F1 key. You should probably not use this
6670 setting if you don't have both Backspace, Delete and F1 keys.
6672 Setting this variable with setq doesn't take effect. Programmatically,
6673 call `normal-erase-is-backspace-mode' (which see) instead."
6674 :type '(choice (const :tag "Off" nil)
6675 (const :tag "Maybe" maybe)
6676 (other :tag "On" t))
6677 :group 'editing-basics
6678 :version "21.1"
6679 :set (lambda (symbol value)
6680 ;; The fboundp is because of a problem with :set when
6681 ;; dumping Emacs. It doesn't really matter.
6682 (if (fboundp 'normal-erase-is-backspace-mode)
6683 (normal-erase-is-backspace-mode (or value 0))
6684 (set-default symbol value))))
6686 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6687 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6688 (unless frame (setq frame (selected-frame)))
6689 (with-selected-frame frame
6690 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6691 (normal-erase-is-backspace-mode
6692 (if (if (eq normal-erase-is-backspace 'maybe)
6693 (and (not noninteractive)
6694 (or (memq system-type '(ms-dos windows-nt))
6695 (memq window-system '(ns))
6696 (and (memq window-system '(x))
6697 (fboundp 'x-backspace-delete-keys-p)
6698 (x-backspace-delete-keys-p))
6699 ;; If the terminal Emacs is running on has erase char
6700 ;; set to ^H, use the Backspace key for deleting
6701 ;; backward, and the Delete key for deleting forward.
6702 (and (null window-system)
6703 (eq tty-erase-char ?\^H))))
6704 normal-erase-is-backspace)
6705 1 0)))))
6707 (define-minor-mode normal-erase-is-backspace-mode
6708 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6709 With a prefix argument ARG, enable this feature if ARG is
6710 positive, and disable it otherwise. If called from Lisp, enable
6711 the mode if ARG is omitted or nil.
6713 On window systems, when this mode is on, Delete is mapped to C-d
6714 and Backspace is mapped to DEL; when this mode is off, both
6715 Delete and Backspace are mapped to DEL. (The remapping goes via
6716 `local-function-key-map', so binding Delete or Backspace in the
6717 global or local keymap will override that.)
6719 In addition, on window systems, the bindings of C-Delete, M-Delete,
6720 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6721 the global keymap in accordance with the functionality of Delete and
6722 Backspace. For example, if Delete is remapped to C-d, which deletes
6723 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6724 to DEL, which deletes backward, C-Delete is bound to
6725 `backward-kill-word'.
6727 If not running on a window system, a similar effect is accomplished by
6728 remapping C-h (normally produced by the Backspace key) and DEL via
6729 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6730 to C-d; if it's off, the keys are not remapped.
6732 When not running on a window system, and this mode is turned on, the
6733 former functionality of C-h is available on the F1 key. You should
6734 probably not turn on this mode on a text-only terminal if you don't
6735 have both Backspace, Delete and F1 keys.
6737 See also `normal-erase-is-backspace'."
6738 :variable (eq (terminal-parameter
6739 nil 'normal-erase-is-backspace) 1)
6740 (let ((enabled (eq 1 (terminal-parameter
6741 nil 'normal-erase-is-backspace))))
6743 (cond ((or (memq window-system '(x w32 ns pc))
6744 (memq system-type '(ms-dos windows-nt)))
6745 (let ((bindings
6746 `(([M-delete] [M-backspace])
6747 ([C-M-delete] [C-M-backspace])
6748 ([?\e C-delete] [?\e C-backspace]))))
6750 (if enabled
6751 (progn
6752 (define-key local-function-key-map [delete] [deletechar])
6753 (define-key local-function-key-map [kp-delete] [?\C-d])
6754 (define-key local-function-key-map [backspace] [?\C-?])
6755 (dolist (b bindings)
6756 ;; Not sure if input-decode-map is really right, but
6757 ;; keyboard-translate-table (used below) only works
6758 ;; for integer events, and key-translation-table is
6759 ;; global (like the global-map, used earlier).
6760 (define-key input-decode-map (car b) nil)
6761 (define-key input-decode-map (cadr b) nil)))
6762 (define-key local-function-key-map [delete] [?\C-?])
6763 (define-key local-function-key-map [kp-delete] [?\C-?])
6764 (define-key local-function-key-map [backspace] [?\C-?])
6765 (dolist (b bindings)
6766 (define-key input-decode-map (car b) (cadr b))
6767 (define-key input-decode-map (cadr b) (car b))))))
6768 (t
6769 (if enabled
6770 (progn
6771 (keyboard-translate ?\C-h ?\C-?)
6772 (keyboard-translate ?\C-? ?\C-d))
6773 (keyboard-translate ?\C-h ?\C-h)
6774 (keyboard-translate ?\C-? ?\C-?))))
6776 (if (called-interactively-p 'interactive)
6777 (message "Delete key deletes %s"
6778 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6779 "forward" "backward")))))
6780 \f
6781 (defvar vis-mode-saved-buffer-invisibility-spec nil
6782 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6784 (define-minor-mode visible-mode
6785 "Toggle making all invisible text temporarily visible (Visible mode).
6786 With a prefix argument ARG, enable Visible mode if ARG is
6787 positive, and disable it otherwise. If called from Lisp, enable
6788 the mode if ARG is omitted or nil.
6790 This mode works by saving the value of `buffer-invisibility-spec'
6791 and setting it to nil."
6792 :lighter " Vis"
6793 :group 'editing-basics
6794 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6795 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6796 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6797 (when visible-mode
6798 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6799 buffer-invisibility-spec)
6800 (setq buffer-invisibility-spec nil)))
6801 \f
6802 ;; Minibuffer prompt stuff.
6804 ;;(defun minibuffer-prompt-modification (start end)
6805 ;; (error "You cannot modify the prompt"))
6806 ;;
6807 ;;
6808 ;;(defun minibuffer-prompt-insertion (start end)
6809 ;; (let ((inhibit-modification-hooks t))
6810 ;; (delete-region start end)
6811 ;; ;; Discard undo information for the text insertion itself
6812 ;; ;; and for the text deletion.above.
6813 ;; (when (consp buffer-undo-list)
6814 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6815 ;; (message "You cannot modify the prompt")))
6816 ;;
6817 ;;
6818 ;;(setq minibuffer-prompt-properties
6819 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6820 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6822 \f
6823 ;;;; Problematic external packages.
6825 ;; rms says this should be done by specifying symbols that define
6826 ;; versions together with bad values. This is therefore not as
6827 ;; flexible as it could be. See the thread:
6828 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6829 (defconst bad-packages-alist
6830 ;; Not sure exactly which semantic versions have problems.
6831 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6833 "The version of `semantic' loaded does not work in Emacs 22.
6834 It can cause constant high CPU load.
6835 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6836 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6837 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6838 ;; provided the `CUA-mode' feature. Since this is no longer true,
6839 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6840 (CUA-mode t nil
6841 "CUA-mode is now part of the standard GNU Emacs distribution,
6842 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6844 You have loaded an older version of CUA-mode which does not work
6845 correctly with this version of Emacs. You should remove the old
6846 version and use the one distributed with Emacs."))
6847 "Alist of packages known to cause problems in this version of Emacs.
6848 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6849 PACKAGE is either a regular expression to match file names, or a
6850 symbol (a feature name); see the documentation of
6851 `after-load-alist', to which this variable adds functions.
6852 SYMBOL is either the name of a string variable, or `t'. Upon
6853 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6854 warning using STRING as the message.")
6856 (defun bad-package-check (package)
6857 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6858 (condition-case nil
6859 (let* ((list (assoc package bad-packages-alist))
6860 (symbol (nth 1 list)))
6861 (and list
6862 (boundp symbol)
6863 (or (eq symbol t)
6864 (and (stringp (setq symbol (eval symbol)))
6865 (string-match-p (nth 2 list) symbol)))
6866 (display-warning package (nth 3 list) :warning)))
6867 (error nil)))
6869 (mapc (lambda (elem)
6870 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6871 bad-packages-alist)
6874 (provide 'simple)
6876 ;;; simple.el ends here