| blob | c968ac01b0d38453f1387be08b1ed663657b3733 |
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 "Return the number of words between START and END.
953 If called interactively, print a message reporting the number of
954 lines, words, and characters in the region."
966 words
968 words))
971 "Display the number of lines, words, and characters in the buffer.
972 In Transient Mark mode when the mark is active, display the
973 number of lines, words, and characters in the region."
986 str
994 "Print the current buffer line number and narrowed line number of point."
1007 "Return number of lines between START and END.
1008 This is usually the number of newlines between them,
1009 but can be one more if START is not equal to END
1010 and the greater of them is not at the start of a line."
1026 done)))
1030 "Return (narrowed) buffer line number at position POS.
1031 If POS is nil, use current buffer location.
1032 Counting starts at (point-min), so the value refers
1033 to the contents of the accessible portion of the buffer."
1043 "Print info on cursor position (on screen and within buffer).
1044 Also describe the character after point, and give its character code
1045 in octal, decimal and hex.
1047 For a non-ASCII multibyte character, also give its encoding in the
1048 buffer's selected coding system if the coding system encodes the
1049 character safely. If the character is encoded into one byte, that
1050 code is shown in hex. If the character is encoded into more than one
1053 In addition, with prefix argument, show details about that character
1054 in *Help* buffer. See also the command `describe-char'."
1059 ;; If the character is one of LRE, LRO, RLE, RLO, it
1060 ;; will start a directional embedding, which could
1061 ;; completely disrupt the rest of the line (e.g., RLO
1062 ;; will display the rest of the line right-to-left).
1063 ;; So we put an invisible PDF character after these
1064 ;; characters, to end the embedding, which eliminates
1065 ;; any effects on the rest of the line.
1067 ;; Strong right-to-left characters cause reordering of
1068 ;; the following numerical characters which show the
1069 ;; codepoint, so append LRM to countermand that.
1079 ;; Avoid overflow from multiplying by 100!
1083 ""
1089 pos total percent beg end col hscroll)
1091 pos total col hscroll))
1093 encoded encoding-msg display-prop under-display)
1100 ;; Check if the character is displayed with some `display'
1101 ;; text property. In that case, set under-display to the
1102 ;; buffer substring covered by that property.
1113 under-display)))
1119 char char char under-display)
1121 char char char under-display display-prop))
1124 char char char
1126 "..."
1130 ;; We show the detailed information about CHAR.
1137 bidi-fixer
1138 encoding-msg pos total percent beg end col hscroll)
1145 bidi-fixer encoding-msg pos total percent col hscroll))))))
1146 \f
1147 ;; Initialize read-expression-map. It is defined at C level.
1150 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1151 ;; too rarely useful.
1161 "The current default value or list of default values in the minibuffer.
1162 The functions `read-from-minibuffer' and `completing-read' bind
1166 "Value for `print-level' while printing value in `eval-expression'.
1167 A value of nil means no limit."
1173 "Value for `print-length' while printing value in `eval-expression'.
1174 A value of nil means no limit."
1180 "If non-nil set `debug-on-error' to t in `eval-expression'.
1181 If nil, don't change the value of `debug-on-error'."
1187 "Format VALUE as a result of evaluated expression.
1188 Return a formatted string which is displayed in the echo area
1189 in addition to the value printed by prin1 in functions which
1190 display the result of expression evaluation."
1203 ;; We define this, rather than making `eval' interactive,
1204 ;; for the sake of completion of names like eval-region, eval-buffer.
1207 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1208 When called interactively, read an Emacs Lisp expression and
1209 evaluate it.
1210 Value is also consed on to front of the variable `values'.
1211 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1212 with prefix argument) means insert the result into the current buffer
1213 instead of printing it in the echo area. Truncates long output
1214 according to the value of the variables `eval-expression-print-length'
1215 and `eval-expression-print-level'.
1217 If `eval-expression-debug-on-error' is non-nil, which is the default,
1218 this command arranges for all errors to enter the debugger."
1222 nil read-expression-map t
1224 current-prefix-arg))
1229 ;; Bind debug-on-error to something unique so that we can
1230 ;; detect when evalled code changes it.
1234 ;; If evalled code has changed the value of debug-on-error,
1235 ;; propagate that change to the global binding.
1251 "Prompting with PROMPT, let user edit COMMAND and eval result.
1252 COMMAND is a Lisp expression. Let user edit that expression in
1253 the minibuffer, then read and evaluate the result."
1260 read-expression-map t
1262 ;; If command was added to command-history as a string,
1263 ;; get rid of that. We want only evaluable expressions there.
1267 ;; If command to be redone does not match front of history,
1268 ;; add it to the history.
1274 "Edit and re-evaluate last complex command, or ARGth from last.
1275 A complex command is one which used the minibuffer.
1276 The command is placed in the minibuffer as a Lisp form for editing.
1277 The result is executed, repeating the command as changed.
1278 If the command has been changed or is not the most recent previous
1279 command it is added to the front of the command history.
1280 You can use the minibuffer history commands \
1282 to get different commands to edit and resubmit."
1285 newcmd)
1297 ;; If command was added to command-history as a
1298 ;; string, get rid of that. We want only
1299 ;; evaluable expressions there.
1303 ;; If command to be redone does not match front of history,
1304 ;; add it to the history.
1313 "Read command name to invoke in `execute-extended-command'."
1318 ;; Get a command name at point in the original buffer
1319 ;; to propose it after M-n.
1323 ;; Read a string, completing from and restricting to the set of
1324 ;; all defined commands. Don't provide any initial input.
1325 ;; Save the command read on the extended-command history list.
1336 ;; This isn't strictly correct if `execute-extended-command'
1337 ;; is bound to anything else (e.g. [menu]).
1338 ;; It could use (key-description (this-single-command-keys)),
1339 ;; but actually a prompt other than "M-x" would be confusing,
1340 ;; because "M-x" is a well-known prompt to read a command
1341 ;; and it serves as a shorthand for "Extended command: ".
1345 \f
1347 "Default minibuffer history list.
1348 This is used for all minibuffer input
1349 except when an alternate history list is specified.
1351 Maximum length of the history list is determined by the value
1354 "Control whether history list elements are expressions or strings.
1355 If the value of this variable equals current minibuffer depth,
1356 they are expressions; otherwise they are strings.
1357 \(That convention is designed to do the right thing for
1364 "Text that was in this minibuffer before any history commands.
1365 This is nil if there have not yet been any history commands
1374 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1378 "Minibuffer history variables for which matching should ignore case.
1379 If a history variable is a member of this list, then the
1381 commands ignore case when searching it, regardless of `case-fold-search'."
1386 "Find the previous history element that matches REGEXP.
1387 \(Previous history elements refer to earlier actions.)
1388 With prefix argument N, search for Nth previous match.
1389 If N is negative, find the next or Nth next match.
1390 Normally, history elements are matched case-insensitively if
1391 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1392 makes the search case-sensitive.
1393 See also `minibuffer-history-case-insensitive-variables'."
1397 nil
1398 minibuffer-local-map
1399 nil
1400 'minibuffer-history-search-history
1402 ;; Use the last regexp specified, by default, if input is empty.
1407 regexp)
1417 ;; On some systems, ignore case for file names.
1419 minibuffer-history-case-insensitive-variables)
1420 t
1421 ;; Respect the user's setting for case-fold-search:
1422 case-fold-search)
1423 nil))
1424 prevpos
1425 match-string
1426 match-offset
1433 "No later matching history item"
1454 next-matching-history-element))
1458 "Find the next history element that matches REGEXP.
1459 \(The next history element refers to a more recent action.)
1460 With prefix argument N, search for Nth next match.
1461 If N is negative, find the previous or Nth previous match.
1462 Normally, history elements are matched case-insensitively if
1463 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1464 makes the search case-sensitive."
1468 nil
1469 minibuffer-local-map
1470 nil
1471 'minibuffer-history-search-history
1473 ;; Use the last regexp specified, by default, if input is empty.
1478 regexp)
1485 "Function run by `goto-history-element' before consuming default values.
1486 This is useful to dynamically add more elements to the list of default values
1487 when `goto-history-element' reaches the end of this list.
1488 Before calling this function `goto-history-element' sets the variable
1489 `minibuffer-default-add-done' to t, so it will call this function only
1490 once. In special cases, when this function needs to be called more
1491 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1495 "When nil, add more elements to the end of the list of default values.
1496 The value nil causes `goto-history-element' to add more elements to
1497 the list of defaults when it reaches the end of this list. It does
1503 "Return a list of all completions without the default value.
1504 This function is used to add all elements of the completion table to
1505 the end of the list of defaults just after the default value."
1508 minibuffer-completion-table
1509 minibuffer-completion-predicate)))
1515 "Puts element of the minibuffer history in the minibuffer.
1516 The argument NABS specifies the absolute history position."
1530 elt minibuffer-returned-to-present)
1542 previous-history-element))
1554 minibuffer-default)))
1566 elt))
1570 "Puts next element of the minibuffer history in the minibuffer.
1571 With argument N, it uses the Nth following element."
1577 "Puts previous element of the minibuffer history in the minibuffer.
1578 With argument N, it uses the Nth previous element."
1584 "Get next history element which completes the minibuffer before the point.
1585 The contents of the minibuffer after the point are deleted, and replaced
1586 by the new completion."
1592 n)
1593 ;; next-matching-history-element always puts us at (point-min).
1594 ;; Move to the position we were at before changing the buffer contents.
1595 ;; This is still sensible, because the text before point has not changed.
1599 "\
1600 Get previous history element which completes the minibuffer before the point.
1601 The contents of the minibuffer after the point are deleted, and replaced
1602 by the new completion."
1606 ;; For compatibility with the old subr of the same name.
1608 "Return the display width of the minibuffer prompt.
1609 Return 0 if current buffer is not a minibuffer."
1610 ;; Return the width of everything before the field at the end of
1611 ;; the buffer; this should be 0 for normal buffers.
1613 \f
1614 ;; isearch minibuffer history
1621 "Set up a minibuffer for using isearch to search the minibuffer history.
1622 Intended to be added to `minibuffer-setup-hook'."
1634 "Clean up the minibuffer after terminating isearch in the minibuffer."
1639 "Return the proper search function, for isearch in minibuffer history."
1646 ;; Use standard functions to search within minibuffer text
1652 found)
1653 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1654 ;; searching forward. Lazy-highlight calls this lambda with the
1655 ;; bound arg, so skip the minibuffer prompt.
1659 ;; 1. First try searching in the initial minibuffer text
1662 noerror)
1663 ;; 2. If the above search fails, start putting next/prev history
1664 ;; elements in the minibuffer successively, and search the string
1665 ;; in them. Do this only when bound is nil (i.e. not while
1666 ;; lazy-highlighting search strings in the current minibuffer text).
1678 ;; After putting the next/prev history element, search
1679 ;; the string in them again, until next-history-element
1680 ;; or previous-history-element raises an error at the
1681 ;; beginning/end of history.
1684 ;; For backward search, don't search
1685 ;; in the minibuffer prompt
1687 noerror)))
1688 ;; Return point of the new search result
1690 ;; Return nil when next(prev)-history-element fails
1694 "Display the minibuffer history search prompt.
1695 If there are no search errors, this function displays an overlay with
1696 the isearch prompt which replaces the original minibuffer prompt.
1697 Otherwise, it displays the standard isearch message returned from
1698 `isearch-message'."
1700 ;; Use standard function `isearch-message' when not in the minibuffer,
1701 ;; or search fails, or has an error (like incomplete regexp).
1702 ;; This function overwrites minibuffer text with isearch message,
1703 ;; so it's possible to see what is wrong in the search string.
1705 ;; Otherwise, put the overlay with the standard isearch prompt over
1706 ;; the initial minibuffer prompt.
1715 ;; And clear any previous isearch message.
1719 "Wrap the minibuffer history search when search fails.
1720 Move point to the first history element for a forward search,
1721 or to the last history element for a backward search."
1723 ;; When `minibuffer-history-isearch-search' fails on reaching the
1724 ;; beginning/end of the history, wrap the search to the first/last
1725 ;; minibuffer history element.
1733 "Save a function restoring the state of minibuffer history search.
1734 Save `minibuffer-history-position' to the additional state parameter
1735 in the search status stack."
1740 "Restore the minibuffer history search state.
1741 Go to the history element by the absolute history position HIST-POS."
1744 \f
1745 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1749 "Table mapping redo records to the corresponding undo one.
1750 A redo record for undo-in-region maps to t.
1760 "Within a run of consecutive undo commands, list remaining to be undone.
1764 "Undo some previous changes.
1765 Repeat this command to undo more changes.
1766 A numeric ARG serves as a repeat count.
1768 In Transient Mark mode when the mark is active, only undo changes within
1770 as an argument limits undo to changes within the current region."
1772 ;; Make last-command indicate for the next command that this was an undo.
1773 ;; That way, another undo will undo more.
1774 ;; If we get to the end of the undo history and get an error,
1775 ;; another undo command will find the undo history empty
1776 ;; and will get another error. To begin undoing the undos,
1777 ;; you must type some other command.
1780 message)
1781 ;; If we get an error in undo-start,
1782 ;; the next command should not be a "consecutive undo".
1783 ;; So set `this-command' to something other than `undo'.
1788 ;; If something (a timer or filter?) changed the buffer
1789 ;; since the previous command, don't continue the undo seq.
1793 ;; If the last undo record made was made by undo
1794 ;; it shows nothing else happened in between.
1801 ;; get rid of initial undo boundary
1803 ;; If we got this far, the next command should be a consecutive undo.
1805 ;; Check to see whether we're hitting a redo record, and if
1806 ;; so, ask the user whether she wants to skip the redo/undo pair.
1813 ;; The equiv entry might point to another redo record if we have done
1814 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1822 ;; Record the fact that the just-generated undo records come from an
1823 ;; undo operation--that is, they are redo records.
1824 ;; In the ordinary case (not within a region), map the redo
1825 ;; record to the following undos.
1826 ;; I don't know how to do that in the undo-in-region case.
1828 ;; Strip any leading undo boundaries there might be, like we do
1829 ;; above when checking.
1833 undo-equiv-table))
1834 ;; Don't specify a position in the undo record for the undo command.
1835 ;; Instead, undoing this should move point to where the change is.
1854 ;; Record what the current undo list says,
1855 ;; so the next command can tell if the buffer was modified in between.
1858 ;; Display a message announcing success.
1863 "Make BUFFER stop keeping undo information.
1864 No argument or nil as argument means do this for the current buffer."
1870 "Undo some previous changes.
1871 Repeat this command to undo more changes.
1872 A numeric ARG serves as a repeat count.
1873 Contrary to `undo', this will not redo a previous undo."
1878 "Non-nil while performing an undo.
1882 "Undo back N undo-boundaries beyond what was already undone recently.
1883 Call `undo-start' to get ready to undo recent changes,
1884 then call `undo-more' one or more times to undo them."
1889 ;; Note: The following, while pulling elements off
1890 ;; `pending-undo-list' will call primitive change functions which
1891 ;; will push more elements onto `buffer-undo-list'.
1896 ;; Deep copy of a list
1898 "Make a copy of undo list LIST."
1904 elt))
1907 "Set `pending-undo-list' to the front of the undo list.
1908 The next call to `undo-more' will undo the most recently made change.
1909 If BEG and END are specified, then only undo elements
1910 that apply to text between BEG and END are used; other undo elements
1911 are ignored. If BEG and END are nil, all undo elements are used."
1917 buffer-undo-list)))
1922 "Return a list of undo elements for the region START to END.
1923 The elements come from `buffer-undo-list', but we keep only
1924 the elements inside this region, and discard those outside this region.
1925 If we find an element that crosses an edge of this region,
1926 we stop and ignore all further elements."
1929 undo-adjusted-markers
1930 some-rejected
1931 undo-elt temp-undo-list delta)
1936 ;; This is a "was unmodified" element.
1937 ;; Keep it if we have kept everything thus far.
1944 ;; Don't put two nils together in the list
1958 ;; Loop down the earlier events adjusting their buffer
1959 ;; positions to reflect the fact that a change to the buffer
1960 ;; isn't being undone. We only need to process those element
1961 ;; types which undo-elt-in-region will return as being in
1962 ;; the region since only those types can ever get into the
1963 ;; output
1972 ;; (TEXT . POSITION)
1979 ;; (BEGIN . END)
1984 ;; (nil PROPERTY VALUE BEG . END)
1994 "Determine whether UNDO-ELT falls inside the region START ... END.
1995 If it crosses the edge, we return nil."
2000 t)
2002 nil)
2004 ;; (TEXT . POSITION)
2008 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2009 ;; See if MARKER is inside the region.
2020 ;; (nil PROPERTY VALUE BEG . END)
2025 ;; (BEGIN . END)
2030 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2031 This assumes we have already decided that UNDO-ELT
2032 is not *inside* the region START...END."
2035 ;; (nil PROPERTY VALUE BEG . END)
2040 ;; (BEGIN . END)
2044 ;; Return the first affected buffer position and the delta for an undo element
2045 ;; delta is defined as the change in subsequent buffer positions if we *did*
2046 ;; the undo.
2050 ;; (TEXT . POSITION)
2053 ;; (BEGIN . END)
2060 "If non-nil ask about discarding undo info for the current command.
2061 Normally, Emacs discards the undo info for the current command if
2062 it exceeds `undo-outer-limit'. But if you set this option
2063 non-nil, it asks in the echo area whether to discard the info.
2064 If you answer no, there is a slight risk that Emacs might crash, so
2065 only do it if you really want to undo the command.
2067 This option is mainly intended for debugging. You have to be
2068 careful if you use it for other purposes. Garbage collection is
2069 inhibited while the question is asked, meaning that Emacs might
2070 leak memory. So you should make sure that you do not wait
2071 excessively long before answering the question."
2077 "If non-nil, an extra level of size that's ok in an undo item.
2078 We don't ask the user about truncating the undo list until the
2079 current item gets bigger than this amount.
2084 ;; When the first undo batch in an undo list is longer than
2085 ;; undo-outer-limit, this function gets called to warn the user that
2086 ;; the undo info for the current command was discarded. Garbage
2087 ;; collection is inhibited around the call, so it had better not do a
2088 ;; lot of consing.
2094 ;; Don't ask the question again unless it gets even bigger.
2095 ;; This applies, in particular, if the user quits from the question.
2096 ;; Such a quit quits out of GC, but something else will call GC
2097 ;; again momentarily. It will call this function again,
2098 ;; but we don't want to ask the question again.
2105 t)
2106 nil))
2111 "The undo info was discarded because it exceeded \
2112 `undo-outer-limit'.
2114 This is normal if you executed a command that made a huge change
2115 to the buffer. In that case, to prevent similar problems in the
2116 future, set `undo-outer-limit' to a value that is large enough to
2117 cover the maximum size of normal changes you expect a single
2118 command to make, but not so large that it might exceed the
2119 maximum memory allotted to Emacs.
2121 If you did not execute any such command, the situation is
2122 probably due to a bug and you should report it.
2124 You can disable the popping up of this buffer by adding the entry
2125 \(undo discard-info) to the user option `warning-suppress-types',
2129 t))
2130 \f
2132 "History list for some commands that read shell commands.
2134 Maximum length of the history list is determined by the value
2141 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2142 This buffer is used when `shell-command' or `shell-command-on-region'
2143 is run interactively. A value of nil means that output to stderr and
2150 "Return a list of all commands associated with the current file.
2151 This function is used to add all related commands retrieved by `mailcap'
2152 to the end of the list of defaults just after the default value."
2156 minibuffer-default))
2161 commands))
2172 map)
2176 "Read a shell command from the minibuffer.
2177 The arguments are the same as the ones of `read-from-minibuffer',
2178 except READ and KEYMAP are missing and HIST defaults
2179 to `shell-command-history'."
2187 minibuffer-local-shell-command-map
2188 nil
2190 args)))
2193 "Execute string COMMAND asynchronously in background.
2195 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2196 surrounded by whitespace and executes the command asynchronously.
2197 The output appears in the buffer `*Async Shell Command*'.
2199 In Elisp, you will often be better served by calling `start-process'
2200 directly, since it offers more control and does not impose the use of a
2201 shell (with its need to quote arguments)."
2207 current-prefix-arg
2208 shell-command-default-error-buffer))
2214 "Execute string COMMAND in inferior shell; display output, if any.
2215 With prefix argument, insert the COMMAND's output at point.
2217 If COMMAND ends in ampersand, execute it asynchronously.
2218 The output appears in the buffer `*Async Shell Command*'.
2219 That buffer is in shell mode.
2221 Otherwise, COMMAND is executed synchronously. The output appears in
2222 the buffer `*Shell Command Output*'. If the output is short enough to
2223 display in the echo area (which is determined by the variables
2224 `resize-mini-windows' and `max-mini-window-height'), it is shown
2225 there, but it is nonetheless available in buffer `*Shell Command
2226 Output*' even though that buffer is not automatically displayed.
2228 To specify a coding system for converting non-ASCII characters
2230 before this command.
2232 Noninteractive callers can specify coding systems by binding
2233 `coding-system-for-read' and `coding-system-for-write'.
2235 The optional second argument OUTPUT-BUFFER, if non-nil,
2236 says to put the output in some other buffer.
2237 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2238 If OUTPUT-BUFFER is not a buffer and not nil,
2239 insert output in current buffer. (This cannot be done asynchronously.)
2240 In either case, the buffer is first erased, and the output is
2241 inserted after point (leaving mark after it).
2243 If the command terminates without error, but generates output,
2245 the output can be displayed in the echo area or in its buffer.
2246 If the output is short enough to display in the echo area
2247 \(determined by the variable `max-mini-window-height' if
2248 `resize-mini-windows' is non-nil), it is shown there.
2249 Otherwise,the buffer containing the output is displayed.
2253 of the output.
2255 If there is no output, or if output is inserted in the current buffer,
2256 then `*Shell Command Output*' is deleted.
2258 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2259 or buffer name to which to direct the command's standard error output.
2260 If it is nil, error output is mingled with regular output.
2261 In an interactive call, the variable `shell-command-default-error-buffer'
2262 specifies the value of ERROR-BUFFER.
2264 In Elisp, you will often be better served by calling `call-process' or
2265 `start-process' directly, since it offers more control and does not impose
2266 the use of a shell (with its need to quote arguments)."
2277 current-prefix-arg
2278 shell-command-default-error-buffer))
2279 ;; Look for a handler in case default-directory is a remote file name.
2287 ;; Output goes in current buffer.
2293 temporary-file-directory)))
2294 nil)))
2297 ;; We do not use -f for csh; we will not support broken use of
2298 ;; .cshrcs. Even the BSD csh manual says to use
2299 ;; "if ($?prompt) exit" before things which are not useful
2300 ;; non-interactively. Besides, if someone wants their other
2301 ;; aliases for shell commands then they can still have them.
2305 t)
2306 nil shell-command-switch command)
2313 ;; Do no formatting while reading error file,
2314 ;; because that can run a shell command, and we
2315 ;; don't want that to cause an infinite recursion.
2317 ;; Put point after the inserted errors.
2321 ;; This is like exchange-point-and-mark, but doesn't
2322 ;; activate the mark. It is cleaner to avoid activation,
2323 ;; even though the command loop would deactivate the mark
2324 ;; because we inserted text.
2328 ;; Output goes in a separate buffer.
2329 ;; Preserve the match data in case called from a program.
2332 ;; Command ending with ampersand means asynchronous.
2336 proc)
2337 ;; Remove the ampersand.
2339 ;; If will kill a process, query first.
2347 ;; Setting buffer-read-only to nil doesn't suffice
2348 ;; if some text has a non-nil read-only property,
2349 ;; which comint sometimes adds for prompts.
2355 shell-command-switch command))
2359 ;; Use the comint filter for proper handling of carriage motion
2360 ;; (see `comint-inhibit-carriage-motion'),.
2362 ))
2363 ;; Otherwise, command is executed synchronously.
2365 output-buffer nil error-buffer)))))))
2369 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2370 MESSAGE may be either a string or a buffer.
2372 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2373 the maximum height of the echo area, as defined by `max-mini-window-height'
2374 if `resize-mini-windows' is non-nil.
2376 Returns either the string shown in the echo area, or when a pop-up
2377 buffer is used, the window used to display it.
2379 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2380 name of the buffer used to display it in the case where a pop-up buffer
2381 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2382 string and it is displayed in the echo area, it is not specified whether
2383 the contents are inserted into the buffer anyway.
2385 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2386 and only used if a buffer is displayed."
2388 ;; Trivial case where we can use the echo area
2392 ;; Trivial case where we can just remove single trailing newline
2395 ;; General case
2398 message
2407 0
2411 (<= lines
2415 max-mini-window-height))
2417 max-mini-window-height)
2421 ;; Don't use the echo area if the output buffer is
2422 ;; already displayed in the selected frame.
2424 ;; Echo area
2430 ;; Buffer
2433 not-this-window frame))))))))
2436 ;; We have a sentinel to prevent insertion of a termination message
2437 ;; in the buffer itself.
2445 &optional output-buffer replace
2446 error-buffer display-error-buffer)
2447 "Execute string COMMAND in inferior shell with region as input.
2448 Normally display output (if any) in temp buffer `*Shell Command Output*';
2449 Prefix arg means replace the region with it. Return the exit code of
2450 COMMAND.
2452 To specify a coding system for converting non-ASCII characters
2454 before this command. By default, the input (from the current buffer)
2455 is encoded in the same coding system that will be used to save the file,
2456 `buffer-file-coding-system'. If the output is going to replace the region,
2457 then it is decoded from that same coding system.
2459 The noninteractive arguments are START, END, COMMAND,
2460 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2461 Noninteractive callers can specify coding systems by binding
2462 `coding-system-for-read' and `coding-system-for-write'.
2464 If the command generates output, the output may be displayed
2465 in the echo area or in a buffer.
2466 If the output is short enough to display in the echo area
2467 \(determined by the variable `max-mini-window-height' if
2468 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2469 it is displayed in the buffer `*Shell Command Output*'. The output
2470 is available in that buffer in both cases.
2472 If there is output and an error, a message about the error
2473 appears at the end of the output.
2475 If there is no output, or if output is inserted in the current buffer,
2476 then `*Shell Command Output*' is deleted.
2478 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2479 that says to put the output in some other buffer.
2480 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2481 If OUTPUT-BUFFER is not a buffer and not nil,
2482 insert output in the current buffer.
2483 In either case, the output is inserted after point (leaving mark after it).
2485 If REPLACE, the optional fifth argument, is non-nil, that means insert
2486 the output in place of text from START to END, putting point and mark
2487 around it.
2489 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2490 or buffer name to which to direct the command's standard error output.
2491 If it is nil, error output is mingled with regular output.
2492 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2493 were any errors. (This is always t, interactively.)
2494 In an interactive call, the variable `shell-command-default-error-buffer'
2495 specifies the value of ERROR-BUFFER."
2499 ;; Do this before calling region-beginning
2500 ;; and region-end, in case subprocess output
2501 ;; relocates them while we are in the minibuffer.
2503 ;; call-interactively recognizes region-beginning and
2504 ;; region-end specially, leaving them in the history.
2506 string
2507 current-prefix-arg
2508 current-prefix-arg
2509 shell-command-default-error-buffer
2510 t)))
2516 temporary-file-directory)))
2517 nil))
2518 exit-status)
2522 ;; Replace specified region with output from command.
2524 ;; Don't muck with mark unless REPLACE says we should.
2531 t)
2532 nil shell-command-switch command))
2533 ;; It is rude to delete a buffer which the command is not using.
2534 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2535 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2536 ;; (kill-buffer shell-buffer)))
2537 ;; Don't muck with mark unless REPLACE says we should.
2539 ;; No prefix argument: put the output in a temp buffer,
2540 ;; replacing its entire contents.
2545 ;; If the input is the same buffer as the output,
2546 ;; delete everything but the specified region,
2547 ;; then replace that region with the output.
2553 shell-file-name t
2556 t)
2557 nil shell-command-switch
2558 command)))
2559 ;; Clear the output buffer, then run the command with
2560 ;; output there.
2571 buffer)
2572 nil shell-command-switch command)))
2573 ;; Report the output.
2583 ;; There's some output, display it
2585 ;; No output; error?
2592 shell-command-default-error-buffer)
2599 output))
2602 exit-status))
2605 exit-status output))))
2606 ;; Don't kill: there might be useful info in the undo-log.
2607 ;; (kill-buffer buffer)
2608 ))))
2616 ;; Do no formatting while reading error file,
2617 ;; because that can run a shell command, and we
2618 ;; don't want that to cause an infinite recursion.
2620 ;; Put point after the inserted errors.
2625 exit-status))
2628 "Execute shell command COMMAND and return its output as a string."
2631 standard-output
2635 "Process files synchronously in a separate process.
2636 Similar to `call-process', but may invoke a file handler based on
2637 `default-directory'. The current working directory of the
2638 subprocess is `default-directory'.
2640 File names in INFILE and BUFFER are handled normally, but file
2641 names in ARGS should be relative to `default-directory', as they
2642 are passed to the process verbatim. \(This is a difference to
2643 `call-process' which does not support file handlers for INFILE
2644 and BUFFER.\)
2646 Some file handlers might not support all variants, for example
2647 they might behave as if DISPLAY was nil, regardless of the actual
2648 value passed."
2650 lc stderr-file)
2660 display args)
2666 "Whether a call of `process-file' changes remote files.
2668 Per default, this variable is always set to `t', meaning that a
2669 call of `process-file' could potentially change any file on a
2670 remote host. When set to `nil', a file handler could optimize
2671 its behavior with respect to remote file attributes caching.
2673 This variable should never be changed by `setq'. Instead of, it
2677 "Start a program in a subprocess. Return the process object for it.
2679 Similar to `start-process', but may invoke a file handler based on
2680 `default-directory'. See Info node `(elisp)Magic File Names'.
2682 This handler ought to run PROGRAM, perhaps on the local host,
2683 perhaps on a remote host that corresponds to `default-directory'.
2684 In the latter case, the local part of `default-directory' becomes
2685 the working directory of the process.
2687 PROGRAM and PROGRAM-ARGS might be file names. They are not
2688 objects of file handler invocation. File handlers might not
2689 support pty association, if PROGRAM is nil."
2693 \f
2694 ;;;; Process menu
2706 "Major mode for listing the processes called by Emacs."
2718 "Recompute the list of processes for the Process List buffer.
2719 Also, delete any process that is exited or signaled."
2732 face link
2735 follow-link t
2736 process-buffer ,buf
2737 action process-menu-visit-buffer)
2746 "datagram"
2761 tabulated-list-entries))))))
2767 "Display a list of all processes.
2768 If optional argument QUERY-ONLY is non-nil, only processes with
2769 the query-on-exit flag set are listed.
2770 Any process listed as exited or signaled is actually eliminated
2771 after the listing is made.
2772 Optional argument BUFFER specifies a buffer to use, instead of
2774 The return value is always nil."
2786 nil)
2787 \f
2791 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2792 (define-key map [switch-frame] nil)
2793 (define-key map [?\C-u] 'universal-argument-more)
2794 (define-key map [?-] 'universal-argument-minus)
2795 (define-key map [?0] 'digit-argument)
2796 (define-key map [?1] 'digit-argument)
2797 (define-key map [?2] 'digit-argument)
2798 (define-key map [?3] 'digit-argument)
2799 (define-key map [?4] 'digit-argument)
2800 (define-key map [?5] 'digit-argument)
2801 (define-key map [?6] 'digit-argument)
2802 (define-key map [?7] 'digit-argument)
2803 (define-key map [?8] 'digit-argument)
2804 (define-key map [?9] 'digit-argument)
2805 (define-key map [kp-0] 'digit-argument)
2806 (define-key map [kp-1] 'digit-argument)
2807 (define-key map [kp-2] 'digit-argument)
2808 (define-key map [kp-3] 'digit-argument)
2809 (define-key map [kp-4] 'digit-argument)
2810 (define-key map [kp-5] 'digit-argument)
2811 (define-key map [kp-6] 'digit-argument)
2812 (define-key map [kp-7] 'digit-argument)
2813 (define-key map [kp-8] 'digit-argument)
2814 (define-key map [kp-9] 'digit-argument)
2815 (define-key map [kp-subtract] 'universal-argument-minus)
2816 map)
2819 (defvar universal-argument-num-events nil
2820 "Number of argument-specifying events read by `universal-argument'.
2821 `universal-argument-other-key' uses this to discard those events
2822 from (this-command-keys), and reread only the final command.")
2824 (defvar saved-overriding-map t
2825 "The saved value of `overriding-terminal-local-map'.
2829 (defun save&set-overriding-map (map)
2830 "Set `overriding-terminal-local-map' to MAP."
2831 (when (eq saved-overriding-map t)
2832 (setq saved-overriding-map overriding-terminal-local-map)
2833 (setq overriding-terminal-local-map map)))
2835 (defun restore-overriding-map ()
2836 "Restore `overriding-terminal-local-map' to its saved value."
2837 (setq overriding-terminal-local-map saved-overriding-map)
2838 (setq saved-overriding-map t))
2840 (defun universal-argument ()
2841 "Begin a numeric argument for the following command.
2846 multiplies the argument by 4 each time.
2848 which is different in effect from any particular numeric argument.
2850 (interactive)
2851 (setq prefix-arg (list 4))
2852 (setq universal-argument-num-events (length (this-command-keys)))
2853 (save&set-overriding-map universal-argument-map))
2855 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2856 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2857 (defun universal-argument-more (arg)
2858 (interactive "P")
2859 (if (consp arg)
2860 (setq prefix-arg (list (* 4 (car arg))))
2861 (if (eq arg '-)
2862 (setq prefix-arg (list -4))
2863 (setq prefix-arg arg)
2864 (restore-overriding-map)))
2865 (setq universal-argument-num-events (length (this-command-keys))))
2867 (defun negative-argument (arg)
2868 "Begin a negative numeric argument for the next command.
2870 (interactive "P")
2871 (cond ((integerp arg)
2872 (setq prefix-arg (- arg)))
2873 ((eq arg '-)
2874 (setq prefix-arg nil))
2875 (t
2876 (setq prefix-arg '-)))
2877 (setq universal-argument-num-events (length (this-command-keys)))
2878 (save&set-overriding-map universal-argument-map))
2880 (defun digit-argument (arg)
2881 "Part of the numeric argument for the next command.
2883 (interactive "P")
2884 (let* ((char (if (integerp last-command-event)
2885 last-command-event
2886 (get last-command-event 'ascii-character)))
2888 (cond ((integerp arg)
2889 (setq prefix-arg (+ (* arg 10)
2890 (if (< arg 0) (- digit) digit))))
2891 ((eq arg '-)
2892 ;; Treat -0 as just -, so that -01 will work.
2893 (setq prefix-arg (if (zerop digit) '- (- digit))))
2894 (t
2895 (setq prefix-arg digit))))
2896 (setq universal-argument-num-events (length (this-command-keys)))
2897 (save&set-overriding-map universal-argument-map))
2899 ;; For backward compatibility, minus with no modifiers is an ordinary
2900 ;; command if digits have already been entered.
2901 (defun universal-argument-minus (arg)
2902 (interactive "P")
2903 (if (integerp arg)
2904 (universal-argument-other-key arg)
2905 (negative-argument arg)))
2907 ;; Anything else terminates the argument and is left in the queue to be
2908 ;; executed as a command.
2909 (defun universal-argument-other-key (arg)
2910 (interactive "P")
2911 (setq prefix-arg arg)
2912 (let* ((key (this-command-keys))
2913 (keylist (listify-key-sequence key)))
2914 (setq unread-command-events
2915 (append (nthcdr universal-argument-num-events keylist)
2916 unread-command-events)))
2917 (reset-this-command-lengths)
2918 (restore-overriding-map))
2919 \f
2921 (defvar filter-buffer-substring-functions nil
2922 "This variable is a wrapper hook around `filter-buffer-substring'.
2923 Each member of the hook should be a function accepting four arguments:
2924 \(FUN BEG END DELETE), where FUN is itself a function of three arguments
2925 \(BEG END DELETE). The arguments BEG, END, and DELETE are the same
2926 as those of `filter-buffer-substring' in each case.
2928 The first hook function to be called receives a FUN equivalent
2929 to the default operation of `filter-buffer-substring',
2930 i.e. one that returns the buffer-substring between BEG and
2931 END (processed by any `buffer-substring-filters'). Normally,
2932 the hook function will call FUN and then do its own processing
2933 of the result. The next hook function receives a FUN equivalent
2934 to the previous hook function, calls it, and does its own
2935 processing, and so on. The overall result is that of all hook
2936 functions acting in sequence.
2938 Any hook may choose not to call FUN though, in which case it
2939 effectively replaces the default behavior with whatever it chooses.
2940 Of course, a later hook function may do the same thing.")
2942 (defvar buffer-substring-filters nil
2943 "List of filter functions for `filter-buffer-substring'.
2944 Each function must accept a single argument, a string, and return
2945 a string. The buffer substring is passed to the first function
2946 in the list, and the return value of each function is passed to
2947 the next. The final result (if `buffer-substring-filters' is
2948 nil, this is the unfiltered buffer-substring) is passed to the
2949 first function on `filter-buffer-substring-functions'.
2951 As a special convention, point is set to the start of the buffer text
2952 being operated on (i.e., the first argument of `filter-buffer-substring')
2953 before these functions are called.")
2954 (make-obsolete-variable 'buffer-substring-filters
2955 'filter-buffer-substring-functions "24.1")
2957 (defun filter-buffer-substring (beg end &optional delete)
2958 "Return the buffer substring between BEG and END, after filtering.
2959 The wrapper hook `filter-buffer-substring-functions' performs
2960 the actual filtering. The obsolete variable `buffer-substring-filters'
2961 is also consulted. If both of these are nil, no filtering is done.
2963 If DELETE is non-nil, the text between BEG and END is deleted
2964 from the buffer.
2966 This function should be used instead of `buffer-substring',
2967 `buffer-substring-no-properties', or `delete-and-extract-region'
2968 when you want to allow filtering to take place. For example,
2969 major or minor modes can use `filter-buffer-substring-functions' to
2970 extract characters that are special to a buffer, and should not
2971 be copied into other buffers."
2972 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2973 (cond
2974 ((or delete buffer-substring-filters)
2975 (save-excursion
2976 (goto-char beg)
2977 (let ((string (if delete (delete-and-extract-region beg end)
2978 (buffer-substring beg end))))
2979 (dolist (filter buffer-substring-filters)
2980 (setq string (funcall filter string)))
2981 string)))
2982 (t
2983 (buffer-substring beg end)))))
2986 ;;;; Window system cut and paste hooks.
2988 (defvar interprogram-cut-function nil
2989 "Function to call to make a killed region available to other programs.
2991 Most window systems provide some sort of facility for cutting and
2992 pasting text between the windows of different programs.
2993 This variable holds a function that Emacs calls whenever text
2994 is put in the kill ring, to make the new kill available to other
2995 programs.
2997 The function takes one argument, TEXT, which is a string containing
2998 the text which should be made available.")
3000 (defvar interprogram-paste-function nil
3001 "Function to call to get text cut from other programs.
3003 Most window systems provide some sort of facility for cutting and
3004 pasting text between the windows of different programs.
3005 This variable holds a function that Emacs calls to obtain
3006 text that other programs have provided for pasting.
3008 The function should be called with no arguments. If the function
3009 returns nil, then no other program has provided such text, and the top
3010 of the Emacs kill ring should be used. If the function returns a
3011 string, then the caller of the function \(usually `current-kill')
3012 should put this string in the kill ring as the latest kill.
3014 This function may also return a list of strings if the window
3015 system supports multiple selections. The first string will be
3016 used as the pasted text, but the other will be placed in the
3017 kill ring for easy access via `yank-pop'.
3019 Note that the function should return a string only if a program other
3020 than Emacs has provided a string for pasting; if Emacs provided the
3021 most recent string, the function should return nil. If it is
3022 difficult to tell whether Emacs or some other program provided the
3023 current string, it is probably good enough to return nil if the string
3024 is equal (according to `string=') to the last text Emacs provided.")
3025 \f
3028 ;;;; The kill ring data structure.
3030 (defvar kill-ring nil
3031 "List of killed text sequences.
3032 Since the kill ring is supposed to interact nicely with cut-and-paste
3033 facilities offered by window systems, use of this variable should
3034 interact nicely with `interprogram-cut-function' and
3035 `interprogram-paste-function'. The functions `kill-new',
3036 `kill-append', and `current-kill' are supposed to implement this
3037 interaction; you may want to use them instead of manipulating the kill
3038 ring directly.")
3040 (defcustom kill-ring-max 60
3041 "Maximum length of kill ring before oldest elements are thrown away."
3042 :type 'integer
3043 :group 'killing)
3045 (defvar kill-ring-yank-pointer nil
3046 "The tail of the kill ring whose car is the last thing yanked.")
3048 (defcustom save-interprogram-paste-before-kill nil
3049 "Save clipboard strings into kill ring before replacing them.
3050 When one selects something in another program to paste it into Emacs,
3051 but kills something in Emacs before actually pasting it,
3052 this selection is gone unless this variable is non-nil,
3053 in which case the other program's selection is saved in the `kill-ring'
3055 :type 'boolean
3056 :group 'killing
3057 :version "23.2")
3059 (defcustom kill-do-not-save-duplicates nil
3060 "Do not add a new string to `kill-ring' when it is the same as the last one."
3061 :type 'boolean
3062 :group 'killing
3063 :version "23.2")
3065 (defun kill-new (string &optional replace yank-handler)
3066 "Make STRING the latest kill in the kill ring.
3067 Set `kill-ring-yank-pointer' to point to it.
3068 If `interprogram-cut-function' is non-nil, apply it to STRING.
3069 Optional second argument REPLACE non-nil means that STRING will replace
3070 the front of the kill ring, rather than being added to the list.
3072 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3073 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3074 STRING.
3076 When the yank handler has a non-nil PARAM element, the original STRING
3077 argument is not used by `insert-for-yank'. However, since Lisp code
3078 may access and use elements from the kill ring directly, the STRING
3080 (if (> (length string) 0)
3081 (if yank-handler
3082 (put-text-property 0 (length string)
3083 'yank-handler yank-handler string))
3084 (if yank-handler
3085 (signal 'args-out-of-range
3086 (list string "yank-handler specified for empty string"))))
3087 (unless (and kill-do-not-save-duplicates
3088 (equal string (car kill-ring)))
3089 (if (fboundp 'menu-bar-update-yank-menu)
3090 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3091 (when save-interprogram-paste-before-kill
3092 (let ((interprogram-paste (and interprogram-paste-function
3093 (funcall interprogram-paste-function))))
3094 (when interprogram-paste
3095 (dolist (s (if (listp interprogram-paste)
3096 (nreverse interprogram-paste)
3097 (list interprogram-paste)))
3098 (unless (and kill-do-not-save-duplicates
3099 (equal s (car kill-ring)))
3100 (push s kill-ring))))))
3101 (unless (and kill-do-not-save-duplicates
3102 (equal string (car kill-ring)))
3103 (if (and replace kill-ring)
3104 (setcar kill-ring string)
3105 (push string kill-ring)
3106 (if (> (length kill-ring) kill-ring-max)
3107 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3108 (setq kill-ring-yank-pointer kill-ring)
3109 (if interprogram-cut-function
3110 (funcall interprogram-cut-function string)))
3111 (set-advertised-calling-convention
3112 'kill-new '(string &optional replace) "23.3")
3114 (defun kill-append (string before-p &optional yank-handler)
3115 "Append STRING to the end of the latest kill in the kill ring.
3116 If BEFORE-P is non-nil, prepend STRING to the kill.
3117 If `interprogram-cut-function' is set, pass the resulting kill to it."
3118 (let* ((cur (car kill-ring)))
3119 (kill-new (if before-p (concat string cur) (concat cur string))
3120 (or (= (length cur) 0)
3121 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3122 yank-handler)))
3123 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3125 (defcustom yank-pop-change-selection nil
3126 "If non-nil, rotating the kill ring changes the window system selection."
3127 :type 'boolean
3128 :group 'killing
3129 :version "23.1")
3131 (defun current-kill (n &optional do-not-move)
3132 "Rotate the yanking point by N places, and then return that kill.
3133 If N is zero and `interprogram-paste-function' is set to a
3134 function that returns a string or a list of strings, and if that
3135 function doesn't return nil, then that string (or list) is added
3136 to the front of the kill ring and the string (or first string in
3137 the list) is returned as the latest kill.
3139 If N is not zero, and if `yank-pop-change-selection' is
3140 non-nil, use `interprogram-cut-function' to transfer the
3141 kill at the new yank point into the window system selection.
3143 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3144 move the yanking point; just return the Nth kill forward."
3146 (let ((interprogram-paste (and (= n 0)
3147 interprogram-paste-function
3148 (funcall interprogram-paste-function))))
3149 (if interprogram-paste
3150 (progn
3151 ;; Disable the interprogram cut function when we add the new
3152 ;; text to the kill ring, so Emacs doesn't try to own the
3153 ;; selection, with identical text.
3154 (let ((interprogram-cut-function nil))
3155 (if (listp interprogram-paste)
3156 (mapc 'kill-new (nreverse interprogram-paste))
3157 (kill-new interprogram-paste)))
3158 (car kill-ring))
3159 (or kill-ring (error "Kill ring is empty"))
3160 (let ((ARGth-kill-element
3161 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3162 (length kill-ring))
3163 kill-ring)))
3164 (unless do-not-move
3165 (setq kill-ring-yank-pointer ARGth-kill-element)
3166 (when (and yank-pop-change-selection
3167 (> n 0)
3168 interprogram-cut-function)
3169 (funcall interprogram-cut-function (car ARGth-kill-element))))
3170 (car ARGth-kill-element)))))
3174 ;;;; Commands for manipulating the kill ring.
3176 (defcustom kill-read-only-ok nil
3177 "Non-nil means don't signal an error for killing read-only text."
3178 :type 'boolean
3179 :group 'killing)
3181 (put 'text-read-only 'error-conditions
3182 '(text-read-only buffer-read-only error))
3183 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3185 (defun kill-region (beg end &optional yank-handler)
3187 This deletes the text from the buffer and saves it in the kill ring.
3191 If you want to append the killed region to the last killed text,
3194 If the buffer is read-only, Emacs will beep and refrain from deleting
3195 the text, but put the text in the kill ring anyway. This means that
3196 you can use the killing commands to copy text from a read-only buffer.
3198 Lisp programs should use this function for killing text.
3199 (To delete text, use `delete-region'.)
3200 Supply two arguments, character positions indicating the stretch of text
3201 to be killed.
3203 If the previous command was also a kill command,
3204 the text killed this time appends to the text killed last time
3205 to make one entry in the kill ring."
3206 ;; Pass point first, then mark, because the order matters
3207 ;; when calling kill-append.
3208 (interactive (list (point) (mark)))
3209 (unless (and beg end)
3210 (error "The mark is not set now, so there is no region"))
3211 (condition-case nil
3212 (let ((string (filter-buffer-substring beg end t)))
3213 (when string ;STRING is nil if BEG = END
3214 ;; Add that string to the kill ring, one way or another.
3215 (if (eq last-command 'kill-region)
3216 (kill-append string (< end beg) yank-handler)
3217 (kill-new string nil yank-handler)))
3218 (when (or string (eq last-command 'kill-region))
3219 (setq this-command 'kill-region))
3220 nil)
3221 ((buffer-read-only text-read-only)
3222 ;; The code above failed because the buffer, or some of the characters
3223 ;; in the region, are read-only.
3224 ;; We should beep, in case the user just isn't aware of this.
3225 ;; However, there's no harm in putting
3226 ;; the region's text in the kill ring, anyway.
3227 (copy-region-as-kill beg end)
3228 ;; Set this-command now, so it will be set even if we get an error.
3229 (setq this-command 'kill-region)
3230 ;; This should barf, if appropriate, and give us the correct error.
3231 (if kill-read-only-ok
3232 (progn (message "Read only text copied to kill ring") nil)
3233 ;; Signal an error if the buffer is read-only.
3234 (barf-if-buffer-read-only)
3235 ;; If the buffer isn't read-only, the text is.
3236 (signal 'text-read-only (list (current-buffer)))))))
3237 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3239 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3240 ;; to get two copies of the text when the user accidentally types M-w and
3241 ;; then corrects it with the intended C-w.
3242 (defun copy-region-as-kill (beg end)
3243 "Save the region as if killed, but don't kill it.
3244 In Transient Mark mode, deactivate the mark.
3245 If `interprogram-cut-function' is non-nil, also save the text for a window
3246 system cut and paste.
3248 This command's old key binding has been given to `kill-ring-save'."
3249 (interactive "r")
3250 (if (eq last-command 'kill-region)
3251 (kill-append (filter-buffer-substring beg end) (< end beg))
3252 (kill-new (filter-buffer-substring beg end)))
3253 (setq deactivate-mark t)
3254 nil)
3256 (defun kill-ring-save (beg end)
3257 "Save the region as if killed, but don't kill it.
3258 In Transient Mark mode, deactivate the mark.
3259 If `interprogram-cut-function' is non-nil, also save the text for a window
3260 system cut and paste.
3262 If you want to append the killed line to the last killed text,
3265 This command is similar to `copy-region-as-kill', except that it gives
3266 visual feedback indicating the extent of the region being copied."
3267 (interactive "r")
3268 (copy-region-as-kill beg end)
3269 ;; This use of called-interactively-p is correct
3270 ;; because the code it controls just gives the user visual feedback.
3271 (if (called-interactively-p 'interactive)
3272 (let ((other-end (if (= (point) beg) end beg))
3273 (opoint (point))
3274 ;; Inhibit quitting so we can make a quit here
3275 ;; look like a C-g typed as a command.
3276 (inhibit-quit t))
3277 (if (pos-visible-in-window-p other-end (selected-window))
3278 ;; Swap point-and-mark quickly so as to show the region that
3279 ;; was selected. Don't do it if the region is highlighted.
3280 (unless (and (region-active-p)
3281 (face-background 'region))
3282 ;; Swap point and mark.
3283 (set-marker (mark-marker) (point) (current-buffer))
3284 (goto-char other-end)
3285 (sit-for blink-matching-delay)
3286 ;; Swap back.
3287 (set-marker (mark-marker) other-end (current-buffer))
3288 (goto-char opoint)
3289 ;; If user quit, deactivate the mark
3290 ;; as C-g would as a command.
3291 (and quit-flag mark-active
3292 (deactivate-mark)))
3293 (let* ((killed-text (current-kill 0))
3294 (message-len (min (length killed-text) 40)))
3295 (if (= (point) beg)
3296 ;; Don't say "killed"; that is misleading.
3298 (substring killed-text (- message-len)))
3300 (substring killed-text 0 message-len))))))))
3302 (defun append-next-kill (&optional interactive)
3303 "Cause following command, if it kills, to append to previous kill.
3304 The argument is used for internal purposes; do not supply one."
3305 (interactive "p")
3306 ;; We don't use (interactive-p), since that breaks kbd macros.
3307 (if interactive
3308 (progn
3309 (setq this-command 'kill-region)
3310 (message "If the next command is a kill, it will append"))
3311 (setq last-command 'kill-region)))
3312 \f
3313 ;; Yanking.
3315 ;; This is actually used in subr.el but defcustom does not work there.
3316 (defcustom yank-excluded-properties
3317 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3318 yank-handler follow-link fontified)
3319 "Text properties to discard when yanking.
3320 The value should be a list of text properties to discard or t,
3321 which means to discard all text properties."
3322 :type '(choice (const :tag "All" t) (repeat symbol))
3323 :group 'killing
3324 :version "22.1")
3326 (defvar yank-window-start nil)
3327 (defvar yank-undo-function nil
3328 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3329 Function is called with two parameters, START and END corresponding to
3330 the value of the mark and point; it is guaranteed that START <= END.
3331 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3333 (defun yank-pop (&optional arg)
3334 "Replace just-yanked stretch of killed text with a different stretch.
3335 This command is allowed only immediately after a `yank' or a `yank-pop'.
3336 At such a time, the region contains a stretch of reinserted
3337 previously-killed text. `yank-pop' deletes that text and inserts in its
3338 place a different stretch of killed text.
3340 With no argument, the previous kill is inserted.
3341 With argument N, insert the Nth previous kill.
3342 If N is negative, this is a more recent kill.
3344 The sequence of kills wraps around, so that after the oldest one
3345 comes the newest one.
3347 When this command inserts killed text into the buffer, it honors
3348 `yank-excluded-properties' and `yank-handler' as described in the
3349 doc string for `insert-for-yank-1', which see."
3350 (interactive "*p")
3351 (if (not (eq last-command 'yank))
3352 (error "Previous command was not a yank"))
3353 (setq this-command 'yank)
3354 (unless arg (setq arg 1))
3355 (let ((inhibit-read-only t)
3356 (before (< (point) (mark t))))
3357 (if before
3358 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3359 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3360 (setq yank-undo-function nil)
3361 (set-marker (mark-marker) (point) (current-buffer))
3362 (insert-for-yank (current-kill arg))
3363 ;; Set the window start back where it was in the yank command,
3364 ;; if possible.
3365 (set-window-start (selected-window) yank-window-start t)
3366 (if before
3367 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3368 ;; It is cleaner to avoid activation, even though the command
3369 ;; loop would deactivate the mark because we inserted text.
3370 (goto-char (prog1 (mark t)
3371 (set-marker (mark-marker) (point) (current-buffer))))))
3372 nil)
3374 (defun yank (&optional arg)
3376 More precisely, reinsert the stretch of killed text most recently
3377 killed OR yanked. Put point at end, and set mark at beginning.
3378 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3379 With argument N, reinsert the Nth most recently killed stretch of killed
3380 text.
3382 When this command inserts killed text into the buffer, it honors
3383 `yank-excluded-properties' and `yank-handler' as described in the
3384 doc string for `insert-for-yank-1', which see.
3387 (interactive "*P")
3388 (setq yank-window-start (window-start))
3389 ;; If we don't get all the way thru, make last-command indicate that
3390 ;; for the following command.
3391 (setq this-command t)
3392 (push-mark (point))
3393 (insert-for-yank (current-kill (cond
3394 ((listp arg) 0)
3395 ((eq arg '-) -2)
3396 (t (1- arg)))))
3397 (if (consp arg)
3398 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3399 ;; It is cleaner to avoid activation, even though the command
3400 ;; loop would deactivate the mark because we inserted text.
3401 (goto-char (prog1 (mark t)
3402 (set-marker (mark-marker) (point) (current-buffer)))))
3403 ;; If we do get all the way thru, make this-command indicate that.
3404 (if (eq this-command t)
3405 (setq this-command 'yank))
3406 nil)
3408 (defun rotate-yank-pointer (arg)
3409 "Rotate the yanking point in the kill ring.
3410 With ARG, rotate that many kills forward (or backward, if negative)."
3411 (interactive "p")
3412 (current-kill arg))
3413 \f
3414 ;; Some kill commands.
3416 ;; Internal subroutine of delete-char
3417 (defun kill-forward-chars (arg)
3418 (if (listp arg) (setq arg (car arg)))
3419 (if (eq arg '-) (setq arg -1))
3420 (kill-region (point) (+ (point) arg)))
3422 ;; Internal subroutine of backward-delete-char
3423 (defun kill-backward-chars (arg)
3424 (if (listp arg) (setq arg (car arg)))
3425 (if (eq arg '-) (setq arg -1))
3426 (kill-region (point) (- (point) arg)))
3428 (defcustom backward-delete-char-untabify-method 'untabify
3429 "The method for untabifying when deleting backward.
3430 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3431 `hungry' -- delete all whitespace, both tabs and spaces;
3432 `all' -- delete all whitespace, including tabs, spaces and newlines;
3433 nil -- just delete one character."
3434 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3435 :version "20.3"
3436 :group 'killing)
3438 (defun backward-delete-char-untabify (arg &optional killp)
3439 "Delete characters backward, changing tabs into spaces.
3440 The exact behavior depends on `backward-delete-char-untabify-method'.
3441 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3442 Interactively, ARG is the prefix arg (default 1)
3443 and KILLP is t if a prefix arg was specified."
3445 (when (eq backward-delete-char-untabify-method 'untabify)
3446 (let ((count arg))
3447 (save-excursion
3448 (while (and (> count 0) (not (bobp)))
3450 (let ((col (current-column)))
3451 (forward-char -1)
3452 (setq col (- col (current-column)))
3453 (insert-char ?\s col)
3454 (delete-char 1)))
3455 (forward-char -1)
3456 (setq count (1- count))))))
3458 ((eq backward-delete-char-untabify-method 'all)
3460 (n (if skip
3461 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3462 (point)))))
3463 (+ arg (if (zerop wh) 0 (1- wh))))
3464 arg)))
3465 ;; Avoid warning about delete-backward-char
3466 (with-no-warnings (delete-backward-char n killp))))
3468 (defun zap-to-char (arg char)
3469 "Kill up to and including ARGth occurrence of CHAR.
3470 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3471 Goes backward if ARG is negative; error if CHAR not found."
3473 ;; Avoid "obsolete" warnings for translation-table-for-input.
3474 (with-no-warnings
3475 (if (char-table-p translation-table-for-input)
3476 (setq char (or (aref translation-table-for-input char) char))))
3477 (kill-region (point) (progn
3478 (search-forward (char-to-string char) nil nil arg)
3479 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3480 (point))))
3482 ;; kill-line and its subroutines.
3484 (defcustom kill-whole-line nil
3485 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3486 :type 'boolean
3487 :group 'killing)
3489 (defun kill-line (&optional arg)
3490 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3491 With prefix argument ARG, kill that many lines from point.
3492 Negative arguments kill lines backward.
3493 With zero argument, kills the text before point on the current line.
3496 a number counts as a prefix arg.
3498 To kill a whole line, when point is not at the beginning, type \
3501 If `show-trailing-whitespace' is non-nil, this command will just
3502 kill the rest of the current line, even if there are only
3503 nonblanks there.
3505 If `kill-whole-line' is non-nil, then this command kills the whole line
3506 including its terminating newline, when used at the beginning of a line
3507 with no argument. As a consequence, you can always kill a whole line
3510 If you want to append the killed line to the last killed text,
3513 If the buffer is read-only, Emacs will beep and refrain from deleting
3514 the line, but put the line in the kill ring anyway. This means that
3515 you can use this command to copy text from a read-only buffer.
3516 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3517 even beep.)"
3518 (interactive "P")
3519 (kill-region (point)
3520 ;; It is better to move point to the other end of the kill
3521 ;; before killing. That way, in a read-only buffer, point
3522 ;; moves across the text that is copied to the kill ring.
3523 ;; The choice has no effect on undo now that undo records
3524 ;; the value of point from before the command was run.
3525 (progn
3526 (if arg
3527 (forward-visible-line (prefix-numeric-value arg))
3528 (if (eobp)
3529 (signal 'end-of-buffer nil))
3530 (let ((end
3531 (save-excursion
3532 (end-of-visible-line) (point))))
3533 (if (or (save-excursion
3534 ;; If trailing whitespace is visible,
3535 ;; don't treat it as nothing.
3536 (unless show-trailing-whitespace
3538 (= (point) end))
3539 (and kill-whole-line (bolp)))
3540 (forward-visible-line 1)
3541 (goto-char end))))
3542 (point))))
3544 (defun kill-whole-line (&optional arg)
3545 "Kill current line.
3546 With prefix ARG, kill that many lines starting from the current line.
3547 If ARG is negative, kill backward. Also kill the preceding newline.
3549 If ARG is zero, kill current line but exclude the trailing newline."
3550 (interactive "p")
3551 (or arg (setq arg 1))
3552 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3553 (signal 'end-of-buffer nil))
3554 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3555 (signal 'beginning-of-buffer nil))
3556 (unless (eq last-command 'kill-region)
3557 (kill-new "")
3558 (setq last-command 'kill-region))
3559 (cond ((zerop arg)
3560 ;; We need to kill in two steps, because the previous command
3561 ;; could have been a kill command, in which case the text
3562 ;; before point needs to be prepended to the current kill
3563 ;; ring entry and the text after point appended. Also, we
3564 ;; need to use save-excursion to avoid copying the same text
3565 ;; twice to the kill ring in read-only buffers.
3566 (save-excursion
3567 (kill-region (point) (progn (forward-visible-line 0) (point))))
3568 (kill-region (point) (progn (end-of-visible-line) (point))))
3569 ((< arg 0)
3570 (save-excursion
3571 (kill-region (point) (progn (end-of-visible-line) (point))))
3572 (kill-region (point)
3573 (progn (forward-visible-line (1+ arg))
3574 (unless (bobp) (backward-char))
3575 (point))))
3576 (t
3577 (save-excursion
3578 (kill-region (point) (progn (forward-visible-line 0) (point))))
3579 (kill-region (point)
3580 (progn (forward-visible-line arg) (point))))))
3582 (defun forward-visible-line (arg)
3583 "Move forward by ARG lines, ignoring currently invisible newlines only.
3584 If ARG is negative, move backward -ARG lines.
3585 If ARG is zero, move to the beginning of the current line."
3586 (condition-case nil
3587 (if (> arg 0)
3588 (progn
3589 (while (> arg 0)
3590 (or (zerop (forward-line 1))
3591 (signal 'end-of-buffer nil))
3592 ;; If the newline we just skipped is invisible,
3593 ;; don't count it.
3594 (let ((prop
3595 (get-char-property (1- (point)) 'invisible)))
3596 (if (if (eq buffer-invisibility-spec t)
3597 prop
3598 (or (memq prop buffer-invisibility-spec)
3599 (assq prop buffer-invisibility-spec)))
3600 (setq arg (1+ arg))))
3601 (setq arg (1- arg)))
3602 ;; If invisible text follows, and it is a number of complete lines,
3603 ;; skip it.
3604 (let ((opoint (point)))
3605 (while (and (not (eobp))
3606 (let ((prop
3607 (get-char-property (point) 'invisible)))
3608 (if (eq buffer-invisibility-spec t)
3609 prop
3610 (or (memq prop buffer-invisibility-spec)
3611 (assq prop buffer-invisibility-spec)))))
3612 (goto-char
3613 (if (get-text-property (point) 'invisible)
3614 (or (next-single-property-change (point) 'invisible)
3615 (point-max))
3616 (next-overlay-change (point)))))
3617 (unless (bolp)
3618 (goto-char opoint))))
3619 (let ((first t))
3620 (while (or first (<= arg 0))
3621 (if first
3622 (beginning-of-line)
3623 (or (zerop (forward-line -1))
3624 (signal 'beginning-of-buffer nil)))
3625 ;; If the newline we just moved to is invisible,
3626 ;; don't count it.
3627 (unless (bobp)
3628 (let ((prop
3629 (get-char-property (1- (point)) 'invisible)))
3630 (unless (if (eq buffer-invisibility-spec t)
3631 prop
3632 (or (memq prop buffer-invisibility-spec)
3633 (assq prop buffer-invisibility-spec)))
3634 (setq arg (1+ arg)))))
3635 (setq first nil))
3636 ;; If invisible text follows, and it is a number of complete lines,
3637 ;; skip it.
3638 (let ((opoint (point)))
3639 (while (and (not (bobp))
3640 (let ((prop
3641 (get-char-property (1- (point)) 'invisible)))
3642 (if (eq buffer-invisibility-spec t)
3643 prop
3644 (or (memq prop buffer-invisibility-spec)
3645 (assq prop buffer-invisibility-spec)))))
3646 (goto-char
3647 (if (get-text-property (1- (point)) 'invisible)
3648 (or (previous-single-property-change (point) 'invisible)
3649 (point-min))
3650 (previous-overlay-change (point)))))
3651 (unless (bolp)
3652 (goto-char opoint)))))
3653 ((beginning-of-buffer end-of-buffer)
3654 nil)))
3656 (defun end-of-visible-line ()
3657 "Move to end of current visible line."
3658 (end-of-line)
3659 ;; If the following character is currently invisible,
3660 ;; skip all characters with that same `invisible' property value,
3661 ;; then find the next newline.
3662 (while (and (not (eobp))
3663 (save-excursion
3665 (let ((prop
3666 (get-char-property (point) 'invisible)))
3667 (if (eq buffer-invisibility-spec t)
3668 prop
3669 (or (memq prop buffer-invisibility-spec)
3670 (assq prop buffer-invisibility-spec))))))
3672 (if (get-text-property (point) 'invisible)
3673 (goto-char (next-single-property-change (point) 'invisible))
3674 (goto-char (next-overlay-change (point))))
3675 (end-of-line)))
3676 \f
3677 (defun insert-buffer (buffer)
3678 "Insert after point the contents of BUFFER.
3679 Puts mark after the inserted text.
3680 BUFFER may be a buffer or a buffer name.
3682 This function is meant for the user to run interactively.
3683 Don't call it from programs: use `insert-buffer-substring' instead!"
3684 (interactive
3685 (list
3686 (progn
3687 (barf-if-buffer-read-only)
3688 (read-buffer "Insert buffer: "
3689 (if (eq (selected-window) (next-window (selected-window)))
3690 (other-buffer (current-buffer))
3691 (window-buffer (next-window (selected-window))))
3692 t))))
3693 (push-mark
3694 (save-excursion
3695 (insert-buffer-substring (get-buffer buffer))
3696 (point)))
3697 nil)
3699 (defun append-to-buffer (buffer start end)
3700 "Append to specified buffer the text of the region.
3701 It is inserted into that buffer before its point.
3703 When calling from a program, give three arguments:
3704 BUFFER (or buffer name), START and END.
3705 START and END specify the portion of the current buffer to be copied."
3706 (interactive
3707 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3708 (region-beginning) (region-end)))
3709 (let* ((oldbuf (current-buffer))
3710 (append-to (get-buffer-create buffer))
3711 (windows (get-buffer-window-list append-to t t))
3712 point)
3713 (save-excursion
3714 (with-current-buffer append-to
3715 (setq point (point))
3716 (barf-if-buffer-read-only)
3717 (insert-buffer-substring oldbuf start end)
3718 (dolist (window windows)
3719 (when (= (window-point window) point)
3720 (set-window-point window (point))))))))
3722 (defun prepend-to-buffer (buffer start end)
3723 "Prepend to specified buffer the text of the region.
3724 It is inserted into that buffer after its point.
3726 When calling from a program, give three arguments:
3727 BUFFER (or buffer name), START and END.
3728 START and END specify the portion of the current buffer to be copied."
3730 (let ((oldbuf (current-buffer)))
3731 (with-current-buffer (get-buffer-create buffer)
3732 (barf-if-buffer-read-only)
3733 (save-excursion
3734 (insert-buffer-substring oldbuf start end)))))
3736 (defun copy-to-buffer (buffer start end)
3737 "Copy to specified buffer the text of the region.
3738 It is inserted into that buffer, replacing existing text there.
3740 When calling from a program, give three arguments:
3741 BUFFER (or buffer name), START and END.
3742 START and END specify the portion of the current buffer to be copied."
3744 (let ((oldbuf (current-buffer)))
3745 (with-current-buffer (get-buffer-create buffer)
3746 (barf-if-buffer-read-only)
3747 (erase-buffer)
3748 (save-excursion
3749 (insert-buffer-substring oldbuf start end)))))
3750 \f
3751 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3752 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3754 (defvar activate-mark-hook nil
3755 "Hook run when the mark becomes active.
3756 It is also run at the end of a command, if the mark is active and
3757 it is possible that the region may have changed.")
3759 (defvar deactivate-mark-hook nil
3760 "Hook run when the mark becomes inactive.")
3762 (defun mark (&optional force)
3763 "Return this buffer's mark value as integer, or nil if never set.
3765 In Transient Mark mode, this function signals an error if
3766 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3767 or the argument FORCE is non-nil, it disregards whether the mark
3768 is active, and returns an integer or nil in the usual way.
3770 If you are using this in an editing command, you are most likely making
3771 a mistake; see the documentation of `set-mark'."
3772 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3773 (marker-position (mark-marker))
3774 (signal 'mark-inactive nil)))
3776 (defsubst deactivate-mark (&optional force)
3777 "Deactivate the mark.
3778 If Transient Mark mode is disabled, this function normally does
3779 nothing; but if FORCE is non-nil, it deactivates the mark anyway.
3781 Deactivating the mark sets `mark-active' to nil, updates the
3782 primary selection according to `select-active-regions', and runs
3783 `deactivate-mark-hook'.
3785 If Transient Mark mode was temporarily enabled, reset the value
3786 of the variable `transient-mark-mode'; if this causes Transient
3787 Mark mode to be disabled, don't change `mark-active' to nil or
3788 run `deactivate-mark-hook'."
3789 (when (or transient-mark-mode force)
3790 (when (and (if (eq select-active-regions 'only)
3791 (eq (car-safe transient-mark-mode) 'only)
3792 select-active-regions)
3793 (region-active-p)
3794 (display-selections-p))
3795 ;; The var `saved-region-selection', if non-nil, is the text in
3796 ;; the region prior to the last command modifying the buffer.
3797 ;; Set the selection to that, or to the current region.
3798 (cond (saved-region-selection
3799 (x-set-selection 'PRIMARY saved-region-selection)
3800 (setq saved-region-selection nil))
3801 ((/= (region-beginning) (region-end))
3802 (x-set-selection 'PRIMARY
3803 (buffer-substring-no-properties
3804 (region-beginning)
3805 (region-end))))))
3806 (if (and (null force)
3807 (or (eq transient-mark-mode 'lambda)
3808 (and (eq (car-safe transient-mark-mode) 'only)
3809 (null (cdr transient-mark-mode)))))
3810 ;; When deactivating a temporary region, don't change
3811 ;; `mark-active' or run `deactivate-mark-hook'.
3812 (setq transient-mark-mode nil)
3813 (if (eq (car-safe transient-mark-mode) 'only)
3814 (setq transient-mark-mode (cdr transient-mark-mode)))
3815 (setq mark-active nil)
3816 (run-hooks 'deactivate-mark-hook))))
3818 (defun activate-mark ()
3819 "Activate the mark."
3820 (when (mark t)
3821 (setq mark-active t)
3822 (unless transient-mark-mode
3823 (setq transient-mark-mode 'lambda))))
3825 (defun set-mark (pos)
3826 "Set this buffer's mark to POS. Don't use this function!
3827 That is to say, don't use this function unless you want
3828 the user to see that the mark has moved, and you want the previous
3829 mark position to be lost.
3831 Normally, when a new mark is set, the old one should go on the stack.
3832 This is why most applications should use `push-mark', not `set-mark'.
3834 Novice Emacs Lisp programmers often try to use the mark for the wrong
3835 purposes. The mark saves a location for the user's convenience.
3836 Most editing commands should not alter the mark.
3837 To remember a location for internal use in the Lisp program,
3838 store it in a Lisp variable. Example:
3840 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3842 (if pos
3843 (progn
3844 (setq mark-active t)
3845 (run-hooks 'activate-mark-hook)
3846 (set-marker (mark-marker) pos (current-buffer)))
3847 ;; Normally we never clear mark-active except in Transient Mark mode.
3848 ;; But when we actually clear out the mark value too, we must
3849 ;; clear mark-active in any mode.
3850 (deactivate-mark t)
3851 (set-marker (mark-marker) nil)))
3853 (defcustom use-empty-active-region nil
3855 If nil, region-aware commands treat empty regions as inactive.
3856 If non-nil, region-aware commands treat the region as active as
3857 long as the mark is active, even if the region is empty.
3859 Region-aware commands are those that act on the region if it is
3860 active and Transient Mark mode is enabled, and on the text near
3861 point otherwise."
3862 :type 'boolean
3863 :version "23.1"
3864 :group 'editing-basics)
3866 (defun use-region-p ()
3867 "Return t if the region is active and it is appropriate to act on it.
3868 This is used by commands that act specially on the region under
3869 Transient Mark mode.
3871 The return value is t if Transient Mark mode is enabled and the
3872 mark is active; furthermore, if `use-empty-active-region' is nil,
3873 the region must not be empty. Otherwise, the return value is nil.
3875 For some commands, it may be appropriate to ignore the value of
3876 `use-empty-active-region'; in that case, use `region-active-p'."
3877 (and (region-active-p)
3878 (or use-empty-active-region (> (region-end) (region-beginning)))))
3880 (defun region-active-p ()
3881 "Return t if Transient Mark mode is enabled and the mark is active.
3883 Some commands act specially on the region when Transient Mark
3884 mode is enabled. Usually, such commands should use
3885 `use-region-p' instead of this function, because `use-region-p'
3886 also checks the value of `use-empty-active-region'."
3887 (and transient-mark-mode mark-active))
3889 (defvar mark-ring nil
3890 "The list of former marks of the current buffer, most recent first.")
3891 (make-variable-buffer-local 'mark-ring)
3892 (put 'mark-ring 'permanent-local t)
3894 (defcustom mark-ring-max 16
3895 "Maximum size of mark ring. Start discarding off end if gets this big."
3896 :type 'integer
3897 :group 'editing-basics)
3899 (defvar global-mark-ring nil
3900 "The list of saved global marks, most recent first.")
3902 (defcustom global-mark-ring-max 16
3903 "Maximum size of global mark ring. \
3904 Start discarding off end if gets this big."
3905 :type 'integer
3906 :group 'editing-basics)
3908 (defun pop-to-mark-command ()
3909 "Jump to mark, and pop a new position for mark off the ring.
3910 \(Does not affect global mark ring\)."
3911 (interactive)
3912 (if (null (mark t))
3913 (error "No mark set in this buffer")
3914 (if (= (point) (mark t))
3915 (message "Mark popped"))
3916 (goto-char (mark t))
3917 (pop-mark)))
3919 (defun push-mark-command (arg &optional nomsg)
3920 "Set mark at where point is.
3921 If no prefix ARG and mark is already set there, just activate it.
3922 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3923 (interactive "P")
3924 (let ((mark (marker-position (mark-marker))))
3925 (if (or arg (null mark) (/= mark (point)))
3926 (push-mark nil nomsg t)
3927 (setq mark-active t)
3928 (run-hooks 'activate-mark-hook)
3929 (unless nomsg
3930 (message "Mark activated")))))
3932 (defcustom set-mark-command-repeat-pop nil
3935 will pop the mark twice, and
3937 will pop the mark three times.
3941 :type 'boolean
3942 :group 'editing-basics)
3944 (defcustom set-mark-default-inactive nil
3945 "If non-nil, setting the mark does not activate it.
3947 behave the same whether or not `transient-mark-mode' is enabled."
3948 :type 'boolean
3949 :group 'editing-basics
3950 :version "23.1")
3952 (defun set-mark-command (arg)
3953 "Set the mark where point is, or jump to the mark.
3954 Setting the mark also alters the region, which is the text
3955 between point and mark; this is the closest equivalent in
3958 With no prefix argument, set the mark at point, and push the
3959 old mark position on local mark ring. Also push the old mark on
3960 global mark ring, if the previous mark was set in another buffer.
3962 When Transient Mark Mode is off, immediately repeating this
3963 command activates `transient-mark-mode' temporarily.
3966 jump to the mark, and set the mark from
3967 position popped off the local mark ring \(this does not affect the global
3969 mark ring \(see `pop-global-mark'\).
3971 If `set-mark-command-repeat-pop' is non-nil, repeating
3973 off the local (or global) mark ring and jumps there.
3976 argument, unconditionally set mark where point is, even if
3977 `set-mark-command-repeat-pop' is non-nil.
3979 Novice Emacs Lisp programmers often try to use the mark for the wrong
3980 purposes. See the documentation of `set-mark' for more information."
3981 (interactive "P")
3982 (cond ((eq transient-mark-mode 'lambda)
3983 (setq transient-mark-mode nil))
3984 ((eq (car-safe transient-mark-mode) 'only)
3985 (deactivate-mark)))
3986 (cond
3987 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3988 (push-mark-command nil))
3989 ((not (eq this-command 'set-mark-command))
3990 (if arg
3991 (pop-to-mark-command)
3992 (push-mark-command t)))
3993 ((and set-mark-command-repeat-pop
3994 (eq last-command 'pop-to-mark-command))
3995 (setq this-command 'pop-to-mark-command)
3996 (pop-to-mark-command))
3997 ((and set-mark-command-repeat-pop
3998 (eq last-command 'pop-global-mark)
3999 (not arg))
4000 (setq this-command 'pop-global-mark)
4001 (pop-global-mark))
4002 (arg
4003 (setq this-command 'pop-to-mark-command)
4004 (pop-to-mark-command))
4005 ((eq last-command 'set-mark-command)
4006 (if (region-active-p)
4007 (progn
4008 (deactivate-mark)
4009 (message "Mark deactivated"))
4010 (activate-mark)
4011 (message "Mark activated")))
4012 (t
4013 (push-mark-command nil)
4014 (if set-mark-default-inactive (deactivate-mark)))))
4016 (defun push-mark (&optional location nomsg activate)
4017 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
4018 If the last global mark pushed was not in the current buffer,
4019 also push LOCATION on the global mark ring.
4020 Display `Mark set' unless the optional second arg NOMSG is non-nil.
4022 Novice Emacs Lisp programmers often try to use the mark for the wrong
4023 purposes. See the documentation of `set-mark' for more information.
4025 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
4026 (unless (null (mark t))
4027 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
4028 (when (> (length mark-ring) mark-ring-max)
4029 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
4030 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
4031 (set-marker (mark-marker) (or location (point)) (current-buffer))
4032 ;; Now push the mark on the global mark ring.
4033 (if (and global-mark-ring
4034 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
4035 ;; The last global mark pushed was in this same buffer.
4036 ;; Don't push another one.
4037 nil
4038 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4039 (when (> (length global-mark-ring) global-mark-ring-max)
4040 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4041 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4042 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4043 (message "Mark set"))
4044 (if (or activate (not transient-mark-mode))
4045 (set-mark (mark t)))
4046 nil)
4048 (defun pop-mark ()
4049 "Pop off mark ring into the buffer's actual mark.
4050 Does not set point. Does nothing if mark ring is empty."
4051 (when mark-ring
4052 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4053 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4054 (move-marker (car mark-ring) nil)
4055 (if (null (mark t)) (ding))
4056 (setq mark-ring (cdr mark-ring)))
4057 (deactivate-mark))
4059 (define-obsolete-function-alias
4060 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4061 (defun exchange-point-and-mark (&optional arg)
4062 "Put the mark where point is now, and point where the mark is now.
4063 This command works even when the mark is not active,
4064 and it reactivates the mark.
4066 If Transient Mark mode is on, a prefix ARG deactivates the mark
4067 if it is active, and otherwise avoids reactivating it. If
4068 Transient Mark mode is off, a prefix ARG enables Transient Mark
4069 mode temporarily."
4070 (interactive "P")
4071 (let ((omark (mark t))
4072 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4073 (if (null omark)
4074 (error "No mark set in this buffer"))
4075 (deactivate-mark)
4076 (set-mark (point))
4077 (goto-char omark)
4078 (if set-mark-default-inactive (deactivate-mark))
4079 (cond (temp-highlight
4080 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4081 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4082 (not (or arg (region-active-p))))
4083 (deactivate-mark))
4084 (t (activate-mark)))
4085 nil))
4087 (defcustom shift-select-mode t
4088 "When non-nil, shifted motion keys activate the mark momentarily.
4090 While the mark is activated in this way, any shift-translated point
4091 motion key extends the region, and if Transient Mark mode was off, it
4092 is temporarily turned on. Furthermore, the mark will be deactivated
4093 by any subsequent point motion key that was not shift-translated, or
4094 by any action that normally deactivates the mark in Transient Mark mode.
4096 See `this-command-keys-shift-translated' for the meaning of
4097 shift-translation."
4098 :type 'boolean
4099 :group 'editing-basics)
4101 (defun handle-shift-selection ()
4102 "Activate/deactivate mark depending on invocation thru shift translation.
4103 This function is called by `call-interactively' when a command
4104 with a `^' character in its `interactive' spec is invoked, before
4105 running the command itself.
4107 If `shift-select-mode' is enabled and the command was invoked
4108 through shift translation, set the mark and activate the region
4109 temporarily, unless it was already set in this way. See
4110 `this-command-keys-shift-translated' for the meaning of shift
4111 translation.
4113 Otherwise, if the region has been activated temporarily,
4114 deactivate it, and restore the variable `transient-mark-mode' to
4115 its earlier value."
4116 (cond ((and shift-select-mode this-command-keys-shift-translated)
4117 (unless (and mark-active
4118 (eq (car-safe transient-mark-mode) 'only))
4119 (setq transient-mark-mode
4120 (cons 'only
4121 (unless (eq transient-mark-mode 'lambda)
4122 transient-mark-mode)))
4123 (push-mark nil nil t)))
4124 ((eq (car-safe transient-mark-mode) 'only)
4125 (setq transient-mark-mode (cdr transient-mark-mode))
4126 (deactivate-mark))))
4128 (define-minor-mode transient-mark-mode
4129 "Toggle Transient Mark mode.
4130 With a prefix argument ARG, enable Transient Mark mode if ARG is
4131 positive, and disable it otherwise. If called from Lisp, enable
4132 Transient Mark mode if ARG is omitted or nil.
4134 Transient Mark mode is a global minor mode. When enabled, the
4135 region is highlighted whenever the mark is active. The mark is
4137 operations that set the mark but whose main purpose is something
4143 Many commands change their behavior when Transient Mark mode is in effect
4144 and the mark is active, by acting on the region instead of their usual
4145 default part of the buffer's text. Examples of such commands include
4150 commands which are sensitive to the Transient Mark mode."
4151 :global t
4152 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4153 :variable transient-mark-mode)
4155 (defvar widen-automatically t
4156 "Non-nil means it is ok for commands to call `widen' when they want to.
4157 Some commands will do this in order to go to positions outside
4158 the current accessible part of the buffer.
4160 If `widen-automatically' is nil, these commands will do something else
4161 as a fallback, and won't change the buffer bounds.")
4163 (defvar non-essential nil
4164 "Whether the currently executing code is performing an essential task.
4165 This variable should be non-nil only when running code which should not
4166 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4167 user for a password when we are simply scanning a set of files in the
4168 background or displaying possible completions before the user even asked
4169 for it.")
4171 (defun pop-global-mark ()
4172 "Pop off global mark ring and jump to the top location."
4173 (interactive)
4174 ;; Pop entries which refer to non-existent buffers.
4175 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4176 (setq global-mark-ring (cdr global-mark-ring)))
4177 (or global-mark-ring
4178 (error "No global mark set"))
4179 (let* ((marker (car global-mark-ring))
4180 (buffer (marker-buffer marker))
4181 (position (marker-position marker)))
4182 (setq global-mark-ring (nconc (cdr global-mark-ring)
4183 (list (car global-mark-ring))))
4184 (set-buffer buffer)
4185 (or (and (>= position (point-min))
4186 (<= position (point-max)))
4187 (if widen-automatically
4188 (widen)
4189 (error "Global mark position is outside accessible part of buffer")))
4190 (goto-char position)
4191 (switch-to-buffer buffer)))
4192 \f
4193 (defcustom next-line-add-newlines nil
4194 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4195 :type 'boolean
4196 :version "21.1"
4197 :group 'editing-basics)
4199 (defun next-line (&optional arg try-vscroll)
4200 "Move cursor vertically down ARG lines.
4201 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4202 If there is no character in the target line exactly under the current column,
4203 the cursor is positioned after the character in that line which spans this
4204 column, or at the end of the line if it is not long enough.
4205 If there is no line in the buffer after this one, behavior depends on the
4206 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4207 to create a line, and moves the cursor to that line. Otherwise it moves the
4208 cursor to the end of the buffer.
4210 If the variable `line-move-visual' is non-nil, this command moves
4211 by display lines. Otherwise, it moves by buffer lines, without
4212 taking variable-width characters or continued lines into account.
4215 a semipermanent goal column for this command.
4216 Then instead of trying to move exactly vertically (or as close as possible),
4217 this command moves to the specified goal column (or as close as possible).
4218 The goal column is stored in the variable `goal-column', which is nil
4219 when there is no goal column. Note that setting `goal-column'
4220 overrides `line-move-visual' and causes this command to move by buffer
4221 lines rather than by display lines.
4223 If you are thinking of using this in a Lisp program, consider
4224 using `forward-line' instead. It is usually easier to use
4225 and more reliable (no dependence on goal column, etc.)."
4227 (or arg (setq arg 1))
4228 (if (and next-line-add-newlines (= arg 1))
4229 (if (save-excursion (end-of-line) (eobp))
4230 ;; When adding a newline, don't expand an abbrev.
4231 (let ((abbrev-mode nil))
4232 (end-of-line)
4234 (line-move arg nil nil try-vscroll))
4235 (if (called-interactively-p 'interactive)
4236 (condition-case err
4237 (line-move arg nil nil try-vscroll)
4238 ((beginning-of-buffer end-of-buffer)
4239 (signal (car err) (cdr err))))
4240 (line-move arg nil nil try-vscroll)))
4241 nil)
4243 (defun previous-line (&optional arg try-vscroll)
4244 "Move cursor vertically up ARG lines.
4245 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4246 If there is no character in the target line exactly over the current column,
4247 the cursor is positioned after the character in that line which spans this
4248 column, or at the end of the line if it is not long enough.
4250 If the variable `line-move-visual' is non-nil, this command moves
4251 by display lines. Otherwise, it moves by buffer lines, without
4252 taking variable-width characters or continued lines into account.
4255 a semipermanent goal column for this command.
4256 Then instead of trying to move exactly vertically (or as close as possible),
4257 this command moves to the specified goal column (or as close as possible).
4258 The goal column is stored in the variable `goal-column', which is nil
4259 when there is no goal column. Note that setting `goal-column'
4260 overrides `line-move-visual' and causes this command to move by buffer
4261 lines rather than by display lines.
4263 If you are thinking of using this in a Lisp program, consider using
4264 `forward-line' with a negative argument instead. It is usually easier
4265 to use and more reliable (no dependence on goal column, etc.)."
4267 (or arg (setq arg 1))
4268 (if (called-interactively-p 'interactive)
4269 (condition-case err
4270 (line-move (- arg) nil nil try-vscroll)
4271 ((beginning-of-buffer end-of-buffer)
4272 (signal (car err) (cdr err))))
4273 (line-move (- arg) nil nil try-vscroll))
4274 nil)
4276 (defcustom track-eol nil
4277 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4278 This means moving to the end of each line moved onto.
4279 The beginning of a blank line does not count as the end of a line.
4280 This has no effect when `line-move-visual' is non-nil."
4281 :type 'boolean
4282 :group 'editing-basics)
4284 (defcustom goal-column nil
4286 A non-nil setting overrides `line-move-visual', which see."
4287 :type '(choice integer
4288 (const :tag "None" nil))
4289 :group 'editing-basics)
4290 (make-variable-buffer-local 'goal-column)
4292 (defvar temporary-goal-column 0
4293 "Current goal column for vertical motion.
4294 It is the column where point was at the start of the current run
4295 of vertical motion commands.
4297 When moving by visual lines via `line-move-visual', it is a cons
4298 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4299 divided by the default column width, and HSCROLL is the number of
4300 columns by which window is scrolled from left margin.
4302 When the `track-eol' feature is doing its job, the value is
4303 `most-positive-fixnum'.")
4305 (defcustom line-move-ignore-invisible t
4307 Outline mode sets this."
4308 :type 'boolean
4309 :group 'editing-basics)
4311 (defcustom line-move-visual t
4312 "When non-nil, `line-move' moves point by visual lines.
4313 This movement is based on where the cursor is displayed on the
4314 screen, instead of relying on buffer contents alone. It takes
4315 into account variable-width characters and line continuation.
4316 If nil, `line-move' moves point by logical lines.
4317 A non-nil setting of `goal-column' overrides the value of this variable
4318 and forces movement by logical lines.
4319 A window that is horizontally scrolled also forces movement by logical
4320 lines."
4321 :type 'boolean
4322 :group 'editing-basics
4323 :version "23.1")
4325 ;; Returns non-nil if partial move was done.
4326 (defun line-move-partial (arg noerror to-end)
4327 (if (< arg 0)
4328 ;; Move backward (up).
4329 ;; If already vscrolled, reduce vscroll
4330 (let ((vs (window-vscroll nil t)))
4331 (when (> vs (frame-char-height))
4332 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4334 ;; Move forward (down).
4335 (let* ((lh (window-line-height -1))
4336 (vpos (nth 1 lh))
4337 (ypos (nth 2 lh))
4338 (rbot (nth 3 lh))
4339 py vs)
4340 (when (or (null lh)
4341 (>= rbot (frame-char-height))
4342 (<= ypos (- (frame-char-height))))
4343 (unless lh
4344 (let ((wend (pos-visible-in-window-p t nil t)))
4345 (setq rbot (nth 3 wend)
4346 vpos (nth 5 wend))))
4347 (cond
4348 ;; If last line of window is fully visible, move forward.
4349 ((or (null rbot) (= rbot 0))
4350 nil)
4351 ;; If cursor is not in the bottom scroll margin, move forward.
4352 ((and (> vpos 0)
4353 (< (setq py
4354 (or (nth 1 (window-line-height))
4355 (let ((ppos (posn-at-point)))
4356 (cdr (or (posn-actual-col-row ppos)
4357 (posn-col-row ppos))))))
4358 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4359 nil)
4360 ;; When already vscrolled, we vscroll some more if we can,
4361 ;; or clear vscroll and move forward at end of tall image.
4362 ((> (setq vs (window-vscroll nil t)) 0)
4363 (when (> rbot 0)
4364 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4365 ;; If cursor just entered the bottom scroll margin, move forward,
4366 ;; but also vscroll one line so redisplay won't recenter.
4367 ((and (> vpos 0)
4368 (= py (min (- (window-text-height) scroll-margin 1)
4369 (1- vpos))))
4370 (set-window-vscroll nil (frame-char-height) t)
4371 (line-move-1 arg noerror to-end)
4372 t)
4373 ;; If there are lines above the last line, scroll-up one line.
4374 ((> vpos 0)
4375 (scroll-up 1)
4376 t)
4377 ;; Finally, start vscroll.
4378 (t
4379 (set-window-vscroll nil (frame-char-height) t)))))))
4382 ;; This is like line-move-1 except that it also performs
4383 ;; vertical scrolling of tall images if appropriate.
4384 ;; That is not really a clean thing to do, since it mixes
4385 ;; scrolling with cursor motion. But so far we don't have
4386 ;; a cleaner solution to the problem of making C-n do something
4387 ;; useful given a tall image.
4388 (defun line-move (arg &optional noerror to-end try-vscroll)
4389 (unless (and auto-window-vscroll try-vscroll
4390 ;; Only vscroll for single line moves
4391 (= (abs arg) 1)
4392 ;; But don't vscroll in a keyboard macro.
4393 (not defining-kbd-macro)
4394 (not executing-kbd-macro)
4395 (line-move-partial arg noerror to-end))
4396 (set-window-vscroll nil 0 t)
4397 (if (and line-move-visual
4398 ;; Display-based column are incompatible with goal-column.
4399 (not goal-column)
4400 ;; When the text in the window is scrolled to the left,
4401 ;; display-based motion doesn't make sense (because each
4402 ;; logical line occupies exactly one screen line).
4403 (not (> (window-hscroll) 0)))
4404 (line-move-visual arg noerror)
4405 (line-move-1 arg noerror to-end))))
4407 ;; Display-based alternative to line-move-1.
4408 ;; Arg says how many lines to move. The value is t if we can move the
4409 ;; specified number of lines.
4410 (defun line-move-visual (arg &optional noerror)
4411 (let ((opoint (point))
4412 (hscroll (window-hscroll))
4413 target-hscroll)
4414 ;; Check if the previous command was a line-motion command, or if
4415 ;; we were called from some other command.
4416 (if (and (consp temporary-goal-column)
4417 (memq last-command `(next-line previous-line ,this-command)))
4418 ;; If so, there's no need to reset `temporary-goal-column',
4419 ;; but we may need to hscroll.
4420 (if (or (/= (cdr temporary-goal-column) hscroll)
4421 (> (cdr temporary-goal-column) 0))
4422 (setq target-hscroll (cdr temporary-goal-column)))
4423 ;; Otherwise, we should reset `temporary-goal-column'.
4424 (let ((posn (posn-at-point)))
4425 (cond
4426 ;; Handle the `overflow-newline-into-fringe' case:
4427 ((eq (nth 1 posn) 'right-fringe)
4428 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4429 ((car (posn-x-y posn))
4430 (setq temporary-goal-column
4431 (cons (/ (float (car (posn-x-y posn)))
4432 (frame-char-width)) hscroll))))))
4433 (if target-hscroll
4434 (set-window-hscroll (selected-window) target-hscroll))
4435 (or (and (= (vertical-motion
4436 (cons (or goal-column
4437 (if (consp temporary-goal-column)
4438 (car temporary-goal-column)
4439 temporary-goal-column))
4440 arg))
4441 arg)
4442 (or (>= arg 0)
4443 (/= (point) opoint)
4444 ;; If the goal column lies on a display string,
4445 ;; `vertical-motion' advances the cursor to the end
4446 ;; of the string. For arg < 0, this can cause the
4447 ;; cursor to get stuck. (Bug#3020).
4448 (= (vertical-motion arg) arg)))
4449 (unless noerror
4450 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4451 nil)))))
4453 ;; This is the guts of next-line and previous-line.
4454 ;; Arg says how many lines to move.
4455 ;; The value is t if we can move the specified number of lines.
4456 (defun line-move-1 (arg &optional noerror _to-end)
4457 ;; Don't run any point-motion hooks, and disregard intangibility,
4458 ;; for intermediate positions.
4459 (let ((inhibit-point-motion-hooks t)
4460 (opoint (point))
4461 (orig-arg arg))
4462 (if (consp temporary-goal-column)
4463 (setq temporary-goal-column (+ (car temporary-goal-column)
4464 (cdr temporary-goal-column))))
4465 (unwind-protect
4466 (progn
4467 (if (not (memq last-command '(next-line previous-line)))
4468 (setq temporary-goal-column
4469 (if (and track-eol (eolp)
4470 ;; Don't count beg of empty line as end of line
4471 ;; unless we just did explicit end-of-line.
4472 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4473 most-positive-fixnum
4474 (current-column))))
4476 (if (not (or (integerp selective-display)
4477 line-move-ignore-invisible))
4478 ;; Use just newline characters.
4479 ;; Set ARG to 0 if we move as many lines as requested.
4480 (or (if (> arg 0)
4481 (progn (if (> arg 1) (forward-line (1- arg)))
4482 ;; This way of moving forward ARG lines
4483 ;; verifies that we have a newline after the last one.
4484 ;; It doesn't get confused by intangible text.
4485 (end-of-line)
4486 (if (zerop (forward-line 1))
4487 (setq arg 0)))
4488 (and (zerop (forward-line arg))
4489 (bolp)
4490 (setq arg 0)))
4491 (unless noerror
4492 (signal (if (< arg 0)
4493 'beginning-of-buffer
4494 'end-of-buffer)
4495 nil)))
4496 ;; Move by arg lines, but ignore invisible ones.
4497 (let (done)
4498 (while (and (> arg 0) (not done))
4499 ;; If the following character is currently invisible,
4500 ;; skip all characters with that same `invisible' property value.
4501 (while (and (not (eobp)) (invisible-p (point)))
4502 (goto-char (next-char-property-change (point))))
4503 ;; Move a line.
4504 ;; We don't use `end-of-line', since we want to escape
4505 ;; from field boundaries occurring exactly at point.
4506 (goto-char (constrain-to-field
4507 (let ((inhibit-field-text-motion t))
4508 (line-end-position))
4509 (point) t t
4510 'inhibit-line-move-field-capture))
4511 ;; If there's no invisibility here, move over the newline.
4512 (cond
4513 ((eobp)
4514 (if (not noerror)
4515 (signal 'end-of-buffer nil)
4516 (setq done t)))
4517 ((and (> arg 1) ;; Use vertical-motion for last move
4518 (not (integerp selective-display))
4519 (not (invisible-p (point))))
4520 ;; We avoid vertical-motion when possible
4521 ;; because that has to fontify.
4522 (forward-line 1))
4523 ;; Otherwise move a more sophisticated way.
4524 ((zerop (vertical-motion 1))
4525 (if (not noerror)
4526 (signal 'end-of-buffer nil)
4527 (setq done t))))
4528 (unless done
4529 (setq arg (1- arg))))
4530 ;; The logic of this is the same as the loop above,
4531 ;; it just goes in the other direction.
4532 (while (and (< arg 0) (not done))
4533 ;; For completely consistency with the forward-motion
4534 ;; case, we should call beginning-of-line here.
4535 ;; However, if point is inside a field and on a
4536 ;; continued line, the call to (vertical-motion -1)
4537 ;; below won't move us back far enough; then we return
4538 ;; to the same column in line-move-finish, and point
4539 ;; gets stuck -- cyd
4540 (forward-line 0)
4541 (cond
4542 ((bobp)
4543 (if (not noerror)
4544 (signal 'beginning-of-buffer nil)
4545 (setq done t)))
4546 ((and (< arg -1) ;; Use vertical-motion for last move
4547 (not (integerp selective-display))
4548 (not (invisible-p (1- (point)))))
4549 (forward-line -1))
4550 ((zerop (vertical-motion -1))
4551 (if (not noerror)
4552 (signal 'beginning-of-buffer nil)
4553 (setq done t))))
4554 (unless done
4555 (setq arg (1+ arg))
4556 (while (and ;; Don't move over previous invis lines
4557 ;; if our target is the middle of this line.
4558 (or (zerop (or goal-column temporary-goal-column))
4559 (< arg 0))
4560 (not (bobp)) (invisible-p (1- (point))))
4561 (goto-char (previous-char-property-change (point))))))))
4562 ;; This is the value the function returns.
4563 (= arg 0))
4565 (cond ((> arg 0)
4566 ;; If we did not move down as far as desired, at least go
4567 ;; to end of line. Be sure to call point-entered and
4568 ;; point-left-hooks.
4569 (let* ((npoint (prog1 (line-end-position)
4570 (goto-char opoint)))
4571 (inhibit-point-motion-hooks nil))
4572 (goto-char npoint)))
4573 ((< arg 0)
4574 ;; If we did not move up as far as desired,
4575 ;; at least go to beginning of line.
4576 (let* ((npoint (prog1 (line-beginning-position)
4577 (goto-char opoint)))
4578 (inhibit-point-motion-hooks nil))
4579 (goto-char npoint)))
4580 (t
4581 (line-move-finish (or goal-column temporary-goal-column)
4582 opoint (> orig-arg 0)))))))
4584 (defun line-move-finish (column opoint forward)
4585 (let ((repeat t))
4586 (while repeat
4587 ;; Set REPEAT to t to repeat the whole thing.
4588 (setq repeat nil)
4590 (let (new
4591 (old (point))
4592 (line-beg (line-beginning-position))
4593 (line-end
4594 ;; Compute the end of the line
4595 ;; ignoring effectively invisible newlines.
4596 (save-excursion
4597 ;; Like end-of-line but ignores fields.
4599 (while (and (not (eobp)) (invisible-p (point)))
4600 (goto-char (next-char-property-change (point)))
4602 (point))))
4604 ;; Move to the desired column.
4605 (line-move-to-column (truncate column))
4607 ;; Corner case: suppose we start out in a field boundary in
4608 ;; the middle of a continued line. When we get to
4609 ;; line-move-finish, point is at the start of a new *screen*
4610 ;; line but the same text line; then line-move-to-column would
4611 ;; move us backwards. Test using C-n with point on the "x" in
4612 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4613 (and forward
4614 (< (point) old)
4615 (goto-char old))
4617 (setq new (point))
4619 ;; Process intangibility within a line.
4620 ;; With inhibit-point-motion-hooks bound to nil, a call to
4621 ;; goto-char moves point past intangible text.
4623 ;; However, inhibit-point-motion-hooks controls both the
4624 ;; intangibility and the point-entered/point-left hooks. The
4625 ;; following hack avoids calling the point-* hooks
4626 ;; unnecessarily. Note that we move *forward* past intangible
4627 ;; text when the initial and final points are the same.
4628 (goto-char new)
4629 (let ((inhibit-point-motion-hooks nil))
4630 (goto-char new)
4632 ;; If intangibility moves us to a different (later) place
4633 ;; in the same line, use that as the destination.
4634 (if (<= (point) line-end)
4635 (setq new (point))
4636 ;; If that position is "too late",
4637 ;; try the previous allowable position.
4638 ;; See if it is ok.
4639 (backward-char)
4640 (if (if forward
4641 ;; If going forward, don't accept the previous
4642 ;; allowable position if it is before the target line.
4643 (< line-beg (point))
4644 ;; If going backward, don't accept the previous
4645 ;; allowable position if it is still after the target line.
4646 (<= (point) line-end))
4647 (setq new (point))
4648 ;; As a last resort, use the end of the line.
4649 (setq new line-end))))
4651 ;; Now move to the updated destination, processing fields
4652 ;; as well as intangibility.
4653 (goto-char opoint)
4654 (let ((inhibit-point-motion-hooks nil))
4655 (goto-char
4656 ;; Ignore field boundaries if the initial and final
4657 ;; positions have the same `field' property, even if the
4658 ;; fields are non-contiguous. This seems to be "nicer"
4659 ;; behavior in many situations.
4660 (if (eq (get-char-property new 'field)
4661 (get-char-property opoint 'field))
4662 new
4663 (constrain-to-field new opoint t t
4664 'inhibit-line-move-field-capture))))
4666 ;; If all this moved us to a different line,
4667 ;; retry everything within that new line.
4668 (when (or (< (point) line-beg) (> (point) line-end))
4669 ;; Repeat the intangibility and field processing.
4670 (setq repeat t))))))
4672 (defun line-move-to-column (col)
4673 "Try to find column COL, considering invisibility.
4674 This function works only in certain cases,
4675 because what we really need is for `move-to-column'
4676 and `current-column' to be able to ignore invisible text."
4677 (if (zerop col)
4678 (beginning-of-line)
4679 (move-to-column col))
4681 (when (and line-move-ignore-invisible
4682 (not (bolp)) (invisible-p (1- (point))))
4683 (let ((normal-location (point))
4684 (normal-column (current-column)))
4685 ;; If the following character is currently invisible,
4686 ;; skip all characters with that same `invisible' property value.
4687 (while (and (not (eobp))
4688 (invisible-p (point)))
4689 (goto-char (next-char-property-change (point))))
4690 ;; Have we advanced to a larger column position?
4691 (if (> (current-column) normal-column)
4692 ;; We have made some progress towards the desired column.
4693 ;; See if we can make any further progress.
4694 (line-move-to-column (+ (current-column) (- col normal-column)))
4695 ;; Otherwise, go to the place we originally found
4696 ;; and move back over invisible text.
4697 ;; that will get us to the same place on the screen
4698 ;; but with a more reasonable buffer position.
4699 (goto-char normal-location)
4700 (let ((line-beg (line-beginning-position)))
4701 (while (and (not (bolp)) (invisible-p (1- (point))))
4702 (goto-char (previous-char-property-change (point) line-beg))))))))
4704 (defun move-end-of-line (arg)
4705 "Move point to end of current line as displayed.
4706 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4707 If point reaches the beginning or end of buffer, it stops there.
4709 To ignore the effects of the `intangible' text or overlay
4710 property, bind `inhibit-point-motion-hooks' to t.
4711 If there is an image in the current line, this function
4712 disregards newlines that are part of the text on which the image
4713 rests."
4714 (interactive "^p")
4715 (or arg (setq arg 1))
4716 (let (done)
4717 (while (not done)
4718 (let ((newpos
4719 (save-excursion
4720 (let ((goal-column 0)
4721 (line-move-visual nil))
4722 (and (line-move arg t)
4723 ;; With bidi reordering, we may not be at bol,
4724 ;; so make sure we are.
4726 (not (bobp))
4727 (progn
4728 (while (and (not (bobp)) (invisible-p (1- (point))))
4729 (goto-char (previous-single-char-property-change
4730 (point) 'invisible)))
4731 (backward-char 1)))
4732 (point)))))
4733 (goto-char newpos)
4734 (if (and (> (point) newpos)
4736 (backward-char 1)
4737 (if (and (> (point) newpos) (not (eobp))
4739 ;; If we skipped something intangible and now we're not
4740 ;; really at eol, keep going.
4741 (setq arg 1)
4742 (setq done t)))))))
4744 (defun move-beginning-of-line (arg)
4745 "Move point to beginning of current line as displayed.
4746 \(If there's an image in the line, this disregards newlines
4747 which are part of the text that the image rests on.)
4749 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4750 If point reaches the beginning or end of buffer, it stops there.
4751 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4752 (interactive "^p")
4753 (or arg (setq arg 1))
4755 (let ((orig (point))
4756 first-vis first-vis-field-value)
4758 ;; Move by lines, if ARG is not 1 (the default).
4759 (if (/= arg 1)
4760 (let ((line-move-visual nil))
4761 (line-move (1- arg) t)))
4763 ;; Move to beginning-of-line, ignoring fields and invisible text.
4765 (while (and (not (bobp)) (invisible-p (1- (point))))
4766 (goto-char (previous-char-property-change (point)))
4769 ;; Now find first visible char in the line
4770 (while (and (not (eobp)) (invisible-p (point)))
4771 (goto-char (next-char-property-change (point))))
4772 (setq first-vis (point))
4774 ;; See if fields would stop us from reaching FIRST-VIS.
4775 (setq first-vis-field-value
4776 (constrain-to-field first-vis orig (/= arg 1) t nil))
4778 (goto-char (if (/= first-vis-field-value first-vis)
4779 ;; If yes, obey them.
4780 first-vis-field-value
4781 ;; Otherwise, move to START with attention to fields.
4782 ;; (It is possible that fields never matter in this case.)
4783 (constrain-to-field (point) orig
4784 (/= arg 1) t nil)))))
4787 ;; Many people have said they rarely use this feature, and often type
4788 ;; it by accident. Maybe it shouldn't even be on a key.
4789 (put 'set-goal-column 'disabled t)
4791 (defun set-goal-column (arg)
4793 Those commands will move to this position in the line moved to
4794 rather than trying to keep the same horizontal position.
4795 With a non-nil argument ARG, clears out the goal column
4797 The goal column is stored in the variable `goal-column'."
4798 (interactive "P")
4799 (if arg
4800 (progn
4801 (setq goal-column nil)
4802 (message "No goal column"))
4803 (setq goal-column (current-column))
4804 ;; The older method below can be erroneous if `set-goal-column' is bound
4805 ;; to a sequence containing %
4806 ;;(message (substitute-command-keys
4808 ;;goal-column)
4809 (message "%s"
4810 (concat
4811 (format "Goal column %d " goal-column)
4812 (substitute-command-keys
4815 )
4816 nil)
4817 \f
4818 ;;; Editing based on visual lines, as opposed to logical lines.
4820 (defun end-of-visual-line (&optional n)
4821 "Move point to end of current visual line.
4822 With argument N not nil or 1, move forward N - 1 visual lines first.
4823 If point reaches the beginning or end of buffer, it stops there.
4824 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4825 (interactive "^p")
4826 (or n (setq n 1))
4827 (if (/= n 1)
4828 (let ((line-move-visual t))
4829 (line-move (1- n) t)))
4830 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4831 ;; constrain to field boundaries, so we don't either.
4832 (vertical-motion (cons (window-width) 0)))
4834 (defun beginning-of-visual-line (&optional n)
4835 "Move point to beginning of current visual line.
4836 With argument N not nil or 1, move forward N - 1 visual lines first.
4837 If point reaches the beginning or end of buffer, it stops there.
4838 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4839 (interactive "^p")
4840 (or n (setq n 1))
4841 (let ((opoint (point)))
4842 (if (/= n 1)
4843 (let ((line-move-visual t))
4844 (line-move (1- n) t)))
4845 (vertical-motion 0)
4846 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4847 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4849 (defun kill-visual-line (&optional arg)
4850 "Kill the rest of the visual line.
4851 With prefix argument ARG, kill that many visual lines from point.
4852 If ARG is negative, kill visual lines backward.
4853 If ARG is zero, kill the text before point on the current visual
4854 line.
4856 If you want to append the killed line to the last killed text,
4859 If the buffer is read-only, Emacs will beep and refrain from deleting
4860 the line, but put the line in the kill ring anyway. This means that
4861 you can use this command to copy text from a read-only buffer.
4862 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4863 even beep.)"
4864 (interactive "P")
4865 ;; Like in `kill-line', it's better to move point to the other end
4866 ;; of the kill before killing.
4867 (let ((opoint (point))
4868 (kill-whole-line (and kill-whole-line (bolp))))
4869 (if arg
4870 (vertical-motion (prefix-numeric-value arg))
4871 (end-of-visual-line 1)
4872 (if (= (point) opoint)
4873 (vertical-motion 1)
4874 ;; Skip any trailing whitespace at the end of the visual line.
4875 ;; We used to do this only if `show-trailing-whitespace' is
4876 ;; nil, but that's wrong; the correct thing would be to check
4877 ;; whether the trailing whitespace is highlighted. But, it's
4878 ;; OK to just do this unconditionally.
4881 (1+ (point))
4882 (point)))))
4884 (defun next-logical-line (&optional arg try-vscroll)
4885 "Move cursor vertically down ARG lines.
4886 This is identical to `next-line', except that it always moves
4887 by logical lines instead of visual lines, ignoring the value of
4888 the variable `line-move-visual'."
4890 (let ((line-move-visual nil))
4891 (with-no-warnings
4892 (next-line arg try-vscroll))))
4894 (defun previous-logical-line (&optional arg try-vscroll)
4895 "Move cursor vertically up ARG lines.
4896 This is identical to `previous-line', except that it always moves
4897 by logical lines instead of visual lines, ignoring the value of
4898 the variable `line-move-visual'."
4900 (let ((line-move-visual nil))
4901 (with-no-warnings
4902 (previous-line arg try-vscroll))))
4904 (defgroup visual-line nil
4905 "Editing based on visual lines."
4906 :group 'convenience
4907 :version "23.1")
4909 (defvar visual-line-mode-map
4910 (let ((map (make-sparse-keymap)))
4911 (define-key map [remap kill-line] 'kill-visual-line)
4912 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4913 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4914 ;; These keybindings interfere with xterm function keys. Are
4915 ;; there any other suitable bindings?
4916 ;; (define-key map "\M-[" 'previous-logical-line)
4917 ;; (define-key map "\M-]" 'next-logical-line)
4918 map))
4920 (defcustom visual-line-fringe-indicators '(nil nil)
4921 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4922 The value should be a list of the form (LEFT RIGHT), where LEFT
4923 and RIGHT are symbols representing the bitmaps to display, to
4924 indicate wrapped lines, in the left and right fringes respectively.
4925 See also `fringe-indicator-alist'.
4926 The default is not to display fringe indicators for wrapped lines.
4927 This variable does not affect fringe indicators displayed for
4928 other purposes."
4929 :type '(list (choice (const :tag "Hide left indicator" nil)
4930 (const :tag "Left curly arrow" left-curly-arrow)
4931 (symbol :tag "Other bitmap"))
4932 (choice (const :tag "Hide right indicator" nil)
4933 (const :tag "Right curly arrow" right-curly-arrow)
4934 (symbol :tag "Other bitmap")))
4935 :set (lambda (symbol value)
4936 (dolist (buf (buffer-list))
4937 (with-current-buffer buf
4938 (when (and (boundp 'visual-line-mode)
4939 (symbol-value 'visual-line-mode))
4940 (setq fringe-indicator-alist
4941 (cons (cons 'continuation value)
4942 (assq-delete-all
4943 'continuation
4944 (copy-tree fringe-indicator-alist)))))))
4945 (set-default symbol value)))
4947 (defvar visual-line--saved-state nil)
4949 (define-minor-mode visual-line-mode
4950 "Toggle visual line based editing (Visual Line mode).
4951 With a prefix argument ARG, enable Visual Line mode if ARG is
4952 positive, and disable it otherwise. If called from Lisp, enable
4953 the mode if ARG is omitted or nil.
4955 When Visual Line mode is enabled, `word-wrap' is turned on in
4956 this buffer, and simple editing commands are redefined to act on
4957 visual lines, not logical lines. See Info node `Visual Line
4958 Mode' for details."
4959 :keymap visual-line-mode-map
4960 :group 'visual-line
4961 :lighter " Wrap"
4962 (if visual-line-mode
4963 (progn
4964 (set (make-local-variable 'visual-line--saved-state) nil)
4965 ;; Save the local values of some variables, to be restored if
4966 ;; visual-line-mode is turned off.
4967 (dolist (var '(line-move-visual truncate-lines
4968 truncate-partial-width-windows
4969 word-wrap fringe-indicator-alist))
4970 (if (local-variable-p var)
4971 (push (cons var (symbol-value var))
4972 visual-line--saved-state)))
4973 (set (make-local-variable 'line-move-visual) t)
4974 (set (make-local-variable 'truncate-partial-width-windows) nil)
4975 (setq truncate-lines nil
4976 word-wrap t
4977 fringe-indicator-alist
4978 (cons (cons 'continuation visual-line-fringe-indicators)
4979 fringe-indicator-alist)))
4980 (kill-local-variable 'line-move-visual)
4981 (kill-local-variable 'word-wrap)
4982 (kill-local-variable 'truncate-lines)
4983 (kill-local-variable 'truncate-partial-width-windows)
4984 (kill-local-variable 'fringe-indicator-alist)
4985 (dolist (saved visual-line--saved-state)
4986 (set (make-local-variable (car saved)) (cdr saved)))
4987 (kill-local-variable 'visual-line--saved-state)))
4989 (defun turn-on-visual-line-mode ()
4990 (visual-line-mode 1))
4992 (define-globalized-minor-mode global-visual-line-mode
4993 visual-line-mode turn-on-visual-line-mode
4994 :lighter " vl")
4996 \f
4997 (defun transpose-chars (arg)
4998 "Interchange characters around point, moving forward one character.
4999 With prefix arg ARG, effect is to take character before point
5000 and drag it forward past ARG other characters (backward if ARG negative).
5001 If no argument and at end of line, the previous two chars are exchanged."
5002 (interactive "*P")
5003 (and (null arg) (eolp) (forward-char -1))
5004 (transpose-subr 'forward-char (prefix-numeric-value arg)))
5006 (defun transpose-words (arg)
5007 "Interchange words around point, leaving point at end of them.
5008 With prefix arg ARG, effect is to take word before or around point
5009 and drag it forward past ARG other words (backward if ARG negative).
5010 If ARG is zero, the words around or after point and around or after mark
5011 are interchanged."
5012 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
5013 (interactive "*p")
5014 (transpose-subr 'forward-word arg))
5016 (defun transpose-sexps (arg)
5018 Does not work on a sexp that point is in the middle of
5019 if it is a list or string."
5020 (interactive "*p")
5021 (transpose-subr
5022 (lambda (arg)
5023 ;; Here we should try to simulate the behavior of
5024 ;; (cons (progn (forward-sexp x) (point))
5025 ;; (progn (forward-sexp (- x)) (point)))
5026 ;; Except that we don't want to rely on the second forward-sexp
5027 ;; putting us back to where we want to be, since forward-sexp-function
5028 ;; might do funny things like infix-precedence.
5029 (if (if (> arg 0)
5031 (and (not (bobp))
5033 ;; Jumping over a symbol. We might be inside it, mind you.
5034 (progn (funcall (if (> arg 0)
5035 'skip-syntax-backward 'skip-syntax-forward)
5036 "w_")
5037 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5038 ;; Otherwise, we're between sexps. Take a step back before jumping
5039 ;; to make sure we'll obey the same precedence no matter which direction
5040 ;; we're going.
5041 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5042 (cons (save-excursion (forward-sexp arg) (point))
5043 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5044 (not (zerop (funcall (if (> arg 0)
5045 'skip-syntax-forward
5046 'skip-syntax-backward)
5047 ".")))))
5048 (point)))))
5049 arg 'special))
5051 (defun transpose-lines (arg)
5052 "Exchange current line and previous line, leaving point after both.
5053 With argument ARG, takes previous line and moves it past ARG lines.
5054 With argument 0, interchanges line point is in with line mark is in."
5055 (interactive "*p")
5056 (transpose-subr (function
5057 (lambda (arg)
5058 (if (> arg 0)
5059 (progn
5060 ;; Move forward over ARG lines,
5061 ;; but create newlines if necessary.
5062 (setq arg (forward-line arg))
5064 (setq arg (1+ arg)))
5065 (if (> arg 0)
5066 (newline arg)))
5067 (forward-line arg))))
5068 arg))
5070 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5071 ;; which seems inconsistent with the ARG /= 0 case.
5072 ;; FIXME document SPECIAL.
5073 (defun transpose-subr (mover arg &optional special)
5074 "Subroutine to do the work of transposing objects.
5075 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5076 moves forward by units of the given object (e.g. forward-sentence,
5077 forward-paragraph). If ARG is zero, exchanges the current object
5078 with the one containing mark. If ARG is an integer, moves the
5079 current object past ARG following (if ARG is positive) or
5080 preceding (if ARG is negative) objects, leaving point after the
5081 current object."
5082 (let ((aux (if special mover
5083 (lambda (x)
5084 (cons (progn (funcall mover x) (point))
5085 (progn (funcall mover (- x)) (point))))))
5086 pos1 pos2)
5087 (cond
5088 ((= arg 0)
5089 (save-excursion
5090 (setq pos1 (funcall aux 1))
5091 (goto-char (or (mark) (error "No mark set in this buffer")))
5092 (setq pos2 (funcall aux 1))
5093 (transpose-subr-1 pos1 pos2))
5094 (exchange-point-and-mark))
5095 ((> arg 0)
5096 (setq pos1 (funcall aux -1))
5097 (setq pos2 (funcall aux arg))
5098 (transpose-subr-1 pos1 pos2)
5099 (goto-char (car pos2)))
5100 (t
5101 (setq pos1 (funcall aux -1))
5102 (goto-char (car pos1))
5103 (setq pos2 (funcall aux arg))
5104 (transpose-subr-1 pos1 pos2)))))
5106 (defun transpose-subr-1 (pos1 pos2)
5107 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5108 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5109 (when (> (car pos1) (car pos2))
5110 (let ((swap pos1))
5111 (setq pos1 pos2 pos2 swap)))
5112 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5113 (atomic-change-group
5114 (let (word2)
5115 ;; FIXME: We first delete the two pieces of text, so markers that
5116 ;; used to point to after the text end up pointing to before it :-(
5117 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5118 (goto-char (car pos2))
5119 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5120 (goto-char (car pos1))
5121 (insert word2))))
5122 \f
5123 (defun backward-word (&optional arg)
5124 "Move backward until encountering the beginning of a word.
5125 With argument ARG, do this that many times."
5126 (interactive "^p")
5127 (forward-word (- (or arg 1))))
5129 (defun mark-word (&optional arg allow-extend)
5130 "Set mark ARG words away from point.
5132 move to with the same argument.
5133 Interactively, if this command is repeated
5134 or (in Transient Mark mode) if the mark is active,
5135 it marks the next ARG words after the ones already marked."
5137 (cond ((and allow-extend
5138 (or (and (eq last-command this-command) (mark t))
5139 (region-active-p)))
5140 (setq arg (if arg (prefix-numeric-value arg)
5141 (if (< (mark) (point)) -1 1)))
5142 (set-mark
5143 (save-excursion
5144 (goto-char (mark))
5145 (forward-word arg)
5146 (point))))
5147 (t
5148 (push-mark
5149 (save-excursion
5150 (forward-word (prefix-numeric-value arg))
5151 (point))
5152 nil t))))
5154 (defun kill-word (arg)
5155 "Kill characters forward until encountering the end of a word.
5156 With argument ARG, do this that many times."
5157 (interactive "p")
5158 (kill-region (point) (progn (forward-word arg) (point))))
5160 (defun backward-kill-word (arg)
5161 "Kill characters backward until encountering the beginning of a word.
5162 With argument ARG, do this that many times."
5163 (interactive "p")
5164 (kill-word (- arg)))
5166 (defun current-word (&optional strict really-word)
5167 "Return the symbol or word that point is on (or a nearby one) as a string.
5168 The return value includes no text properties.
5169 If optional arg STRICT is non-nil, return nil unless point is within
5170 or adjacent to a symbol or word. In all cases the value can be nil
5171 if there is no word nearby.
5172 The function, belying its name, normally finds a symbol.
5173 If optional arg REALLY-WORD is non-nil, it finds just a word."
5174 (save-excursion
5175 (let* ((oldpoint (point)) (start (point)) (end (point))
5176 (syntaxes (if really-word "w" "w_"))
5177 (not-syntaxes (concat "^" syntaxes)))
5178 (skip-syntax-backward syntaxes) (setq start (point))
5179 (goto-char oldpoint)
5180 (skip-syntax-forward syntaxes) (setq end (point))
5181 (when (and (eq start oldpoint) (eq end oldpoint)
5182 ;; Point is neither within nor adjacent to a word.
5183 (not strict))
5184 ;; Look for preceding word in same line.
5185 (skip-syntax-backward not-syntaxes (line-beginning-position))
5186 (if (bolp)
5187 ;; No preceding word in same line.
5188 ;; Look for following word in same line.
5189 (progn
5190 (skip-syntax-forward not-syntaxes (line-end-position))
5191 (setq start (point))
5192 (skip-syntax-forward syntaxes)
5193 (setq end (point)))
5194 (setq end (point))
5195 (skip-syntax-backward syntaxes)
5196 (setq start (point))))
5197 ;; If we found something nonempty, return it as a string.
5198 (unless (= start end)
5199 (buffer-substring-no-properties start end)))))
5200 \f
5201 (defcustom fill-prefix nil
5202 "String for filling to insert at front of new line, or nil for none."
5203 :type '(choice (const :tag "None" nil)
5204 string)
5205 :group 'fill)
5206 (make-variable-buffer-local 'fill-prefix)
5207 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5209 (defcustom auto-fill-inhibit-regexp nil
5210 "Regexp to match lines which should not be auto-filled."
5211 :type '(choice (const :tag "None" nil)
5212 regexp)
5213 :group 'fill)
5215 (defun do-auto-fill ()
5216 "The default value for `normal-auto-fill-function'.
5217 This is the default auto-fill function, some major modes use a different one.
5218 Returns t if it really did any work."
5219 (let (fc justify give-up
5220 (fill-prefix fill-prefix))
5221 (if (or (not (setq justify (current-justification)))
5222 (null (setq fc (current-fill-column)))
5223 (and (eq justify 'left)
5224 (<= (current-column) fc))
5225 (and auto-fill-inhibit-regexp
5226 (save-excursion (beginning-of-line)
5227 (looking-at auto-fill-inhibit-regexp))))
5228 nil ;; Auto-filling not required
5229 (if (memq justify '(full center right))
5230 (save-excursion (unjustify-current-line)))
5232 ;; Choose a fill-prefix automatically.
5233 (when (and adaptive-fill-mode
5234 (or (null fill-prefix) (string= fill-prefix "")))
5235 (let ((prefix
5236 (fill-context-prefix
5237 (save-excursion (fill-forward-paragraph -1) (point))
5238 (save-excursion (fill-forward-paragraph 1) (point)))))
5239 (and prefix (not (equal prefix ""))
5240 ;; Use auto-indentation rather than a guessed empty prefix.
5241 (not (and fill-indent-according-to-mode
5243 (setq fill-prefix prefix))))
5245 (while (and (not give-up) (> (current-column) fc))
5246 ;; Determine where to split the line.
5247 (let* (after-prefix
5248 (fill-point
5249 (save-excursion
5250 (beginning-of-line)
5251 (setq after-prefix (point))
5252 (and fill-prefix
5253 (looking-at (regexp-quote fill-prefix))
5254 (setq after-prefix (match-end 0)))
5255 (move-to-column (1+ fc))
5256 (fill-move-to-break-point after-prefix)
5257 (point))))
5259 ;; See whether the place we found is any good.
5260 (if (save-excursion
5261 (goto-char fill-point)
5262 (or (bolp)
5263 ;; There is no use breaking at end of line.
5264 (save-excursion (skip-chars-forward " ") (eolp))
5265 ;; It is futile to split at the end of the prefix
5266 ;; since we would just insert the prefix again.
5267 (and after-prefix (<= (point) after-prefix))
5268 ;; Don't split right after a comment starter
5269 ;; since we would just make another comment starter.
5270 (and comment-start-skip
5271 (let ((limit (point)))
5272 (beginning-of-line)
5273 (and (re-search-forward comment-start-skip
5274 limit t)
5275 (eq (point) limit))))))
5276 ;; No good place to break => stop trying.
5277 (setq give-up t)
5278 ;; Ok, we have a useful place to break the line. Do it.
5279 (let ((prev-column (current-column)))
5280 ;; If point is at the fill-point, do not `save-excursion'.
5281 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5282 ;; point will end up before it rather than after it.
5283 (if (save-excursion
5285 (= (point) fill-point))
5286 (default-indent-new-line t)
5287 (save-excursion
5288 (goto-char fill-point)
5289 (default-indent-new-line t)))
5290 ;; Now do justification, if required
5291 (if (not (eq justify 'left))
5292 (save-excursion
5293 (end-of-line 0)
5294 (justify-current-line justify nil t)))
5295 ;; If making the new line didn't reduce the hpos of
5296 ;; the end of the line, then give up now;
5297 ;; trying again will not help.
5298 (if (>= (current-column) prev-column)
5299 (setq give-up t))))))
5300 ;; Justify last line.
5301 (justify-current-line justify t t)
5302 t)))
5304 (defvar comment-line-break-function 'comment-indent-new-line
5305 "*Mode-specific function which line breaks and continues a comment.
5306 This function is called during auto-filling when a comment syntax
5307 is defined.
5308 The function should take a single optional argument, which is a flag
5309 indicating whether it should use soft newlines.")
5311 (defun default-indent-new-line (&optional soft)
5312 "Break line at point and indent.
5313 If a comment syntax is defined, call `comment-indent-new-line'.
5315 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5316 unless optional argument SOFT is non-nil."
5317 (interactive)
5318 (if comment-start
5319 (funcall comment-line-break-function soft)
5320 ;; Insert the newline before removing empty space so that markers
5321 ;; get preserved better.
5323 (save-excursion (forward-char -1) (delete-horizontal-space))
5324 (delete-horizontal-space)
5326 (if (and fill-prefix (not adaptive-fill-mode))
5327 ;; Blindly trust a non-adaptive fill-prefix.
5328 (progn
5329 (indent-to-left-margin)
5330 (insert-before-markers-and-inherit fill-prefix))
5332 (cond
5333 ;; If there's an adaptive prefix, use it unless we're inside
5334 ;; a comment and the prefix is not a comment starter.
5335 (fill-prefix
5336 (indent-to-left-margin)
5337 (insert-and-inherit fill-prefix))
5338 ;; If we're not inside a comment, just try to indent.
5339 (t (indent-according-to-mode))))))
5341 (defvar normal-auto-fill-function 'do-auto-fill
5342 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5343 Some major modes set this.")
5345 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5346 ;; `functions' and `hooks' are usually unsafe to set, but setting
5347 ;; auto-fill-function to nil in a file-local setting is safe and
5348 ;; can be useful to prevent auto-filling.
5349 (put 'auto-fill-function 'safe-local-variable 'null)
5351 (define-minor-mode auto-fill-mode
5352 "Toggle automatic line breaking (Auto Fill mode).
5353 With a prefix argument ARG, enable Auto Fill mode if ARG is
5354 positive, and disable it otherwise. If called from Lisp, enable
5355 the mode if ARG is omitted or nil.
5357 When Auto Fill mode is enabled, inserting a space at a column
5358 beyond `current-fill-column' automatically breaks the line at a
5359 previous space.
5361 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5362 non-`nil'.
5364 The value of `normal-auto-fill-function' specifies the function to use
5365 for `auto-fill-function' when turning Auto Fill mode on."
5366 :variable (eq auto-fill-function normal-auto-fill-function))
5368 ;; This holds a document string used to document auto-fill-mode.
5369 (defun auto-fill-function ()
5370 "Automatically break line at a previous space, in insertion of text."
5371 nil)
5373 (defun turn-on-auto-fill ()
5374 "Unconditionally turn on Auto Fill mode."
5375 (auto-fill-mode 1))
5377 (defun turn-off-auto-fill ()
5378 "Unconditionally turn off Auto Fill mode."
5379 (auto-fill-mode -1))
5381 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5383 (defun set-fill-column (arg)
5384 "Set `fill-column' to specified argument.
5387 (interactive
5388 (list (or current-prefix-arg
5389 ;; We used to use current-column silently, but C-x f is too easily
5390 ;; typed as a typo for C-x C-f, so we turned it into an error and
5391 ;; now an interactive prompt.
5392 (read-number "Set fill-column to: " (current-column)))))
5393 (if (consp arg)
5394 (setq arg (current-column)))
5395 (if (not (integerp arg))
5396 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5397 (error "set-fill-column requires an explicit argument")
5398 (message "Fill column set to %d (was %d)" arg fill-column)
5399 (setq fill-column arg)))
5400 \f
5401 (defun set-selective-display (arg)
5402 "Set `selective-display' to ARG; clear it if no arg.
5403 When the value of `selective-display' is a number > 0,
5404 lines whose indentation is >= that value are not displayed.
5405 The variable `selective-display' has a separate value for each buffer."
5406 (interactive "P")
5407 (if (eq selective-display t)
5408 (error "selective-display already in use for marked lines"))
5409 (let ((current-vpos
5410 (save-restriction
5411 (narrow-to-region (point-min) (point))
5412 (goto-char (window-start))
5413 (vertical-motion (window-height)))))
5414 (setq selective-display
5415 (and arg (prefix-numeric-value arg)))
5416 (recenter current-vpos))
5417 (set-window-start (selected-window) (window-start (selected-window)))
5418 (princ "selective-display set to " t)
5419 (prin1 selective-display t)
5420 (princ "." t))
5422 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5424 (defun toggle-truncate-lines (&optional arg)
5425 "Toggle truncating of long lines for the current buffer.
5426 When truncating is off, long lines are folded.
5427 With prefix argument ARG, truncate long lines if ARG is positive,
5428 otherwise fold them. Note that in side-by-side windows, this
5429 command has no effect if `truncate-partial-width-windows' is
5430 non-nil."
5431 (interactive "P")
5432 (setq truncate-lines
5433 (if (null arg)
5434 (not truncate-lines)
5435 (> (prefix-numeric-value arg) 0)))
5436 (force-mode-line-update)
5437 (unless truncate-lines
5438 (let ((buffer (current-buffer)))
5439 (walk-windows (lambda (window)
5440 (if (eq buffer (window-buffer window))
5441 (set-window-hscroll window 0)))
5442 nil t)))
5443 (message "Truncate long lines %s"
5444 (if truncate-lines "enabled" "disabled")))
5446 (defun toggle-word-wrap (&optional arg)
5447 "Toggle whether to use word-wrapping for continuation lines.
5448 With prefix argument ARG, wrap continuation lines at word boundaries
5449 if ARG is positive, otherwise wrap them at the right screen edge.
5450 This command toggles the value of `word-wrap'. It has no effect
5451 if long lines are truncated."
5452 (interactive "P")
5453 (setq word-wrap
5454 (if (null arg)
5455 (not word-wrap)
5456 (> (prefix-numeric-value arg) 0)))
5457 (force-mode-line-update)
5458 (message "Word wrapping %s"
5459 (if word-wrap "enabled" "disabled")))
5461 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5462 "The string displayed in the mode line when in overwrite mode.")
5463 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5464 "The string displayed in the mode line when in binary overwrite mode.")
5466 (define-minor-mode overwrite-mode
5467 "Toggle Overwrite mode.
5468 With a prefix argument ARG, enable Overwrite mode if ARG is
5469 positive, and disable it otherwise. If called from Lisp, enable
5470 the mode if ARG is omitted or nil.
5472 When Overwrite mode is enabled, printing characters typed in
5473 replace existing text on a one-for-one basis, rather than pushing
5474 it to the right. At the end of a line, such characters extend
5475 the line. Before a tab, such characters insert until the tab is
5477 overwrite mode; this is supposed to make it easier to insert
5478 characters when necessary."
5479 :variable (eq overwrite-mode 'overwrite-mode-textual))
5481 (define-minor-mode binary-overwrite-mode
5482 "Toggle Binary Overwrite mode.
5483 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5484 is positive, and disable it otherwise. If called from Lisp,
5485 enable the mode if ARG is omitted or nil.
5487 When Binary Overwrite mode is enabled, printing characters typed
5488 in replace existing text. Newlines are not treated specially, so
5489 typing at the end of a line joins the line to the next, with the
5490 typed character between them. Typing before a tab character
5491 simply replaces the tab with the character typed.
5493 ordinary typing characters do.
5495 Note that Binary Overwrite mode is not its own minor mode; it is
5496 a specialization of overwrite mode, entered by setting the
5497 `overwrite-mode' variable to `overwrite-mode-binary'."
5498 :variable (eq overwrite-mode 'overwrite-mode-binary))
5500 (define-minor-mode line-number-mode
5501 "Toggle line number display in the mode line (Line Number mode).
5502 With a prefix argument ARG, enable Line Number mode if ARG is
5503 positive, and disable it otherwise. If called from Lisp, enable
5504 the mode if ARG is omitted or nil.
5506 Line numbers do not appear for very large buffers and buffers
5507 with very long lines; see variables `line-number-display-limit'
5508 and `line-number-display-limit-width'."
5509 :init-value t :global t :group 'mode-line)
5511 (define-minor-mode column-number-mode
5512 "Toggle column number display in the mode line (Column Number mode).
5513 With a prefix argument ARG, enable Column Number mode if ARG is
5514 positive, and disable it otherwise.
5516 If called from Lisp, enable the mode if ARG is omitted or nil."
5517 :global t :group 'mode-line)
5519 (define-minor-mode size-indication-mode
5520 "Toggle buffer size display in the mode line (Size Indication mode).
5521 With a prefix argument ARG, enable Size Indication mode if ARG is
5522 positive, and disable it otherwise.
5524 If called from Lisp, enable the mode if ARG is omitted or nil."
5525 :global t :group 'mode-line)
5527 (define-minor-mode auto-save-mode
5528 "Toggle auto-saving in the current buffer (Auto Save mode).
5529 With a prefix argument ARG, enable Auto Save mode if ARG is
5530 positive, and disable it otherwise.
5532 If called from Lisp, enable the mode if ARG is omitted or nil."
5533 :variable ((and buffer-auto-save-file-name
5534 ;; If auto-save is off because buffer has shrunk,
5535 ;; then toggling should turn it on.
5536 (>= buffer-saved-size 0))
5537 . (lambda (val)
5538 (setq buffer-auto-save-file-name
5539 (cond
5540 ((null val) nil)
5541 ((and buffer-file-name auto-save-visited-file-name
5542 (not buffer-read-only))
5543 buffer-file-name)
5544 (t (make-auto-save-file-name))))))
5545 ;; If -1 was stored here, to temporarily turn off saving,
5546 ;; turn it back on.
5547 (and (< buffer-saved-size 0)
5548 (setq buffer-saved-size 0)))
5549 \f
5550 (defgroup paren-blinking nil
5551 "Blinking matching of parens and expressions."
5552 :prefix "blink-matching-"
5553 :group 'paren-matching)
5555 (defcustom blink-matching-paren t
5556 "Non-nil means show matching open-paren when close-paren is inserted."
5557 :type 'boolean
5558 :group 'paren-blinking)
5560 (defcustom blink-matching-paren-on-screen t
5561 "Non-nil means show matching open-paren when it is on screen.
5562 If nil, don't show it (but the open-paren can still be shown
5563 when it is off screen).
5565 This variable has no effect if `blink-matching-paren' is nil.
5566 \(In that case, the open-paren is never shown.)
5567 It is also ignored if `show-paren-mode' is enabled."
5568 :type 'boolean
5569 :group 'paren-blinking)
5571 (defcustom blink-matching-paren-distance (* 100 1024)
5572 "If non-nil, maximum distance to search backwards for matching open-paren.
5573 If nil, search stops at the beginning of the accessible portion of the buffer."
5574 :version "23.2" ; 25->100k
5575 :type '(choice (const nil) integer)
5576 :group 'paren-blinking)
5578 (defcustom blink-matching-delay 1
5579 "Time in seconds to delay after showing a matching paren."
5580 :type 'number
5581 :group 'paren-blinking)
5583 (defcustom blink-matching-paren-dont-ignore-comments nil
5584 "If nil, `blink-matching-paren' ignores comments.
5585 More precisely, when looking for the matching parenthesis,
5586 it skips the contents of comments that end before point."
5587 :type 'boolean
5588 :group 'paren-blinking)
5590 (defun blink-matching-check-mismatch (start end)
5591 "Return whether or not START...END are matching parens.
5592 END is the current point and START is the blink position.
5593 START might be nil if no matching starter was found.
5594 Returns non-nil if we find there is a mismatch."
5595 (let* ((end-syntax (syntax-after (1- end)))
5596 (matching-paren (and (consp end-syntax)
5597 (eq (syntax-class end-syntax) 5)
5598 (cdr end-syntax))))
5599 ;; For self-matched chars like " and $, we can't know when they're
5600 ;; mismatched or unmatched, so we can only do it for parens.
5601 (when matching-paren
5602 (not (and start
5603 (or
5604 (eq (char-after start) matching-paren)
5605 ;; The cdr might hold a new paren-class info rather than
5606 ;; a matching-char info, in which case the two CDRs
5607 ;; should match.
5608 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5610 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5611 "Function to check parentheses mismatches.
5612 The function takes two arguments (START and END) where START is the
5613 position just before the opening token and END is the position right after.
5614 START can be nil, if it was not found.
5615 The function should return non-nil if the two tokens do not match.")
5617 (defun blink-matching-open ()
5618 "Move cursor momentarily to the beginning of the sexp before point."
5619 (interactive)
5620 (when (and (not (bobp))
5621 blink-matching-paren)
5622 (let* ((oldpos (point))
5623 (message-log-max nil) ; Don't log messages about paren matching.
5624 (blinkpos
5625 (save-excursion
5626 (save-restriction
5627 (if blink-matching-paren-distance
5628 (narrow-to-region
5629 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5630 (- (point) blink-matching-paren-distance))
5631 oldpos))
5632 (let ((parse-sexp-ignore-comments
5633 (and parse-sexp-ignore-comments
5634 (not blink-matching-paren-dont-ignore-comments))))
5635 (condition-case ()
5636 (progn
5637 (forward-sexp -1)
5638 ;; backward-sexp skips backward over prefix chars,
5639 ;; so move back to the matching paren.
5640 (while (and (< (point) (1- oldpos))
5641 (let ((code (syntax-after (point))))
5642 (or (eq (syntax-class code) 6)
5643 (eq (logand 1048576 (car code))
5644 1048576))))
5645 (forward-char 1))
5646 (point))
5647 (error nil))))))
5648 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5649 (cond
5650 (mismatch
5651 (if blinkpos
5652 (if (minibufferp)
5653 (minibuffer-message "Mismatched parentheses")
5654 (message "Mismatched parentheses"))
5655 (if (minibufferp)
5656 (minibuffer-message "No matching parenthesis found")
5657 (message "No matching parenthesis found"))))
5658 ((not blinkpos) nil)
5659 ((pos-visible-in-window-p blinkpos)
5660 ;; Matching open within window, temporarily move to blinkpos but only
5661 ;; if `blink-matching-paren-on-screen' is non-nil.
5662 (and blink-matching-paren-on-screen
5663 (not show-paren-mode)
5664 (save-excursion
5665 (goto-char blinkpos)
5666 (sit-for blink-matching-delay))))
5667 (t
5668 (save-excursion
5669 (goto-char blinkpos)
5670 (let ((open-paren-line-string
5671 ;; Show what precedes the open in its line, if anything.
5672 (cond
5674 (buffer-substring (line-beginning-position)
5675 (1+ blinkpos)))
5676 ;; Show what follows the open in its line, if anything.
5677 ((save-excursion
5678 (forward-char 1)
5680 (not (eolp)))
5681 (buffer-substring blinkpos
5682 (line-end-position)))
5683 ;; Otherwise show the previous nonblank line,
5684 ;; if there is one.
5686 (concat
5687 (buffer-substring (progn
5689 (line-beginning-position))
5690 (progn (end-of-line)
5692 (point)))
5693 ;; Replace the newline and other whitespace with `...'.
5694 "..."
5695 (buffer-substring blinkpos (1+ blinkpos))))
5696 ;; There is nothing to show except the char itself.
5697 (t (buffer-substring blinkpos (1+ blinkpos))))))
5698 (message "Matches %s"
5699 (substring-no-properties open-paren-line-string)))))))))
5701 (defvar blink-paren-function 'blink-matching-open
5702 "Function called, if non-nil, whenever a close parenthesis is inserted.
5703 More precisely, a char with closeparen syntax is self-inserted.")
5705 (defun blink-paren-post-self-insert-function ()
5706 (when (and (eq (char-before) last-command-event) ; Sanity check.
5707 (memq (char-syntax last-command-event) '(?\) ?\$))
5708 blink-paren-function
5709 (not executing-kbd-macro)
5710 (not noninteractive)
5711 ;; Verify an even number of quoting characters precede the close.
5712 (= 1 (logand 1 (- (point)
5713 (save-excursion
5714 (forward-char -1)
5716 (point))))))
5717 (funcall blink-paren-function)))
5719 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5720 ;; Most likely, this hook is nil, so this arg doesn't matter,
5721 ;; but I use it as a reminder that this function usually
5722 ;; likes to be run after others since it does `sit-for'.
5723 'append)
5724 \f
5725 ;; This executes C-g typed while Emacs is waiting for a command.
5726 ;; Quitting out of a program does not go through here;
5727 ;; that happens in the QUIT macro at the C code level.
5728 (defun keyboard-quit ()
5729 "Signal a `quit' condition.
5730 During execution of Lisp code, this character causes a quit directly.
5731 At top-level, as an editor command, this simply beeps."
5732 (interactive)
5733 ;; Avoid adding the region to the window selection.
5734 (setq saved-region-selection nil)
5735 (let (select-active-regions)
5736 (deactivate-mark))
5737 (if (fboundp 'kmacro-keyboard-quit)
5738 (kmacro-keyboard-quit))
5739 (setq defining-kbd-macro nil)
5740 (let ((debug-on-quit nil))
5741 (signal 'quit nil)))
5743 (defvar buffer-quit-function nil
5746 \(such as canceling a prefix argument, minibuffer or region) do not apply.")
5748 (defun keyboard-escape-quit ()
5750 This command can exit an interactive command such as `query-replace',
5751 can clear out a prefix argument or a region,
5752 can get out of the minibuffer or other recursive edit,
5753 cancel the use of the current buffer (for special-purpose buffers),
5754 or go back to just one window (by deleting all but the selected window)."
5755 (interactive)
5756 (cond ((eq last-command 'mode-exited) nil)
5757 ((region-active-p)
5758 (deactivate-mark))
5759 ((> (minibuffer-depth) 0)
5760 (abort-recursive-edit))
5761 (current-prefix-arg
5762 nil)
5763 ((> (recursion-depth) 0)
5764 (exit-recursive-edit))
5765 (buffer-quit-function
5766 (funcall buffer-quit-function))
5767 ((not (one-window-p t))
5768 (delete-other-windows))
5770 (bury-buffer))))
5772 (defun play-sound-file (file &optional volume device)
5773 "Play sound stored in FILE.
5774 VOLUME and DEVICE correspond to the keywords of the sound
5775 specification for `play-sound'."
5776 (interactive "fPlay sound file: ")
5777 (let ((sound (list :file file)))
5778 (if volume
5779 (plist-put sound :volume volume))
5780 (if device
5781 (plist-put sound :device device))
5782 (push 'sound sound)
5783 (play-sound sound)))
5785 \f
5786 (defcustom read-mail-command 'rmail
5787 "Your preference for a mail reading package.
5788 This is used by some keybindings which support reading mail.
5789 See also `mail-user-agent' concerning sending mail."
5792 (function-item :tag "Emacs interface to MH"
5794 (function :tag "Other"))
5795 :version "21.1"
5796 :group 'mail)
5798 (defcustom mail-user-agent 'message-user-agent
5799 "Your preference for a mail composition package.
5800 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5801 outgoing email message. This variable lets you specify which
5802 mail-sending package you prefer.
5804 Valid values include:
5806 `message-user-agent' -- use the Message package.
5807 See Info node `(message)'.
5808 `sendmail-user-agent' -- use the Mail package.
5809 See Info node `(emacs)Sending Mail'.
5810 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5811 See Info node `(mh-e)'.
5812 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5813 paraphernalia if Gnus is running, particularly
5814 the Gcc: header for archiving.
5816 Additional valid symbols may be available; check with the author of
5817 your package for details. The function should return non-nil if it
5818 succeeds.
5820 See also `read-mail-command' concerning reading mail."
5821 :type '(radio (function-item :tag "Message package"
5823 message-user-agent)
5824 (function-item :tag "Mail package"
5826 sendmail-user-agent)
5827 (function-item :tag "Emacs interface to MH"
5829 mh-e-user-agent)
5830 (function-item :tag "Message with full Gnus features"
5832 gnus-user-agent)
5833 (function :tag "Other"))
5834 :version "23.2" ; sendmail->message
5835 :group 'mail)
5837 (defcustom compose-mail-user-agent-warnings t
5838 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5839 If the value of `mail-user-agent' is the default, and the user
5840 appears to have customizations applying to the old default,
5841 `compose-mail' issues a warning."
5842 :type 'boolean
5843 :version "23.2"
5844 :group 'mail)
5846 (defun rfc822-goto-eoh ()
5847 "If the buffer starts with a mail header, move point to the header's end.
5848 Otherwise, moves to `point-min'.
5849 The end of the header is the start of the next line, if there is one,
5850 else the end of the last line. This function obeys RFC822."
5851 (goto-char (point-min))
5852 (when (re-search-forward
5854 (goto-char (match-beginning 0))))
5856 ;; Used by Rmail (e.g., rmail-forward).
5857 (defvar mail-encode-mml nil
5858 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5859 the outgoing message before sending it.")
5861 (defun compose-mail (&optional to subject other-headers continue
5862 switch-function yank-action send-actions
5863 return-action)
5864 "Start composing a mail message to send.
5865 This uses the user's chosen mail composition package
5866 as selected with the variable `mail-user-agent'.
5867 The optional arguments TO and SUBJECT specify recipients
5868 and the initial Subject field, respectively.
5870 OTHER-HEADERS is an alist specifying additional
5871 header fields. Elements look like (HEADER . VALUE) where both
5872 HEADER and VALUE are strings.
5874 CONTINUE, if non-nil, says to continue editing a message already
5875 being composed. Interactively, CONTINUE is the prefix argument.
5877 SWITCH-FUNCTION, if non-nil, is a function to use to
5878 switch to and display the buffer used for mail composition.
5880 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5881 to insert the raw text of the message being replied to.
5882 It has the form (FUNCTION . ARGS). The user agent will apply
5883 FUNCTION to ARGS, to insert the raw text of the original message.
5884 \(The user agent will also run `mail-citation-hook', *after* the
5885 original text has been inserted in this way.)
5887 SEND-ACTIONS is a list of actions to call when the message is sent.
5888 Each action has the form (FUNCTION . ARGS).
5890 RETURN-ACTION, if non-nil, is an action for returning to the
5891 caller. It has the form (FUNCTION . ARGS). The function is
5892 called after the mail has been sent or put aside, and the mail
5893 buffer buried."
5894 (interactive
5895 (list nil nil nil current-prefix-arg))
5897 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5898 ;; from sendmail-user-agent to message-user-agent. Some users may
5899 ;; encounter incompatibilities. This hack tries to detect problems
5900 ;; and warn about them.
5901 (and compose-mail-user-agent-warnings
5902 (eq mail-user-agent 'message-user-agent)
5903 (let (warn-vars)
5904 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5905 mail-yank-hooks mail-archive-file-name
5906 mail-default-reply-to mail-mailing-lists
5907 mail-self-blind))
5908 (and (boundp var)
5909 (symbol-value var)
5910 (push var warn-vars)))
5911 (when warn-vars
5912 (display-warning 'mail
5913 (format "\
5914 The default mail mode is now Message mode.
5915 You have the following Mail mode variable%s customized:
5917 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5918 (if (> (length warn-vars) 1) "s" "")
5919 (mapconcat 'symbol-name
5920 warn-vars " "))))))
5922 (let ((function (get mail-user-agent 'composefunc)))
5923 (funcall function to subject other-headers continue switch-function
5924 yank-action send-actions return-action)))
5926 (defun compose-mail-other-window (&optional to subject other-headers continue
5927 yank-action send-actions
5928 return-action)
5930 (interactive (list nil nil nil current-prefix-arg))
5931 (compose-mail to subject other-headers continue
5932 'switch-to-buffer-other-window yank-action send-actions
5933 return-action))
5935 (defun compose-mail-other-frame (&optional to subject other-headers continue
5936 yank-action send-actions
5937 return-action)
5939 (interactive (list nil nil nil current-prefix-arg))
5940 (compose-mail to subject other-headers continue
5941 'switch-to-buffer-other-frame yank-action send-actions
5942 return-action))
5944 \f
5945 (defvar set-variable-value-history nil
5946 "History of values entered with `set-variable'.
5948 Maximum length of the history list is determined by the value
5949 of `history-length', which see.")
5951 (defun set-variable (variable value &optional make-local)
5952 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5953 VARIABLE should be a user option variable name, a Lisp variable
5954 meant to be customized by users. You should enter VALUE in Lisp syntax,
5955 so if you want VALUE to be a string, you must surround it with doublequotes.
5956 VALUE is used literally, not evaluated.
5958 If VARIABLE has a `variable-interactive' property, that is used as if
5959 it were the arg to `interactive' (which see) to interactively read VALUE.
5961 If VARIABLE has been defined with `defcustom', then the type information
5962 in the definition is used to check that VALUE is valid.
5964 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5965 (interactive
5966 (let* ((default-var (variable-at-point))
5967 (var (if (user-variable-p default-var)
5968 (read-variable (format "Set variable (default %s): " default-var)
5969 default-var)
5970 (read-variable "Set variable: ")))
5971 (minibuffer-help-form '(describe-variable var))
5972 (prop (get var 'variable-interactive))
5973 (obsolete (car (get var 'byte-obsolete-variable)))
5974 (prompt (format "Set %s %s to value: " var
5975 (cond ((local-variable-p var)
5976 "(buffer-local)")
5977 ((or current-prefix-arg
5978 (local-variable-if-set-p var))
5979 "buffer-locally")
5980 (t "globally"))))
5981 (val (progn
5982 (when obsolete
5983 (message (concat "`%S' is obsolete; "
5984 (if (symbolp obsolete) "use `%S' instead" "%s"))
5985 var obsolete)
5986 (sit-for 3))
5987 (if prop
5988 ;; Use VAR's `variable-interactive' property
5989 ;; as an interactive spec for prompting.
5990 (call-interactively `(lambda (arg)
5991 (interactive ,prop)
5992 arg))
5993 (read
5994 (read-string prompt nil
5995 'set-variable-value-history
5996 (format "%S" (symbol-value var))))))))
5997 (list var val current-prefix-arg)))
5999 (and (custom-variable-p variable)
6000 (not (get variable 'custom-type))
6001 (custom-load-symbol variable))
6002 (let ((type (get variable 'custom-type)))
6003 (when type
6004 ;; Match with custom type.
6005 (require 'cus-edit)
6006 (setq type (widget-convert type))
6007 (unless (widget-apply type :match value)
6008 (error "Value `%S' does not match type %S of %S"
6009 value (car type) variable))))
6011 (if make-local
6012 (make-local-variable variable))
6014 (set variable value)
6016 ;; Force a thorough redisplay for the case that the variable
6017 ;; has an effect on the display, like `tab-width' has.
6018 (force-mode-line-update))
6019 \f
6020 ;; Define the major mode for lists of completions.
6022 (defvar completion-list-mode-map
6023 (let ((map (make-sparse-keymap)))
6024 (define-key map [mouse-2] 'mouse-choose-completion)
6025 (define-key map [follow-link] 'mouse-face)
6026 (define-key map [down-mouse-2] nil)
6027 (define-key map "\C-m" 'choose-completion)
6028 (define-key map "\e\e\e" 'delete-completion-window)
6029 (define-key map [left] 'previous-completion)
6030 (define-key map [right] 'next-completion)
6031 (define-key map "q" 'quit-window)
6032 (define-key map "z" 'kill-this-buffer)
6033 map)
6034 "Local map for completion list buffers.")
6036 ;; Completion mode is suitable only for specially formatted data.
6037 (put 'completion-list-mode 'mode-class 'special)
6039 (defvar completion-reference-buffer nil
6040 "Record the buffer that was current when the completion list was requested.
6041 This is a local variable in the completion list buffer.
6042 Initial value is nil to avoid some compiler warnings.")
6044 (defvar completion-no-auto-exit nil
6045 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6046 This also applies to other functions such as `choose-completion'.")
6048 (defvar completion-base-position nil
6049 "Position of the base of the text corresponding to the shown completions.
6050 This variable is used in the *Completions* buffers.
6051 Its value is a list of the form (START END) where START is the place
6052 where the completion should be inserted and END (if non-nil) is the end
6053 of the text to replace. If END is nil, point is used instead.")
6055 (defvar completion-list-insert-choice-function #'completion--replace
6056 "Function to use to insert the text chosen in *Completions*.
6057 Called with three arguments (BEG END TEXT), it should replace the text
6058 between BEG and END with TEXT. Expected to be set buffer-locally
6059 in the *Completions* buffer.")
6061 (defvar completion-base-size nil
6062 "Number of chars before point not involved in completion.
6063 This is a local variable in the completion list buffer.
6064 It refers to the chars in the minibuffer if completing in the
6065 minibuffer, or in `completion-reference-buffer' otherwise.
6066 Only characters in the field at point are included.
6068 If nil, Emacs determines which part of the tail end of the
6069 buffer's text is involved in completion by comparing the text
6070 directly.")
6071 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6073 (defun delete-completion-window ()
6074 "Delete the completion list window.
6075 Go to the window from which completion was requested."
6076 (interactive)
6077 (let ((buf completion-reference-buffer))
6078 (if (one-window-p t)
6079 (if (window-dedicated-p (selected-window))
6080 (delete-frame (selected-frame)))
6081 (delete-window (selected-window))
6082 (if (get-buffer-window buf)
6083 (select-window (get-buffer-window buf))))))
6085 (defun previous-completion (n)
6086 "Move to the previous item in the completion list."
6087 (interactive "p")
6088 (next-completion (- n)))
6090 (defun next-completion (n)
6091 "Move to the next item in the completion list.
6092 With prefix argument N, move N items (negative N means move backward)."
6093 (interactive "p")
6094 (let ((beg (point-min)) (end (point-max)))
6095 (while (and (> n 0) (not (eobp)))
6096 ;; If in a completion, move to the end of it.
6097 (when (get-text-property (point) 'mouse-face)
6098 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6099 ;; Move to start of next one.
6100 (unless (get-text-property (point) 'mouse-face)
6101 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6102 (setq n (1- n)))
6103 (while (and (< n 0) (not (bobp)))
6104 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6105 ;; If in a completion, move to the start of it.
6106 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6107 (goto-char (previous-single-property-change
6108 (point) 'mouse-face nil beg)))
6109 ;; Move to end of the previous completion.
6110 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6111 (goto-char (previous-single-property-change
6112 (point) 'mouse-face nil beg)))
6113 ;; Move to the start of that one.
6114 (goto-char (previous-single-property-change
6115 (point) 'mouse-face nil beg))
6116 (setq n (1+ n))))))
6118 (defun choose-completion (&optional event)
6119 "Choose the completion at point."
6120 (interactive (list last-nonmenu-event))
6121 ;; In case this is run via the mouse, give temporary modes such as
6122 ;; isearch a chance to turn off.
6123 (run-hooks 'mouse-leave-buffer-hook)
6124 (with-current-buffer (window-buffer (posn-window (event-start event)))
6125 (let ((buffer completion-reference-buffer)
6126 (base-size completion-base-size)
6127 (base-position completion-base-position)
6128 (insert-function completion-list-insert-choice-function)
6129 (choice
6130 (save-excursion
6131 (goto-char (posn-point (event-start event)))
6132 (let (beg end)
6133 (cond
6134 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6135 (setq end (point) beg (1+ (point))))
6136 ((and (not (bobp))
6137 (get-text-property (1- (point)) 'mouse-face))
6138 (setq end (1- (point)) beg (point)))
6139 (t (error "No completion here")))
6140 (setq beg (previous-single-property-change beg 'mouse-face))
6141 (setq end (or (next-single-property-change end 'mouse-face)
6142 (point-max)))
6143 (buffer-substring-no-properties beg end))))
6144 (owindow (selected-window)))
6146 (unless (buffer-live-p buffer)
6147 (error "Destination buffer is dead"))
6148 (select-window (posn-window (event-start event)))
6149 (if (and (one-window-p t 'selected-frame)
6150 (window-dedicated-p (selected-window)))
6151 ;; This is a special buffer's frame
6152 (iconify-frame (selected-frame))
6153 (or (window-dedicated-p (selected-window))
6154 (bury-buffer)))
6155 (select-window
6156 (or (get-buffer-window buffer 0)
6157 owindow))
6159 (with-current-buffer buffer
6160 (choose-completion-string
6161 choice buffer
6162 (or base-position
6163 (when base-size
6164 ;; Someone's using old completion code that doesn't know
6165 ;; about base-position yet.
6166 (list (+ base-size (field-beginning))))
6167 ;; If all else fails, just guess.
6168 (list (choose-completion-guess-base-position choice)))
6169 insert-function)))))
6171 ;; Delete the longest partial match for STRING
6172 ;; that can be found before POINT.
6173 (defun choose-completion-guess-base-position (string)
6174 (save-excursion
6175 (let ((opoint (point))
6176 len)
6177 ;; Try moving back by the length of the string.
6178 (goto-char (max (- (point) (length string))
6179 (minibuffer-prompt-end)))
6180 ;; See how far back we were actually able to move. That is the
6181 ;; upper bound on how much we can match and delete.
6182 (setq len (- opoint (point)))
6183 (if completion-ignore-case
6184 (setq string (downcase string)))
6185 (while (and (> len 0)
6186 (let ((tail (buffer-substring (point) opoint)))
6187 (if completion-ignore-case
6188 (setq tail (downcase tail)))
6189 (not (string= tail (substring string 0 len)))))
6190 (setq len (1- len))
6191 (forward-char 1))
6192 (point))))
6194 (defun choose-completion-delete-max-match (string)
6195 (delete-region (choose-completion-guess-base-position string) (point)))
6196 (make-obsolete 'choose-completion-delete-max-match
6197 'choose-completion-guess-base-position "23.2")
6199 (defvar choose-completion-string-functions nil
6200 "Functions that may override the normal insertion of a completion choice.
6201 These functions are called in order with four arguments:
6202 CHOICE - the string to insert in the buffer,
6203 BUFFER - the buffer in which the choice should be inserted,
6204 MINI-P - non-nil if BUFFER is a minibuffer, and
6205 BASE-SIZE - the number of characters in BUFFER before
6206 the string being completed.
6208 If a function in the list returns non-nil, that function is supposed
6209 to have inserted the CHOICE in the BUFFER, and possibly exited
6210 the minibuffer; no further functions will be called.
6212 If all functions in the list return nil, that means to use
6213 the default method of inserting the completion in BUFFER.")
6215 (defun choose-completion-string (choice &optional
6216 buffer base-position insert-function)
6217 "Switch to BUFFER and insert the completion choice CHOICE.
6218 BASE-POSITION, says where to insert the completion."
6220 ;; If BUFFER is the minibuffer, exit the minibuffer
6221 ;; unless it is reading a file name and CHOICE is a directory,
6222 ;; or completion-no-auto-exit is non-nil.
6224 ;; Some older code may call us passing `base-size' instead of
6225 ;; `base-position'. It's difficult to make any use of `base-size',
6226 ;; so we just ignore it.
6227 (unless (consp base-position)
6228 (message "Obsolete `base-size' passed to choose-completion-string")
6229 (setq base-position nil))
6231 (let* ((buffer (or buffer completion-reference-buffer))
6232 (mini-p (minibufferp buffer)))
6233 ;; If BUFFER is a minibuffer, barf unless it's the currently
6234 ;; active minibuffer.
6235 (if (and mini-p
6236 (not (and (active-minibuffer-window)
6237 (equal buffer
6238 (window-buffer (active-minibuffer-window))))))
6239 (error "Minibuffer is not active for completion")
6240 ;; Set buffer so buffer-local choose-completion-string-functions works.
6241 (set-buffer buffer)
6242 (unless (run-hook-with-args-until-success
6243 'choose-completion-string-functions
6244 ;; The fourth arg used to be `mini-p' but was useless
6245 ;; (since minibufferp can be used on the `buffer' arg)
6246 ;; and indeed unused. The last used to be `base-size', so we
6247 ;; keep it to try and avoid breaking old code.
6248 choice buffer base-position nil)
6249 ;; This remove-text-properties should be unnecessary since `choice'
6250 ;; comes from buffer-substring-no-properties.
6251 ;;(remove-text-properties 0 (length choice) '(mouse-face nil) choice)
6252 ;; Insert the completion into the buffer where it was requested.
6253 (funcall (or insert-function completion-list-insert-choice-function)
6254 (or (car base-position) (point))
6255 (or (cadr base-position) (point))
6256 choice)
6257 ;; Update point in the window that BUFFER is showing in.
6258 (let ((window (get-buffer-window buffer t)))
6259 (set-window-point window (point)))
6260 ;; If completing for the minibuffer, exit it with this choice.
6261 (and (not completion-no-auto-exit)
6262 (minibufferp buffer)
6263 minibuffer-completion-table
6264 ;; If this is reading a file name, and the file name chosen
6265 ;; is a directory, don't exit the minibuffer.
6266 (let* ((result (buffer-substring (field-beginning) (point)))
6267 (bounds
6268 (completion-boundaries result minibuffer-completion-table
6269 minibuffer-completion-predicate
6270 "")))
6271 (if (eq (car bounds) (length result))
6272 ;; The completion chosen leads to a new set of completions
6273 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6274 (let ((mini (active-minibuffer-window)))
6275 (select-window mini)
6276 (when minibuffer-auto-raise
6277 (raise-frame (window-frame mini))))
6278 (exit-minibuffer))))))))
6280 (define-derived-mode completion-list-mode nil "Completion List"
6281 "Major mode for buffers showing lists of possible completions.
6283 to select the completion near point.
6285 with the mouse.
6288 (set (make-local-variable 'completion-base-size) nil))
6290 (defun completion-list-mode-finish ()
6291 "Finish setup of the completions buffer.
6292 Called from `temp-buffer-show-hook'."
6293 (when (eq major-mode 'completion-list-mode)
6294 (toggle-read-only 1)))
6296 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6299 ;; Variables and faces used in `completion-setup-function'.
6301 (defcustom completion-show-help t
6302 "Non-nil means show help message in *Completions* buffer."
6303 :type 'boolean
6304 :version "22.1"
6305 :group 'completion)
6307 ;; This function goes in completion-setup-hook, so that it is called
6308 ;; after the text of the completion list buffer is written.
6309 (defun completion-setup-function ()
6310 (let* ((mainbuf (current-buffer))
6311 (base-dir
6312 ;; When reading a file name in the minibuffer,
6313 ;; try and find the right default-directory to set in the
6314 ;; completion list buffer.
6315 ;; FIXME: Why do we do that, actually? --Stef
6316 (if minibuffer-completing-file-name
6317 (file-name-as-directory
6318 (expand-file-name
6319 (substring (minibuffer-completion-contents)
6320 0 (or completion-base-size 0)))))))
6321 (with-current-buffer standard-output
6322 (let ((base-size completion-base-size) ;Read before killing localvars.
6323 (base-position completion-base-position)
6324 (insert-fun completion-list-insert-choice-function))
6325 (completion-list-mode)
6326 (set (make-local-variable 'completion-base-size) base-size)
6327 (set (make-local-variable 'completion-base-position) base-position)
6328 (set (make-local-variable 'completion-list-insert-choice-function)
6329 insert-fun))
6330 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6331 (if base-dir (setq default-directory base-dir))
6332 ;; Maybe insert help string.
6333 (when completion-show-help
6334 (goto-char (point-min))
6335 (if (display-mouse-p)
6336 (insert (substitute-command-keys
6338 (insert (substitute-command-keys
6342 (add-hook 'completion-setup-hook 'completion-setup-function)
6344 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6345 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6347 (defun switch-to-completions ()
6348 "Select the completion list window."
6349 (interactive)
6350 (let ((window (or (get-buffer-window "*Completions*" 0)
6351 ;; Make sure we have a completions window.
6352 (progn (minibuffer-completion-help)
6353 (get-buffer-window "*Completions*" 0)))))
6354 (when window
6355 (select-window window)
6356 ;; In the new buffer, go to the first completion.
6357 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6358 (when (bobp)
6359 (next-completion 1)))))
6360 \f
6361 ;;; Support keyboard commands to turn on various modifiers.
6363 ;; These functions -- which are not commands -- each add one modifier
6364 ;; to the following event.
6366 (defun event-apply-alt-modifier (_ignore-prompt)
6369 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6370 (defun event-apply-super-modifier (_ignore-prompt)
6373 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6374 (defun event-apply-hyper-modifier (_ignore-prompt)
6377 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6378 (defun event-apply-shift-modifier (_ignore-prompt)
6381 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6382 (defun event-apply-control-modifier (_ignore-prompt)
6385 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6386 (defun event-apply-meta-modifier (_ignore-prompt)
6389 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6391 (defun event-apply-modifier (event symbol lshiftby prefix)
6392 "Apply a modifier flag to event EVENT.
6393 SYMBOL is the name of this modifier, as a symbol.
6394 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6395 PREFIX is the string that represents this modifier in an event type symbol."
6396 (if (numberp event)
6397 (cond ((eq symbol 'control)
6398 (if (and (<= (downcase event) ?z)
6399 (>= (downcase event) ?a))
6400 (- (downcase event) ?a -1)
6401 (if (and (<= (downcase event) ?Z)
6402 (>= (downcase event) ?A))
6403 (- (downcase event) ?A -1)
6404 (logior (lsh 1 lshiftby) event))))
6405 ((eq symbol 'shift)
6406 (if (and (<= (downcase event) ?z)
6407 (>= (downcase event) ?a))
6408 (upcase event)
6409 (logior (lsh 1 lshiftby) event)))
6410 (t
6411 (logior (lsh 1 lshiftby) event)))
6412 (if (memq symbol (event-modifiers event))
6413 event
6414 (let ((event-type (if (symbolp event) event (car event))))
6415 (setq event-type (intern (concat prefix (symbol-name event-type))))
6416 (if (symbolp event)
6417 event-type
6418 (cons event-type (cdr event)))))))
6420 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6421 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6422 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6423 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6424 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6425 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6426 \f
6427 ;;;; Keypad support.
6429 ;; Make the keypad keys act like ordinary typing keys. If people add
6430 ;; bindings for the function key symbols, then those bindings will
6431 ;; override these, so this shouldn't interfere with any existing
6432 ;; bindings.
6434 ;; Also tell read-char how to handle these keys.
6435 (mapc
6436 (lambda (keypad-normal)
6437 (let ((keypad (nth 0 keypad-normal))
6438 (normal (nth 1 keypad-normal)))
6439 (put keypad 'ascii-character normal)
6440 (define-key function-key-map (vector keypad) (vector normal))))
6441 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6442 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6443 (kp-space ?\s)
6446 (kp-multiply ?*)
6447 (kp-add ?+)
6448 (kp-separator ?,)
6449 (kp-subtract ?-)
6450 (kp-decimal ?.)
6451 (kp-divide ?/)
6452 (kp-equal ?=)
6453 ;; Do the same for various keys that are represented as symbols under
6454 ;; GUIs but naturally correspond to characters.
6455 (backspace 127)
6456 (delete 127)
6459 (clear ?\C-l)
6460 (return ?\C-m)
6461 (escape ?\e)
6462 ))
6463 \f
6464 ;;;;
6465 ;;;; forking a twin copy of a buffer.
6466 ;;;;
6468 (defvar clone-buffer-hook nil
6469 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6471 (defvar clone-indirect-buffer-hook nil
6472 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6474 (defun clone-process (process &optional newname)
6475 "Create a twin copy of PROCESS.
6476 If NEWNAME is nil, it defaults to PROCESS' name;
6477 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6478 If PROCESS is associated with a buffer, the new process will be associated
6479 with the current buffer instead.
6480 Returns nil if PROCESS has already terminated."
6481 (setq newname (or newname (process-name process)))
6483 (setq newname (substring newname 0 (match-beginning 0))))
6484 (when (memq (process-status process) '(run stop open))
6485 (let* ((process-connection-type (process-tty-name process))
6486 (new-process
6487 (if (memq (process-status process) '(open))
6488 (let ((args (process-contact process t)))
6489 (setq args (plist-put args :name newname))
6490 (setq args (plist-put args :buffer
6491 (if (process-buffer process)
6492 (current-buffer))))
6493 (apply 'make-network-process args))
6494 (apply 'start-process newname
6495 (if (process-buffer process) (current-buffer))
6496 (process-command process)))))
6497 (set-process-query-on-exit-flag
6498 new-process (process-query-on-exit-flag process))
6499 (set-process-inherit-coding-system-flag
6500 new-process (process-inherit-coding-system-flag process))
6501 (set-process-filter new-process (process-filter process))
6502 (set-process-sentinel new-process (process-sentinel process))
6503 (set-process-plist new-process (copy-sequence (process-plist process)))
6504 new-process)))
6506 ;; things to maybe add (currently partly covered by `funcall mode'):
6507 ;; - syntax-table
6508 ;; - overlays
6509 (defun clone-buffer (&optional newname display-flag)
6510 "Create and return a twin copy of the current buffer.
6511 Unlike an indirect buffer, the new buffer can be edited
6512 independently of the old one (if it is not read-only).
6513 NEWNAME is the name of the new buffer. It may be modified by
6514 adding or incrementing <N> at the end as necessary to create a
6515 unique buffer name. If nil, it defaults to the name of the
6516 current buffer, with the proper suffix. If DISPLAY-FLAG is
6517 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6518 clone a file-visiting buffer, or a buffer whose major mode symbol
6519 has a non-nil `no-clone' property, results in an error.
6521 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6522 current buffer with appropriate suffix. However, if a prefix
6523 argument is given, then the command prompts for NEWNAME in the
6524 minibuffer.
6526 This runs the normal hook `clone-buffer-hook' in the new buffer
6527 after it has been set up properly in other respects."
6528 (interactive
6529 (progn
6530 (if buffer-file-name
6531 (error "Cannot clone a file-visiting buffer"))
6532 (if (get major-mode 'no-clone)
6533 (error "Cannot clone a buffer in %s mode" mode-name))
6534 (list (if current-prefix-arg
6535 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6536 t)))
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 (setq newname (or newname (buffer-name)))
6543 (setq newname (substring newname 0 (match-beginning 0))))
6544 (let ((buf (current-buffer))
6545 (ptmin (point-min))
6546 (ptmax (point-max))
6547 (pt (point))
6548 (mk (if mark-active (mark t)))
6549 (modified (buffer-modified-p))
6550 (mode major-mode)
6551 (lvars (buffer-local-variables))
6552 (process (get-buffer-process (current-buffer)))
6553 (new (generate-new-buffer (or newname (buffer-name)))))
6554 (save-restriction
6555 (widen)
6556 (with-current-buffer new
6557 (insert-buffer-substring buf)))
6558 (with-current-buffer new
6559 (narrow-to-region ptmin ptmax)
6560 (goto-char pt)
6561 (if mk (set-mark mk))
6562 (set-buffer-modified-p modified)
6564 ;; Clone the old buffer's process, if any.
6565 (when process (clone-process process))
6567 ;; Now set up the major mode.
6568 (funcall mode)
6570 ;; Set up other local variables.
6571 (mapc (lambda (v)
6572 (condition-case () ;in case var is read-only
6573 (if (symbolp v)
6574 (makunbound v)
6575 (set (make-local-variable (car v)) (cdr v)))
6576 (error nil)))
6577 lvars)
6579 ;; Run any hooks (typically set up by the major mode
6580 ;; for cloning to work properly).
6581 (run-hooks 'clone-buffer-hook))
6582 (if display-flag
6583 ;; Presumably the current buffer is shown in the selected frame, so
6584 ;; we want to display the clone elsewhere.
6585 (let ((same-window-regexps nil)
6586 (same-window-buffer-names))
6587 (pop-to-buffer new)))
6588 new))
6591 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6592 "Create an indirect buffer that is a twin copy of the current buffer.
6594 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6595 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6596 or if not called with a prefix arg, NEWNAME defaults to the current
6597 buffer's name. The name is modified by adding a `<N>' suffix to it
6598 or by incrementing the N in an existing suffix. Trying to clone a
6599 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6600 property results in an error.
6602 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6603 This is always done when called interactively.
6605 Optional third arg NORECORD non-nil means do not put this buffer at the
6606 front of the list of recently selected ones."
6607 (interactive
6608 (progn
6609 (if (get major-mode 'no-clone-indirect)
6610 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6611 (list (if current-prefix-arg
6612 (read-buffer "Name of indirect buffer: " (current-buffer)))
6613 t)))
6614 (if (get major-mode 'no-clone-indirect)
6615 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6616 (setq newname (or newname (buffer-name)))
6618 (setq newname (substring newname 0 (match-beginning 0))))
6619 (let* ((name (generate-new-buffer-name newname))
6620 (buffer (make-indirect-buffer (current-buffer) name t)))
6621 (with-current-buffer buffer
6622 (run-hooks 'clone-indirect-buffer-hook))
6623 (when display-flag
6624 (pop-to-buffer buffer norecord))
6625 buffer))
6628 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6629 "Like `clone-indirect-buffer' but display in another window."
6630 (interactive
6631 (progn
6632 (if (get major-mode 'no-clone-indirect)
6633 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6634 (list (if current-prefix-arg
6635 (read-buffer "Name of indirect buffer: " (current-buffer)))
6636 t)))
6637 (let ((pop-up-windows t))
6638 (clone-indirect-buffer newname display-flag norecord)))
6640 \f
6641 ;;; Handling of Backspace and Delete keys.
6643 (defcustom normal-erase-is-backspace 'maybe
6644 "Set the default behavior of the Delete and Backspace keys.
6646 If set to t, Delete key deletes forward and Backspace key deletes
6647 backward.
6649 If set to nil, both Delete and Backspace keys delete backward.
6651 If set to 'maybe (which is the default), Emacs automatically
6652 selects a behavior. On window systems, the behavior depends on
6653 the keyboard used. If the keyboard has both a Backspace key and
6654 a Delete key, and both are mapped to their usual meanings, the
6655 option's default value is set to t, so that Backspace can be used
6656 to delete backward, and Delete can be used to delete forward.
6658 If not running under a window system, customizing this option
6659 accomplishes a similar effect by mapping C-h, which is usually
6660 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6661 via `keyboard-translate'. The former functionality of C-h is
6662 available on the F1 key. You should probably not use this
6663 setting if you don't have both Backspace, Delete and F1 keys.
6665 Setting this variable with setq doesn't take effect. Programmatically,
6666 call `normal-erase-is-backspace-mode' (which see) instead."
6667 :type '(choice (const :tag "Off" nil)
6668 (const :tag "Maybe" maybe)
6669 (other :tag "On" t))
6670 :group 'editing-basics
6671 :version "21.1"
6672 :set (lambda (symbol value)
6673 ;; The fboundp is because of a problem with :set when
6674 ;; dumping Emacs. It doesn't really matter.
6675 (if (fboundp 'normal-erase-is-backspace-mode)
6676 (normal-erase-is-backspace-mode (or value 0))
6677 (set-default symbol value))))
6679 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6680 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6681 (unless frame (setq frame (selected-frame)))
6682 (with-selected-frame frame
6683 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6684 (normal-erase-is-backspace-mode
6685 (if (if (eq normal-erase-is-backspace 'maybe)
6686 (and (not noninteractive)
6687 (or (memq system-type '(ms-dos windows-nt))
6688 (memq window-system '(ns))
6689 (and (memq window-system '(x))
6690 (fboundp 'x-backspace-delete-keys-p)
6691 (x-backspace-delete-keys-p))
6692 ;; If the terminal Emacs is running on has erase char
6693 ;; set to ^H, use the Backspace key for deleting
6694 ;; backward, and the Delete key for deleting forward.
6695 (and (null window-system)
6696 (eq tty-erase-char ?\^H))))
6697 normal-erase-is-backspace)
6698 1 0)))))
6700 (define-minor-mode normal-erase-is-backspace-mode
6701 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6702 With a prefix argument ARG, enable this feature if ARG is
6703 positive, and disable it otherwise. If called from Lisp, enable
6704 the mode if ARG is omitted or nil.
6706 On window systems, when this mode is on, Delete is mapped to C-d
6707 and Backspace is mapped to DEL; when this mode is off, both
6708 Delete and Backspace are mapped to DEL. (The remapping goes via
6709 `local-function-key-map', so binding Delete or Backspace in the
6710 global or local keymap will override that.)
6712 In addition, on window systems, the bindings of C-Delete, M-Delete,
6713 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6714 the global keymap in accordance with the functionality of Delete and
6715 Backspace. For example, if Delete is remapped to C-d, which deletes
6716 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6717 to DEL, which deletes backward, C-Delete is bound to
6718 `backward-kill-word'.
6720 If not running on a window system, a similar effect is accomplished by
6721 remapping C-h (normally produced by the Backspace key) and DEL via
6722 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6723 to C-d; if it's off, the keys are not remapped.
6725 When not running on a window system, and this mode is turned on, the
6726 former functionality of C-h is available on the F1 key. You should
6727 probably not turn on this mode on a text-only terminal if you don't
6728 have both Backspace, Delete and F1 keys.
6730 See also `normal-erase-is-backspace'."
6731 :variable (eq (terminal-parameter
6732 nil 'normal-erase-is-backspace) 1)
6733 (let ((enabled (eq 1 (terminal-parameter
6734 nil 'normal-erase-is-backspace))))
6736 (cond ((or (memq window-system '(x w32 ns pc))
6737 (memq system-type '(ms-dos windows-nt)))
6738 (let ((bindings
6739 `(([M-delete] [M-backspace])
6740 ([C-M-delete] [C-M-backspace])
6741 ([?\e C-delete] [?\e C-backspace]))))
6743 (if enabled
6744 (progn
6745 (define-key local-function-key-map [delete] [deletechar])
6746 (define-key local-function-key-map [kp-delete] [?\C-d])
6747 (define-key local-function-key-map [backspace] [?\C-?])
6748 (dolist (b bindings)
6749 ;; Not sure if input-decode-map is really right, but
6750 ;; keyboard-translate-table (used below) only works
6751 ;; for integer events, and key-translation-table is
6752 ;; global (like the global-map, used earlier).
6753 (define-key input-decode-map (car b) nil)
6754 (define-key input-decode-map (cadr b) nil)))
6755 (define-key local-function-key-map [delete] [?\C-?])
6756 (define-key local-function-key-map [kp-delete] [?\C-?])
6757 (define-key local-function-key-map [backspace] [?\C-?])
6758 (dolist (b bindings)
6759 (define-key input-decode-map (car b) (cadr b))
6760 (define-key input-decode-map (cadr b) (car b))))))
6761 (t
6762 (if enabled
6763 (progn
6764 (keyboard-translate ?\C-h ?\C-?)
6765 (keyboard-translate ?\C-? ?\C-d))
6766 (keyboard-translate ?\C-h ?\C-h)
6767 (keyboard-translate ?\C-? ?\C-?))))
6769 (if (called-interactively-p 'interactive)
6770 (message "Delete key deletes %s"
6771 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6772 "forward" "backward")))))
6773 \f
6774 (defvar vis-mode-saved-buffer-invisibility-spec nil
6775 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6777 (define-minor-mode visible-mode
6778 "Toggle making all invisible text temporarily visible (Visible mode).
6779 With a prefix argument ARG, enable Visible mode if ARG is
6780 positive, and disable it otherwise. If called from Lisp, enable
6781 the mode if ARG is omitted or nil.
6783 This mode works by saving the value of `buffer-invisibility-spec'
6784 and setting it to nil."
6785 :lighter " Vis"
6786 :group 'editing-basics
6787 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6788 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6789 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6790 (when visible-mode
6791 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6792 buffer-invisibility-spec)
6793 (setq buffer-invisibility-spec nil)))
6794 \f
6795 ;; Minibuffer prompt stuff.
6797 ;;(defun minibuffer-prompt-modification (start end)
6798 ;; (error "You cannot modify the prompt"))
6799 ;;
6800 ;;
6801 ;;(defun minibuffer-prompt-insertion (start end)
6802 ;; (let ((inhibit-modification-hooks t))
6803 ;; (delete-region start end)
6804 ;; ;; Discard undo information for the text insertion itself
6805 ;; ;; and for the text deletion.above.
6806 ;; (when (consp buffer-undo-list)
6807 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6808 ;; (message "You cannot modify the prompt")))
6809 ;;
6810 ;;
6811 ;;(setq minibuffer-prompt-properties
6812 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6813 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6815 \f
6816 ;;;; Problematic external packages.
6818 ;; rms says this should be done by specifying symbols that define
6819 ;; versions together with bad values. This is therefore not as
6820 ;; flexible as it could be. See the thread:
6821 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6822 (defconst bad-packages-alist
6823 ;; Not sure exactly which semantic versions have problems.
6824 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6826 "The version of `semantic' loaded does not work in Emacs 22.
6827 It can cause constant high CPU load.
6828 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6829 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6830 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6831 ;; provided the `CUA-mode' feature. Since this is no longer true,
6832 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6833 (CUA-mode t nil
6834 "CUA-mode is now part of the standard GNU Emacs distribution,
6835 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6837 You have loaded an older version of CUA-mode which does not work
6838 correctly with this version of Emacs. You should remove the old
6839 version and use the one distributed with Emacs."))
6840 "Alist of packages known to cause problems in this version of Emacs.
6841 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6842 PACKAGE is either a regular expression to match file names, or a
6843 symbol (a feature name); see the documentation of
6844 `after-load-alist', to which this variable adds functions.
6845 SYMBOL is either the name of a string variable, or `t'. Upon
6846 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6847 warning using STRING as the message.")
6849 (defun bad-package-check (package)
6850 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6851 (condition-case nil
6852 (let* ((list (assoc package bad-packages-alist))
6853 (symbol (nth 1 list)))
6854 (and list
6855 (boundp symbol)
6856 (or (eq symbol t)
6857 (and (stringp (setq symbol (eval symbol)))
6858 (string-match-p (nth 2 list) symbol)))
6859 (display-warning package (nth 3 list) :warning)))
6860 (error nil)))
6862 (mapc (lambda (elem)
6863 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6864 bad-packages-alist)
6867 (provide 'simple)
6869 ;;; simple.el ends here