| blob | ca50282df15de8c48d1591f5bc79e7e0b1ae152d |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1993-2011 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 When turned on, cursor motion in the compilation, grep, occur or diff
325 buffer causes automatic display of the corresponding source code
326 location."
333 ;; Used as a `post-command-hook' by `next-error-follow-mode'
334 ;; for the *Compilation* *grep* and *Occur* buffers.
344 \f
345 ;;;
348 "Major mode not specialized for anything in particular.
349 Other major modes are defined by comparison with this one."
355 ;; Special major modes to view specially formatted data rather than files.
369 map))
373 "Parent major mode from which special major modes should inherit."
376 ;; Major mode meant to be the parent of programming modes.
381 map)
385 "Indent the expression after point."
392 "Major mode for editing programming language source code."
395 ;; Any programming language is always written left to right.
398 ;; Making and deleting lines.
404 "Insert a newline, and move to left margin of the new line if it's blank.
405 If `use-hard-newlines' is non-nil, the newline is marked with the
406 text-property `hard'.
407 With ARG, insert that many newlines.
408 Call `auto-fill-function' if the current column number is greater
409 than the value of `fill-column' and ARG is nil."
412 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
413 ;; Set last-command-event to tell self-insert what to insert.
417 ;; Don't auto-fill if we have a numeric argument.
420 ;; Do the rest in post-self-insert-hook, because we want to do it
421 ;; *before* other functions on that hook.
423 ;; Mark the newline(s) `hard'.
427 ;; If the newline leaves the previous line blank, and we
428 ;; have a left margin, delete that from the blank line.
436 ;; Indent the line after the newline, except in one case:
437 ;; when we added the newline at the beginning of a line which
438 ;; starts a page.
445 ;; We first used let-binding to protect the hook, but that was naive
446 ;; since add-hook affects the symbol-default value of the variable,
447 ;; whereas the let-binding might only protect the buffer-local value.
449 nil)
454 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
460 "Insert a newline and leave point before it.
461 If there is a fill prefix and/or a `left-margin', insert them
462 on the new line if the line would have been blank.
463 With arg N, insert N newlines."
468 ;; Don't expand an abbrev before point.
482 "Split current line, moving portion beyond point vertically down.
483 If the current line starts with `fill-prefix', insert it on the new
484 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
486 When called from Lisp code, ARG may be a prefix string to copy."
491 ;; What prefix should we check for (nil means don't).
495 ;; Does this line start with it?
506 "Join this line to previous and fix up whitespace at join.
507 If there is a fill prefix, delete it from the beginning of this line.
508 With argument, join this line to following line."
515 ;; If the second line started with the fill prefix,
516 ;; delete the prefix.
528 "On blank line, delete all surrounding blank lines, leaving just one.
529 On isolated blank line, delete that one.
530 On nonblank line, delete any immediately following blank lines."
536 ;; Set singleblank if there is just one blank line here.
543 ;; Delete preceding blank lines, and this one too if it's the only one.
552 ;; Delete following blank lines, unless the current line is blank
553 ;; and there are no following blank lines.
562 ;; Handle the special case where point is followed by newline and eob.
563 ;; Delete the line, leaving point at eob.
568 "Delete all the trailing whitespace across the current buffer.
569 All whitespace after the last non-whitespace character in a line is deleted.
571 A formfeed is not considered whitespace by this function.
572 If END is nil, also delete all trailing lines at the end of the buffer.
573 If the region is active, only delete whitespace within the region."
586 ;; Don't delete formfeeds, even if they are considered whitespace.
590 ;; Delete trailing empty lines.
593 ;; Really the end of buffer.
598 ;; Return nil for the benefit of `write-file-functions'.
599 nil)
602 "Insert a newline, then indent according to major mode.
603 Indentation is done using the value of `indent-line-function'.
604 In programming language modes, this is the same as TAB.
605 In some text modes, where TAB inserts a tab, this command indents to the
606 column specified by the function `current-left-margin'."
613 "Reindent current line, insert newline, then indent the new line.
614 Indentation of both lines is done according to the current major mode,
615 which means calling the current value of `indent-line-function'.
616 In programming language modes, this is the same as TAB.
617 In some text modes, where TAB inserts a tab, this indents to the
618 column specified by the function `current-left-margin'."
621 ;; Be careful to insert the newline before indenting the line.
622 ;; Otherwise, the indentation might be wrong.
626 ;; We are at EOL before the call to indent-according-to-mode, and
627 ;; after it we usually are as well, but not always. We tried to
628 ;; address it with `save-excursion' but that uses a normal marker
629 ;; whereas we need `move after insertion', so we do the save/restore
630 ;; by hand.
634 ;; Remove the trailing white-space after indentation because
635 ;; indentation may introduce the whitespace.
640 "Read next input character and insert it.
641 This is useful for inserting control characters.
642 With argument, insert ARG copies of the character.
644 If the first character you type after this command is an octal digit,
645 you should type a sequence of octal digits which specify a character code.
646 Any nondigit terminates the sequence. If the terminator is a RET,
647 it is discarded; any other terminator is used itself as input.
648 The variable `read-quoted-char-radix' specifies the radix for this feature;
649 set it to 10 or 16 to use decimal or hex instead of octal.
651 In overwrite mode, this function inserts the character anyway, and
652 does not handle octal digits specially. This means that if you use
653 overwrite as your normal editing mode, you can use this function to
654 insert characters when necessary.
656 In binary overwrite mode, this function does overwrite, and octal
657 digits are interpreted as a character code. This is intended to be
658 useful for editing binary files."
661 ;; Avoid "obsolete" warnings for translation-table-for-input.
668 ;; This used to assume character codes 0240 - 0377 stand for
669 ;; characters in some single-byte character set, and converted them
670 ;; to Emacs characters. But in 23.1 this feature is deprecated
671 ;; in favor of inserting the corresponding Unicode characters.
672 ;; (if (and enable-multibyte-characters
673 ;; (>= char ?\240)
674 ;; (<= char ?\377))
675 ;; (setq char (unibyte-char-to-multibyte char)))
684 "Move forward ARG lines and position at first nonblank character."
690 "Move backward ARG lines and position at first nonblank character."
696 "Move point to the first non-whitespace character on this line."
700 ;; Move back over chars that have whitespace syntax but have the p flag.
704 "Fixup white space between objects around point.
705 Leave one space or none, according to the context."
712 nil
716 "Delete all spaces and tabs around point.
717 If BACKWARD-ONLY is non-nil, only delete them before point."
722 orig-pos
731 "Delete all spaces and tabs around point, leaving one space (or N spaces).
732 If N is negative, delete newlines as well."
749 \f
751 "Move point to the beginning of the buffer.
752 With numeric arg N, put point N/10 of the way from the beginning.
753 If the buffer is narrowed, this command uses the beginning of the
754 accessible part of the buffer.
756 If Transient Mark mode is disabled, leave mark at previous
759 Don't use this command in Lisp programs!
760 \(goto-char (point-min)) is faster."
769 ;; Avoid overflow for large buffer sizes!
777 "Move point to the end of the buffer.
778 With numeric arg N, put point N/10 of the way from the end.
779 If the buffer is narrowed, this command uses the end of the
780 accessible part of the buffer.
782 If Transient Mark mode is disabled, leave mark at previous
785 Don't use this command in Lisp programs!
786 \(goto-char (point-max)) is faster."
793 ;; Avoid overflow for large buffer sizes!
798 ;; If we went to a place in the middle of the buffer,
799 ;; adjust it to the beginning of a line.
802 ;; If the end of the buffer is not already on the screen,
803 ;; then scroll specially to put it near, but not at, the bottom.
808 "Whether single-char deletion commands delete an active region.
809 This has an effect only if Transient Mark mode is enabled, and
810 affects `delete-forward-char' and `delete-backward-char', though
811 not `delete-char'.
813 If the value is the symbol `kill', the active region is killed
814 instead of deleted."
822 "Delete the previous N characters (following if N is negative).
823 If Transient Mark mode is enabled, the mark is active, and N is 1,
824 delete the text in the region and deactivate the mark instead.
825 To disable this, set `delete-active-region' to nil.
827 Optional second arg KILLFLAG, if non-nil, means to kill (save in
828 kill ring) instead of delete. Interactively, N is the prefix
829 arg, and KILLFLAG is set if N is explicitly specified.
831 In Overwrite mode, single character backward deletion may replace
832 tabs with spaces so as to back over columns, unless point is at
833 the end of the line."
838 delete-active-region
840 ;; If a region is active, kill or delete it.
844 ;; In Overwrite mode, maybe untabify while deleting
854 ;; Otherwise, do simple deletion.
858 "Delete the following N characters (previous if N is negative).
859 If Transient Mark mode is enabled, the mark is active, and N is 1,
860 delete the text in the region and deactivate the mark instead.
861 To disable this, set `delete-active-region' to nil.
863 Optional second arg KILLFLAG non-nil means to kill (save in kill
864 ring) instead of delete. Interactively, N is the prefix arg, and
865 KILLFLAG is set if N was explicitly specified."
870 delete-active-region
872 ;; If a region is active, kill or delete it.
876 ;; Otherwise, do simple deletion.
880 "Put point at beginning and mark at end of buffer.
881 If narrowing is in effect, only uses the accessible part of the buffer.
882 You probably should not use this function in Lisp programs;
883 it is usually a mistake for a Lisp function to use any subroutine
884 that uses or sets the mark."
889 \f
891 ;; Counting lines, one way or another.
894 "Goto LINE, counting from line 1 at beginning of buffer.
895 Normally, move point in the current buffer, and leave mark at the
897 move point in the most recently selected other buffer, and switch to it.
899 If there's a number in the buffer at point, it is the default for LINE.
901 This function is usually the wrong thing to use in a Lisp program.
902 What you probably want instead is something like:
903 (goto-char (point-min)) (forward-line (1- N))
904 If at all possible, an even better solution is to use char counts
905 rather than line counts."
909 ;; Look for a default, a number in the buffer at point.
919 ;; Decide if we're switching buffers.
927 ;; Read the argument, offering that number (if any) as default.
930 buffer-prompt
931 default)
932 default)
933 buffer))))
934 ;; Switch to the desired buffer, one way or another.
939 ;; Leave mark at previous position
941 ;; Move to the specified line number in that buffer.
950 "Return the number of words between START and END.
951 If called interactively, print a message reporting the number of
952 lines, words, and characters in the region."
964 words
966 words))
969 "Display the number of lines, words, and characters in the buffer.
970 In Transient Mark mode when the mark is active, display the
971 number of lines, words, and characters in the region."
984 str
992 "Print the current buffer line number and narrowed line number of point."
1005 "Return number of lines between START and END.
1006 This is usually the number of newlines between them,
1007 but can be one more if START is not equal to END
1008 and the greater of them is not at the start of a line."
1024 done)))
1028 "Return (narrowed) buffer line number at position POS.
1029 If POS is nil, use current buffer location.
1030 Counting starts at (point-min), so the value refers
1031 to the contents of the accessible portion of the buffer."
1041 "Print info on cursor position (on screen and within buffer).
1042 Also describe the character after point, and give its character code
1043 in octal, decimal and hex.
1045 For a non-ASCII multibyte character, also give its encoding in the
1046 buffer's selected coding system if the coding system encodes the
1047 character safely. If the character is encoded into one byte, that
1048 code is shown in hex. If the character is encoded into more than one
1051 In addition, with prefix argument, show details about that character
1052 in *Help* buffer. See also the command `describe-char'."
1055 ;; If the character is one of LRE, LRO, RLE, RLO, it will
1056 ;; start a directional embedding, which could completely
1057 ;; disrupt the rest of the line (e.g., RLO will display the
1058 ;; rest of the line right-to-left). So we put an invisible
1059 ;; PDF character after these characters, to end the
1060 ;; embedding, which eliminates any effects on the rest of the
1061 ;; line.
1070 ;; Avoid overflow from multiplying by 100!
1074 ""
1080 pos total percent beg end col hscroll)
1082 pos total col hscroll))
1084 encoded encoding-msg display-prop under-display)
1091 ;; Check if the character is displayed with some `display'
1092 ;; text property. In that case, set under-display to the
1093 ;; buffer substring covered by that property.
1104 under-display)))
1110 char char char under-display)
1112 char char char under-display display-prop))
1115 char char char
1117 "..."
1121 ;; We show the detailed information about CHAR.
1128 pdf encoding-msg pos total percent beg end col hscroll)
1135 pdf encoding-msg pos total percent col hscroll))))))
1136 \f
1137 ;; Initialize read-expression-map. It is defined at C level.
1140 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1141 ;; too rarely useful.
1151 "The current default value or list of default values in the minibuffer.
1152 The functions `read-from-minibuffer' and `completing-read' bind
1156 "Value for `print-level' while printing value in `eval-expression'.
1157 A value of nil means no limit."
1163 "Value for `print-length' while printing value in `eval-expression'.
1164 A value of nil means no limit."
1170 "If non-nil set `debug-on-error' to t in `eval-expression'.
1171 If nil, don't change the value of `debug-on-error'."
1177 "Format VALUE as a result of evaluated expression.
1178 Return a formatted string which is displayed in the echo area
1179 in addition to the value printed by prin1 in functions which
1180 display the result of expression evaluation."
1193 ;; We define this, rather than making `eval' interactive,
1194 ;; for the sake of completion of names like eval-region, eval-buffer.
1197 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1198 When called interactively, read an Emacs Lisp expression and
1199 evaluate it.
1200 Value is also consed on to front of the variable `values'.
1201 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1202 with prefix argument) means insert the result into the current buffer
1203 instead of printing it in the echo area. Truncates long output
1204 according to the value of the variables `eval-expression-print-length'
1205 and `eval-expression-print-level'.
1207 If `eval-expression-debug-on-error' is non-nil, which is the default,
1208 this command arranges for all errors to enter the debugger."
1212 nil read-expression-map t
1214 current-prefix-arg))
1219 ;; Bind debug-on-error to something unique so that we can
1220 ;; detect when evaled code changes it.
1224 ;; If evaled code has changed the value of debug-on-error,
1225 ;; propagate that change to the global binding.
1241 "Prompting with PROMPT, let user edit COMMAND and eval result.
1242 COMMAND is a Lisp expression. Let user edit that expression in
1243 the minibuffer, then read and evaluate the result."
1250 read-expression-map t
1252 ;; If command was added to command-history as a string,
1253 ;; get rid of that. We want only evaluable expressions there.
1257 ;; If command to be redone does not match front of history,
1258 ;; add it to the history.
1264 "Edit and re-evaluate last complex command, or ARGth from last.
1265 A complex command is one which used the minibuffer.
1266 The command is placed in the minibuffer as a Lisp form for editing.
1267 The result is executed, repeating the command as changed.
1268 If the command has been changed or is not the most recent previous
1269 command it is added to the front of the command history.
1270 You can use the minibuffer history commands \
1272 to get different commands to edit and resubmit."
1275 newcmd)
1287 ;; If command was added to command-history as a
1288 ;; string, get rid of that. We want only
1289 ;; evaluable expressions there.
1293 ;; If command to be redone does not match front of history,
1294 ;; add it to the history.
1303 "Read command name to invoke in `execute-extended-command'."
1308 ;; Get a command name at point in the original buffer
1309 ;; to propose it after M-n.
1313 ;; Read a string, completing from and restricting to the set of
1314 ;; all defined commands. Don't provide any initial input.
1315 ;; Save the command read on the extended-command history list.
1326 ;; This isn't strictly correct if `execute-extended-command'
1327 ;; is bound to anything else (e.g. [menu]).
1328 ;; It could use (key-description (this-single-command-keys)),
1329 ;; but actually a prompt other than "M-x" would be confusing,
1330 ;; because "M-x" is a well-known prompt to read a command
1331 ;; and it serves as a shorthand for "Extended command: ".
1335 \f
1337 "Default minibuffer history list.
1338 This is used for all minibuffer input
1339 except when an alternate history list is specified.
1341 Maximum length of the history list is determined by the value
1344 "Control whether history list elements are expressions or strings.
1345 If the value of this variable equals current minibuffer depth,
1346 they are expressions; otherwise they are strings.
1347 \(That convention is designed to do the right thing for
1354 "Text that was in this minibuffer before any history commands.
1355 This is nil if there have not yet been any history commands
1364 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1368 "Minibuffer history variables for which matching should ignore case.
1369 If a history variable is a member of this list, then the
1371 commands ignore case when searching it, regardless of `case-fold-search'."
1376 "Find the previous history element that matches REGEXP.
1377 \(Previous history elements refer to earlier actions.)
1378 With prefix argument N, search for Nth previous match.
1379 If N is negative, find the next or Nth next match.
1380 Normally, history elements are matched case-insensitively if
1381 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1382 makes the search case-sensitive.
1383 See also `minibuffer-history-case-insensitive-variables'."
1387 nil
1388 minibuffer-local-map
1389 nil
1390 'minibuffer-history-search-history
1392 ;; Use the last regexp specified, by default, if input is empty.
1397 regexp)
1407 ;; On some systems, ignore case for file names.
1409 minibuffer-history-case-insensitive-variables)
1410 t
1411 ;; Respect the user's setting for case-fold-search:
1412 case-fold-search)
1413 nil))
1414 prevpos
1415 match-string
1416 match-offset
1423 "No later matching history item"
1444 next-matching-history-element))
1448 "Find the next history element that matches REGEXP.
1449 \(The next history element refers to a more recent action.)
1450 With prefix argument N, search for Nth next match.
1451 If N is negative, find the previous or Nth previous match.
1452 Normally, history elements are matched case-insensitively if
1453 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1454 makes the search case-sensitive."
1458 nil
1459 minibuffer-local-map
1460 nil
1461 'minibuffer-history-search-history
1463 ;; Use the last regexp specified, by default, if input is empty.
1468 regexp)
1475 "Function run by `goto-history-element' before consuming default values.
1476 This is useful to dynamically add more elements to the list of default values
1477 when `goto-history-element' reaches the end of this list.
1478 Before calling this function `goto-history-element' sets the variable
1479 `minibuffer-default-add-done' to t, so it will call this function only
1480 once. In special cases, when this function needs to be called more
1481 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1485 "When nil, add more elements to the end of the list of default values.
1486 The value nil causes `goto-history-element' to add more elements to
1487 the list of defaults when it reaches the end of this list. It does
1493 "Return a list of all completions without the default value.
1494 This function is used to add all elements of the completion table to
1495 the end of the list of defaults just after the default value."
1498 minibuffer-completion-table
1499 minibuffer-completion-predicate)))
1505 "Puts element of the minibuffer history in the minibuffer.
1506 The argument NABS specifies the absolute history position."
1520 elt minibuffer-returned-to-present)
1532 previous-history-element))
1544 minibuffer-default)))
1556 elt))
1560 "Puts next element of the minibuffer history in the minibuffer.
1561 With argument N, it uses the Nth following element."
1567 "Puts previous element of the minibuffer history in the minibuffer.
1568 With argument N, it uses the Nth previous element."
1574 "Get next history element which completes the minibuffer before the point.
1575 The contents of the minibuffer after the point are deleted, and replaced
1576 by the new completion."
1582 n)
1583 ;; next-matching-history-element always puts us at (point-min).
1584 ;; Move to the position we were at before changing the buffer contents.
1585 ;; This is still sensical, because the text before point has not changed.
1589 "\
1590 Get previous history element which completes the minibuffer before the point.
1591 The contents of the minibuffer after the point are deleted, and replaced
1592 by the new completion."
1596 ;; For compatibility with the old subr of the same name.
1598 "Return the display width of the minibuffer prompt.
1599 Return 0 if current buffer is not a minibuffer."
1600 ;; Return the width of everything before the field at the end of
1601 ;; the buffer; this should be 0 for normal buffers.
1603 \f
1604 ;; isearch minibuffer history
1611 "Set up a minibuffer for using isearch to search the minibuffer history.
1612 Intended to be added to `minibuffer-setup-hook'."
1624 "Clean up the minibuffer after terminating isearch in the minibuffer."
1629 "Return the proper search function, for isearch in minibuffer history."
1636 ;; Use standard functions to search within minibuffer text
1642 found)
1643 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1644 ;; searching forward. Lazy-highlight calls this lambda with the
1645 ;; bound arg, so skip the minibuffer prompt.
1649 ;; 1. First try searching in the initial minibuffer text
1652 noerror)
1653 ;; 2. If the above search fails, start putting next/prev history
1654 ;; elements in the minibuffer successively, and search the string
1655 ;; in them. Do this only when bound is nil (i.e. not while
1656 ;; lazy-highlighting search strings in the current minibuffer text).
1668 ;; After putting the next/prev history element, search
1669 ;; the string in them again, until next-history-element
1670 ;; or previous-history-element raises an error at the
1671 ;; beginning/end of history.
1674 ;; For backward search, don't search
1675 ;; in the minibuffer prompt
1677 noerror)))
1678 ;; Return point of the new search result
1680 ;; Return nil when next(prev)-history-element fails
1684 "Display the minibuffer history search prompt.
1685 If there are no search errors, this function displays an overlay with
1686 the isearch prompt which replaces the original minibuffer prompt.
1687 Otherwise, it displays the standard isearch message returned from
1688 `isearch-message'."
1690 ;; Use standard function `isearch-message' when not in the minibuffer,
1691 ;; or search fails, or has an error (like incomplete regexp).
1692 ;; This function overwrites minibuffer text with isearch message,
1693 ;; so it's possible to see what is wrong in the search string.
1695 ;; Otherwise, put the overlay with the standard isearch prompt over
1696 ;; the initial minibuffer prompt.
1705 ;; And clear any previous isearch message.
1709 "Wrap the minibuffer history search when search fails.
1710 Move point to the first history element for a forward search,
1711 or to the last history element for a backward search."
1713 ;; When `minibuffer-history-isearch-search' fails on reaching the
1714 ;; beginning/end of the history, wrap the search to the first/last
1715 ;; minibuffer history element.
1723 "Save a function restoring the state of minibuffer history search.
1724 Save `minibuffer-history-position' to the additional state parameter
1725 in the search status stack."
1730 "Restore the minibuffer history search state.
1731 Go to the history element by the absolute history position HIST-POS."
1734 \f
1735 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1739 "Table mapping redo records to the corresponding undo one.
1740 A redo record for undo-in-region maps to t.
1750 "Within a run of consecutive undo commands, list remaining to be undone.
1754 "Undo some previous changes.
1755 Repeat this command to undo more changes.
1756 A numeric ARG serves as a repeat count.
1758 In Transient Mark mode when the mark is active, only undo changes within
1760 as an argument limits undo to changes within the current region."
1762 ;; Make last-command indicate for the next command that this was an undo.
1763 ;; That way, another undo will undo more.
1764 ;; If we get to the end of the undo history and get an error,
1765 ;; another undo command will find the undo history empty
1766 ;; and will get another error. To begin undoing the undos,
1767 ;; you must type some other command.
1770 message)
1771 ;; If we get an error in undo-start,
1772 ;; the next command should not be a "consecutive undo".
1773 ;; So set `this-command' to something other than `undo'.
1778 ;; If something (a timer or filter?) changed the buffer
1779 ;; since the previous command, don't continue the undo seq.
1783 ;; If the last undo record made was made by undo
1784 ;; it shows nothing else happened in between.
1791 ;; get rid of initial undo boundary
1793 ;; If we got this far, the next command should be a consecutive undo.
1795 ;; Check to see whether we're hitting a redo record, and if
1796 ;; so, ask the user whether she wants to skip the redo/undo pair.
1803 ;; The equiv entry might point to another redo record if we have done
1804 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1812 ;; Record the fact that the just-generated undo records come from an
1813 ;; undo operation--that is, they are redo records.
1814 ;; In the ordinary case (not within a region), map the redo
1815 ;; record to the following undos.
1816 ;; I don't know how to do that in the undo-in-region case.
1818 ;; Strip any leading undo boundaries there might be, like we do
1819 ;; above when checking.
1823 undo-equiv-table))
1824 ;; Don't specify a position in the undo record for the undo command.
1825 ;; Instead, undoing this should move point to where the change is.
1844 ;; Record what the current undo list says,
1845 ;; so the next command can tell if the buffer was modified in between.
1848 ;; Display a message announcing success.
1853 "Make BUFFER stop keeping undo information.
1854 No argument or nil as argument means do this for the current buffer."
1860 "Undo some previous changes.
1861 Repeat this command to undo more changes.
1862 A numeric ARG serves as a repeat count.
1863 Contrary to `undo', this will not redo a previous undo."
1868 "Non-nil while performing an undo.
1872 "Undo back N undo-boundaries beyond what was already undone recently.
1873 Call `undo-start' to get ready to undo recent changes,
1874 then call `undo-more' one or more times to undo them."
1879 ;; Note: The following, while pulling elements off
1880 ;; `pending-undo-list' will call primitive change functions which
1881 ;; will push more elements onto `buffer-undo-list'.
1886 ;; Deep copy of a list
1888 "Make a copy of undo list LIST."
1894 elt))
1897 "Set `pending-undo-list' to the front of the undo list.
1898 The next call to `undo-more' will undo the most recently made change.
1899 If BEG and END are specified, then only undo elements
1900 that apply to text between BEG and END are used; other undo elements
1901 are ignored. If BEG and END are nil, all undo elements are used."
1907 buffer-undo-list)))
1912 "Return a list of undo elements for the region START to END.
1913 The elements come from `buffer-undo-list', but we keep only
1914 the elements inside this region, and discard those outside this region.
1915 If we find an element that crosses an edge of this region,
1916 we stop and ignore all further elements."
1919 undo-adjusted-markers
1920 some-rejected
1921 undo-elt temp-undo-list delta)
1926 ;; This is a "was unmodified" element.
1927 ;; Keep it if we have kept everything thus far.
1934 ;; Don't put two nils together in the list
1948 ;; Loop down the earlier events adjusting their buffer
1949 ;; positions to reflect the fact that a change to the buffer
1950 ;; isn't being undone. We only need to process those element
1951 ;; types which undo-elt-in-region will return as being in
1952 ;; the region since only those types can ever get into the
1953 ;; output
1962 ;; (TEXT . POSITION)
1969 ;; (BEGIN . END)
1974 ;; (nil PROPERTY VALUE BEG . END)
1984 "Determine whether UNDO-ELT falls inside the region START ... END.
1985 If it crosses the edge, we return nil."
1990 t)
1992 nil)
1994 ;; (TEXT . POSITION)
1998 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1999 ;; See if MARKER is inside the region.
2010 ;; (nil PROPERTY VALUE BEG . END)
2015 ;; (BEGIN . END)
2020 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2021 This assumes we have already decided that UNDO-ELT
2022 is not *inside* the region START...END."
2025 ;; (nil PROPERTY VALUE BEG . END)
2030 ;; (BEGIN . END)
2034 ;; Return the first affected buffer position and the delta for an undo element
2035 ;; delta is defined as the change in subsequent buffer positions if we *did*
2036 ;; the undo.
2040 ;; (TEXT . POSITION)
2043 ;; (BEGIN . END)
2050 "If non-nil ask about discarding undo info for the current command.
2051 Normally, Emacs discards the undo info for the current command if
2052 it exceeds `undo-outer-limit'. But if you set this option
2053 non-nil, it asks in the echo area whether to discard the info.
2054 If you answer no, there is a slight risk that Emacs might crash, so
2055 only do it if you really want to undo the command.
2057 This option is mainly intended for debugging. You have to be
2058 careful if you use it for other purposes. Garbage collection is
2059 inhibited while the question is asked, meaning that Emacs might
2060 leak memory. So you should make sure that you do not wait
2061 excessively long before answering the question."
2067 "If non-nil, an extra level of size that's ok in an undo item.
2068 We don't ask the user about truncating the undo list until the
2069 current item gets bigger than this amount.
2074 ;; When the first undo batch in an undo list is longer than
2075 ;; undo-outer-limit, this function gets called to warn the user that
2076 ;; the undo info for the current command was discarded. Garbage
2077 ;; collection is inhibited around the call, so it had better not do a
2078 ;; lot of consing.
2084 ;; Don't ask the question again unless it gets even bigger.
2085 ;; This applies, in particular, if the user quits from the question.
2086 ;; Such a quit quits out of GC, but something else will call GC
2087 ;; again momentarily. It will call this function again,
2088 ;; but we don't want to ask the question again.
2095 t)
2096 nil))
2101 "The undo info was discarded because it exceeded \
2102 `undo-outer-limit'.
2104 This is normal if you executed a command that made a huge change
2105 to the buffer. In that case, to prevent similar problems in the
2106 future, set `undo-outer-limit' to a value that is large enough to
2107 cover the maximum size of normal changes you expect a single
2108 command to make, but not so large that it might exceed the
2109 maximum memory allotted to Emacs.
2111 If you did not execute any such command, the situation is
2112 probably due to a bug and you should report it.
2114 You can disable the popping up of this buffer by adding the entry
2115 \(undo discard-info) to the user option `warning-suppress-types',
2119 t))
2120 \f
2122 "History list for some commands that read shell commands.
2124 Maximum length of the history list is determined by the value
2131 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2132 This buffer is used when `shell-command' or `shell-command-on-region'
2133 is run interactively. A value of nil means that output to stderr and
2140 "Return a list of all commands associated with the current file.
2141 This function is used to add all related commands retrieved by `mailcap'
2142 to the end of the list of defaults just after the default value."
2146 minibuffer-default))
2151 commands))
2162 map)
2166 "Read a shell command from the minibuffer.
2167 The arguments are the same as the ones of `read-from-minibuffer',
2168 except READ and KEYMAP are missing and HIST defaults
2169 to `shell-command-history'."
2177 minibuffer-local-shell-command-map
2178 nil
2180 args)))
2183 "Execute string COMMAND asynchronously in background.
2185 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2186 surrounded by whitespace and executes the command asynchronously.
2187 The output appears in the buffer `*Async Shell Command*'.
2189 In Elisp, you will often be better served by calling `start-process'
2190 directly, since it offers more control and does not impose the use of a
2191 shell (with its need to quote arguments)."
2197 current-prefix-arg
2198 shell-command-default-error-buffer))
2204 "Execute string COMMAND in inferior shell; display output, if any.
2205 With prefix argument, insert the COMMAND's output at point.
2207 If COMMAND ends in ampersand, execute it asynchronously.
2208 The output appears in the buffer `*Async Shell Command*'.
2209 That buffer is in shell mode.
2211 Otherwise, COMMAND is executed synchronously. The output appears in
2212 the buffer `*Shell Command Output*'. If the output is short enough to
2213 display in the echo area (which is determined by the variables
2214 `resize-mini-windows' and `max-mini-window-height'), it is shown
2215 there, but it is nonetheless available in buffer `*Shell Command
2216 Output*' even though that buffer is not automatically displayed.
2218 To specify a coding system for converting non-ASCII characters
2220 before this command.
2222 Noninteractive callers can specify coding systems by binding
2223 `coding-system-for-read' and `coding-system-for-write'.
2225 The optional second argument OUTPUT-BUFFER, if non-nil,
2226 says to put the output in some other buffer.
2227 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2228 If OUTPUT-BUFFER is not a buffer and not nil,
2229 insert output in current buffer. (This cannot be done asynchronously.)
2230 In either case, the buffer is first erased, and the output is
2231 inserted after point (leaving mark after it).
2233 If the command terminates without error, but generates output,
2235 the output can be displayed in the echo area or in its buffer.
2236 If the output is short enough to display in the echo area
2237 \(determined by the variable `max-mini-window-height' if
2238 `resize-mini-windows' is non-nil), it is shown there.
2239 Otherwise,the buffer containing the output is displayed.
2243 of the output.
2245 If there is no output, or if output is inserted in the current buffer,
2246 then `*Shell Command Output*' is deleted.
2248 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2249 or buffer name to which to direct the command's standard error output.
2250 If it is nil, error output is mingled with regular output.
2251 In an interactive call, the variable `shell-command-default-error-buffer'
2252 specifies the value of ERROR-BUFFER.
2254 In Elisp, you will often be better served by calling `call-process' or
2255 `start-process' directly, since it offers more control and does not impose
2256 the use of a shell (with its need to quote arguments)."
2267 current-prefix-arg
2268 shell-command-default-error-buffer))
2269 ;; Look for a handler in case default-directory is a remote file name.
2277 ;; Output goes in current buffer.
2283 temporary-file-directory)))
2284 nil)))
2287 ;; We do not use -f for csh; we will not support broken use of
2288 ;; .cshrcs. Even the BSD csh manual says to use
2289 ;; "if ($?prompt) exit" before things which are not useful
2290 ;; non-interactively. Besides, if someone wants their other
2291 ;; aliases for shell commands then they can still have them.
2295 t)
2296 nil shell-command-switch command)
2303 ;; Do no formatting while reading error file,
2304 ;; because that can run a shell command, and we
2305 ;; don't want that to cause an infinite recursion.
2307 ;; Put point after the inserted errors.
2311 ;; This is like exchange-point-and-mark, but doesn't
2312 ;; activate the mark. It is cleaner to avoid activation,
2313 ;; even though the command loop would deactivate the mark
2314 ;; because we inserted text.
2318 ;; Output goes in a separate buffer.
2319 ;; Preserve the match data in case called from a program.
2322 ;; Command ending with ampersand means asynchronous.
2326 proc)
2327 ;; Remove the ampersand.
2329 ;; If will kill a process, query first.
2337 ;; Setting buffer-read-only to nil doesn't suffice
2338 ;; if some text has a non-nil read-only property,
2339 ;; which comint sometimes adds for prompts.
2345 shell-command-switch command))
2349 ;; Use the comint filter for proper handling of carriage motion
2350 ;; (see `comint-inhibit-carriage-motion'),.
2352 ))
2353 ;; Otherwise, command is executed synchronously.
2355 output-buffer nil error-buffer)))))))
2359 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2360 MESSAGE may be either a string or a buffer.
2362 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2363 the maximum height of the echo area, as defined by `max-mini-window-height'
2364 if `resize-mini-windows' is non-nil.
2366 Returns either the string shown in the echo area, or when a pop-up
2367 buffer is used, the window used to display it.
2369 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2370 name of the buffer used to display it in the case where a pop-up buffer
2371 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2372 string and it is displayed in the echo area, it is not specified whether
2373 the contents are inserted into the buffer anyway.
2375 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2376 and only used if a buffer is displayed."
2378 ;; Trivial case where we can use the echo area
2382 ;; Trivial case where we can just remove single trailing newline
2385 ;; General case
2388 message
2397 0
2401 (<= lines
2405 max-mini-window-height))
2407 max-mini-window-height)
2411 ;; Don't use the echo area if the output buffer is
2412 ;; already dispayed in the selected frame.
2414 ;; Echo area
2420 ;; Buffer
2423 not-this-window frame))))))))
2426 ;; We have a sentinel to prevent insertion of a termination message
2427 ;; in the buffer itself.
2435 &optional output-buffer replace
2436 error-buffer display-error-buffer)
2437 "Execute string COMMAND in inferior shell with region as input.
2438 Normally display output (if any) in temp buffer `*Shell Command Output*';
2439 Prefix arg means replace the region with it. Return the exit code of
2440 COMMAND.
2442 To specify a coding system for converting non-ASCII characters
2444 before this command. By default, the input (from the current buffer)
2445 is encoded in the same coding system that will be used to save the file,
2446 `buffer-file-coding-system'. If the output is going to replace the region,
2447 then it is decoded from that same coding system.
2449 The noninteractive arguments are START, END, COMMAND,
2450 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2451 Noninteractive callers can specify coding systems by binding
2452 `coding-system-for-read' and `coding-system-for-write'.
2454 If the command generates output, the output may be displayed
2455 in the echo area or in a buffer.
2456 If the output is short enough to display in the echo area
2457 \(determined by the variable `max-mini-window-height' if
2458 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2459 it is displayed in the buffer `*Shell Command Output*'. The output
2460 is available in that buffer in both cases.
2462 If there is output and an error, a message about the error
2463 appears at the end of the output.
2465 If there is no output, or if output is inserted in the current buffer,
2466 then `*Shell Command Output*' is deleted.
2468 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2469 that says to put the output in some other buffer.
2470 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2471 If OUTPUT-BUFFER is not a buffer and not nil,
2472 insert output in the current buffer.
2473 In either case, the output is inserted after point (leaving mark after it).
2475 If REPLACE, the optional fifth argument, is non-nil, that means insert
2476 the output in place of text from START to END, putting point and mark
2477 around it.
2479 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2480 or buffer name to which to direct the command's standard error output.
2481 If it is nil, error output is mingled with regular output.
2482 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2483 were any errors. (This is always t, interactively.)
2484 In an interactive call, the variable `shell-command-default-error-buffer'
2485 specifies the value of ERROR-BUFFER."
2489 ;; Do this before calling region-beginning
2490 ;; and region-end, in case subprocess output
2491 ;; relocates them while we are in the minibuffer.
2493 ;; call-interactively recognizes region-beginning and
2494 ;; region-end specially, leaving them in the history.
2496 string
2497 current-prefix-arg
2498 current-prefix-arg
2499 shell-command-default-error-buffer
2500 t)))
2506 temporary-file-directory)))
2507 nil))
2508 exit-status)
2512 ;; Replace specified region with output from command.
2514 ;; Don't muck with mark unless REPLACE says we should.
2521 t)
2522 nil shell-command-switch command))
2523 ;; It is rude to delete a buffer which the command is not using.
2524 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2525 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2526 ;; (kill-buffer shell-buffer)))
2527 ;; Don't muck with mark unless REPLACE says we should.
2529 ;; No prefix argument: put the output in a temp buffer,
2530 ;; replacing its entire contents.
2535 ;; If the input is the same buffer as the output,
2536 ;; delete everything but the specified region,
2537 ;; then replace that region with the output.
2543 shell-file-name t
2546 t)
2547 nil shell-command-switch
2548 command)))
2549 ;; Clear the output buffer, then run the command with
2550 ;; output there.
2561 buffer)
2562 nil shell-command-switch command)))
2563 ;; Report the output.
2573 ;; There's some output, display it
2575 ;; No output; error?
2582 shell-command-default-error-buffer)
2589 output))
2592 exit-status))
2595 exit-status output))))
2596 ;; Don't kill: there might be useful info in the undo-log.
2597 ;; (kill-buffer buffer)
2598 ))))
2606 ;; Do no formatting while reading error file,
2607 ;; because that can run a shell command, and we
2608 ;; don't want that to cause an infinite recursion.
2610 ;; Put point after the inserted errors.
2615 exit-status))
2618 "Execute shell command COMMAND and return its output as a string."
2621 standard-output
2625 "Process files synchronously in a separate process.
2626 Similar to `call-process', but may invoke a file handler based on
2627 `default-directory'. The current working directory of the
2628 subprocess is `default-directory'.
2630 File names in INFILE and BUFFER are handled normally, but file
2631 names in ARGS should be relative to `default-directory', as they
2632 are passed to the process verbatim. \(This is a difference to
2633 `call-process' which does not support file handlers for INFILE
2634 and BUFFER.\)
2636 Some file handlers might not support all variants, for example
2637 they might behave as if DISPLAY was nil, regardless of the actual
2638 value passed."
2640 lc stderr-file)
2650 display args)
2656 "Whether a call of `process-file' changes remote files.
2658 Per default, this variable is always set to `t', meaning that a
2659 call of `process-file' could potentially change any file on a
2660 remote host. When set to `nil', a file handler could optimize
2661 its behavior with respect to remote file attributes caching.
2663 This variable should never be changed by `setq'. Instead of, it
2667 "Start a program in a subprocess. Return the process object for it.
2669 Similar to `start-process', but may invoke a file handler based on
2670 `default-directory'. See Info node `(elisp)Magic File Names'.
2672 This handler ought to run PROGRAM, perhaps on the local host,
2673 perhaps on a remote host that corresponds to `default-directory'.
2674 In the latter case, the local part of `default-directory' becomes
2675 the working directory of the process.
2677 PROGRAM and PROGRAM-ARGS might be file names. They are not
2678 objects of file handler invocation. File handlers might not
2679 support pty association, if PROGRAM is nil."
2683 \f
2684 ;;;; Process menu
2696 "Major mode for listing the processes called by Emacs."
2708 "Recompute the list of processes for the Process List buffer."
2719 face link
2722 follow-link t
2723 process-buffer ,buf
2724 action process-menu-visit-buffer)
2733 "datagram"
2748 tabulated-list-entries)))))
2754 "Display a list of all processes.
2755 If optional argument QUERY-ONLY is non-nil, only processes with
2756 the query-on-exit flag set are listed.
2757 Any process listed as exited or signaled is actually eliminated
2758 after the listing is made.
2759 Optional argument BUFFER specifies a buffer to use, instead of
2761 The return value is always nil."
2773 nil)
2774 \f
2778 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2779 (define-key map [switch-frame] nil)
2780 (define-key map [?\C-u] 'universal-argument-more)
2781 (define-key map [?-] 'universal-argument-minus)
2782 (define-key map [?0] 'digit-argument)
2783 (define-key map [?1] 'digit-argument)
2784 (define-key map [?2] 'digit-argument)
2785 (define-key map [?3] 'digit-argument)
2786 (define-key map [?4] 'digit-argument)
2787 (define-key map [?5] 'digit-argument)
2788 (define-key map [?6] 'digit-argument)
2789 (define-key map [?7] 'digit-argument)
2790 (define-key map [?8] 'digit-argument)
2791 (define-key map [?9] 'digit-argument)
2792 (define-key map [kp-0] 'digit-argument)
2793 (define-key map [kp-1] 'digit-argument)
2794 (define-key map [kp-2] 'digit-argument)
2795 (define-key map [kp-3] 'digit-argument)
2796 (define-key map [kp-4] 'digit-argument)
2797 (define-key map [kp-5] 'digit-argument)
2798 (define-key map [kp-6] 'digit-argument)
2799 (define-key map [kp-7] 'digit-argument)
2800 (define-key map [kp-8] 'digit-argument)
2801 (define-key map [kp-9] 'digit-argument)
2802 (define-key map [kp-subtract] 'universal-argument-minus)
2803 map)
2806 (defvar universal-argument-num-events nil
2807 "Number of argument-specifying events read by `universal-argument'.
2808 `universal-argument-other-key' uses this to discard those events
2809 from (this-command-keys), and reread only the final command.")
2811 (defvar saved-overriding-map t
2812 "The saved value of `overriding-terminal-local-map'.
2816 (defun save&set-overriding-map (map)
2817 "Set `overriding-terminal-local-map' to MAP."
2818 (when (eq saved-overriding-map t)
2819 (setq saved-overriding-map overriding-terminal-local-map)
2820 (setq overriding-terminal-local-map map)))
2822 (defun restore-overriding-map ()
2823 "Restore `overriding-terminal-local-map' to its saved value."
2824 (setq overriding-terminal-local-map saved-overriding-map)
2825 (setq saved-overriding-map t))
2827 (defun universal-argument ()
2828 "Begin a numeric argument for the following command.
2833 multiplies the argument by 4 each time.
2835 which is different in effect from any particular numeric argument.
2837 (interactive)
2838 (setq prefix-arg (list 4))
2839 (setq universal-argument-num-events (length (this-command-keys)))
2840 (save&set-overriding-map universal-argument-map))
2842 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2843 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2844 (defun universal-argument-more (arg)
2845 (interactive "P")
2846 (if (consp arg)
2847 (setq prefix-arg (list (* 4 (car arg))))
2848 (if (eq arg '-)
2849 (setq prefix-arg (list -4))
2850 (setq prefix-arg arg)
2851 (restore-overriding-map)))
2852 (setq universal-argument-num-events (length (this-command-keys))))
2854 (defun negative-argument (arg)
2855 "Begin a negative numeric argument for the next command.
2857 (interactive "P")
2858 (cond ((integerp arg)
2859 (setq prefix-arg (- arg)))
2860 ((eq arg '-)
2861 (setq prefix-arg nil))
2862 (t
2863 (setq prefix-arg '-)))
2864 (setq universal-argument-num-events (length (this-command-keys)))
2865 (save&set-overriding-map universal-argument-map))
2867 (defun digit-argument (arg)
2868 "Part of the numeric argument for the next command.
2870 (interactive "P")
2871 (let* ((char (if (integerp last-command-event)
2872 last-command-event
2873 (get last-command-event 'ascii-character)))
2875 (cond ((integerp arg)
2876 (setq prefix-arg (+ (* arg 10)
2877 (if (< arg 0) (- digit) digit))))
2878 ((eq arg '-)
2879 ;; Treat -0 as just -, so that -01 will work.
2880 (setq prefix-arg (if (zerop digit) '- (- digit))))
2881 (t
2882 (setq prefix-arg digit))))
2883 (setq universal-argument-num-events (length (this-command-keys)))
2884 (save&set-overriding-map universal-argument-map))
2886 ;; For backward compatibility, minus with no modifiers is an ordinary
2887 ;; command if digits have already been entered.
2888 (defun universal-argument-minus (arg)
2889 (interactive "P")
2890 (if (integerp arg)
2891 (universal-argument-other-key arg)
2892 (negative-argument arg)))
2894 ;; Anything else terminates the argument and is left in the queue to be
2895 ;; executed as a command.
2896 (defun universal-argument-other-key (arg)
2897 (interactive "P")
2898 (setq prefix-arg arg)
2899 (let* ((key (this-command-keys))
2900 (keylist (listify-key-sequence key)))
2901 (setq unread-command-events
2902 (append (nthcdr universal-argument-num-events keylist)
2903 unread-command-events)))
2904 (reset-this-command-lengths)
2905 (restore-overriding-map))
2906 \f
2908 (defvar filter-buffer-substring-functions nil
2909 "Wrapper hook around `filter-buffer-substring'.
2910 The functions on this special hook are called with 4 arguments:
2911 NEXT-FUN BEG END DELETE
2912 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2913 that performs the default operation. The other 3 arguments are like
2914 the ones passed to `filter-buffer-substring'.")
2916 (defvar buffer-substring-filters nil
2917 "List of filter functions for `filter-buffer-substring'.
2918 Each function must accept a single argument, a string, and return
2919 a string. The buffer substring is passed to the first function
2920 in the list, and the return value of each function is passed to
2921 the next. The return value of the last function is used as the
2922 return value of `filter-buffer-substring'.
2924 If this variable is nil, no filtering is performed.")
2925 (make-obsolete-variable 'buffer-substring-filters
2926 'filter-buffer-substring-functions "24.1")
2928 (defun filter-buffer-substring (beg end &optional delete)
2929 "Return the buffer substring between BEG and END, after filtering.
2930 The filtering is performed by `filter-buffer-substring-functions'.
2932 If DELETE is non-nil, the text between BEG and END is deleted
2933 from the buffer.
2935 This function should be used instead of `buffer-substring',
2936 `buffer-substring-no-properties', or `delete-and-extract-region'
2937 when you want to allow filtering to take place. For example,
2938 major or minor modes can use `filter-buffer-substring-functions' to
2939 extract characters that are special to a buffer, and should not
2940 be copied into other buffers."
2941 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2942 (cond
2943 ((or delete buffer-substring-filters)
2944 (save-excursion
2945 (goto-char beg)
2946 (let ((string (if delete (delete-and-extract-region beg end)
2947 (buffer-substring beg end))))
2948 (dolist (filter buffer-substring-filters)
2949 (setq string (funcall filter string)))
2950 string)))
2951 (t
2952 (buffer-substring beg end)))))
2955 ;;;; Window system cut and paste hooks.
2957 (defvar interprogram-cut-function nil
2958 "Function to call to make a killed region available to other programs.
2960 Most window systems provide some sort of facility for cutting and
2961 pasting text between the windows of different programs.
2962 This variable holds a function that Emacs calls whenever text
2963 is put in the kill ring, to make the new kill available to other
2964 programs.
2966 The function takes one argument, TEXT, which is a string containing
2967 the text which should be made available.")
2969 (defvar interprogram-paste-function nil
2970 "Function to call to get text cut from other programs.
2972 Most window systems provide some sort of facility for cutting and
2973 pasting text between the windows of different programs.
2974 This variable holds a function that Emacs calls to obtain
2975 text that other programs have provided for pasting.
2977 The function should be called with no arguments. If the function
2978 returns nil, then no other program has provided such text, and the top
2979 of the Emacs kill ring should be used. If the function returns a
2980 string, then the caller of the function \(usually `current-kill')
2981 should put this string in the kill ring as the latest kill.
2983 This function may also return a list of strings if the window
2984 system supports multiple selections. The first string will be
2985 used as the pasted text, but the other will be placed in the
2986 kill ring for easy access via `yank-pop'.
2988 Note that the function should return a string only if a program other
2989 than Emacs has provided a string for pasting; if Emacs provided the
2990 most recent string, the function should return nil. If it is
2991 difficult to tell whether Emacs or some other program provided the
2992 current string, it is probably good enough to return nil if the string
2993 is equal (according to `string=') to the last text Emacs provided.")
2994 \f
2997 ;;;; The kill ring data structure.
2999 (defvar kill-ring nil
3000 "List of killed text sequences.
3001 Since the kill ring is supposed to interact nicely with cut-and-paste
3002 facilities offered by window systems, use of this variable should
3003 interact nicely with `interprogram-cut-function' and
3004 `interprogram-paste-function'. The functions `kill-new',
3005 `kill-append', and `current-kill' are supposed to implement this
3006 interaction; you may want to use them instead of manipulating the kill
3007 ring directly.")
3009 (defcustom kill-ring-max 60
3010 "Maximum length of kill ring before oldest elements are thrown away."
3011 :type 'integer
3012 :group 'killing)
3014 (defvar kill-ring-yank-pointer nil
3015 "The tail of the kill ring whose car is the last thing yanked.")
3017 (defcustom save-interprogram-paste-before-kill nil
3018 "Save clipboard strings into kill ring before replacing them.
3019 When one selects something in another program to paste it into Emacs,
3020 but kills something in Emacs before actually pasting it,
3021 this selection is gone unless this variable is non-nil,
3022 in which case the other program's selection is saved in the `kill-ring'
3024 :type 'boolean
3025 :group 'killing
3026 :version "23.2")
3028 (defcustom kill-do-not-save-duplicates nil
3029 "Do not add a new string to `kill-ring' when it is the same as the last one."
3030 :type 'boolean
3031 :group 'killing
3032 :version "23.2")
3034 (defun kill-new (string &optional replace yank-handler)
3035 "Make STRING the latest kill in the kill ring.
3036 Set `kill-ring-yank-pointer' to point to it.
3037 If `interprogram-cut-function' is non-nil, apply it to STRING.
3038 Optional second argument REPLACE non-nil means that STRING will replace
3039 the front of the kill ring, rather than being added to the list.
3041 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3042 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3043 STRING.
3045 When the yank handler has a non-nil PARAM element, the original STRING
3046 argument is not used by `insert-for-yank'. However, since Lisp code
3047 may access and use elements from the kill ring directly, the STRING
3049 (if (> (length string) 0)
3050 (if yank-handler
3051 (put-text-property 0 (length string)
3052 'yank-handler yank-handler string))
3053 (if yank-handler
3054 (signal 'args-out-of-range
3055 (list string "yank-handler specified for empty string"))))
3056 (unless (and kill-do-not-save-duplicates
3057 (equal string (car kill-ring)))
3058 (if (fboundp 'menu-bar-update-yank-menu)
3059 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3060 (when save-interprogram-paste-before-kill
3061 (let ((interprogram-paste (and interprogram-paste-function
3062 (funcall interprogram-paste-function))))
3063 (when interprogram-paste
3064 (dolist (s (if (listp interprogram-paste)
3065 (nreverse interprogram-paste)
3066 (list interprogram-paste)))
3067 (unless (and kill-do-not-save-duplicates
3068 (equal s (car kill-ring)))
3069 (push s kill-ring))))))
3070 (unless (and kill-do-not-save-duplicates
3071 (equal string (car kill-ring)))
3072 (if (and replace kill-ring)
3073 (setcar kill-ring string)
3074 (push string kill-ring)
3075 (if (> (length kill-ring) kill-ring-max)
3076 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3077 (setq kill-ring-yank-pointer kill-ring)
3078 (if interprogram-cut-function
3079 (funcall interprogram-cut-function string)))
3080 (set-advertised-calling-convention
3081 'kill-new '(string &optional replace) "23.3")
3083 (defun kill-append (string before-p &optional yank-handler)
3084 "Append STRING to the end of the latest kill in the kill ring.
3085 If BEFORE-P is non-nil, prepend STRING to the kill.
3086 If `interprogram-cut-function' is set, pass the resulting kill to it."
3087 (let* ((cur (car kill-ring)))
3088 (kill-new (if before-p (concat string cur) (concat cur string))
3089 (or (= (length cur) 0)
3090 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3091 yank-handler)))
3092 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3094 (defcustom yank-pop-change-selection nil
3095 "If non-nil, rotating the kill ring changes the window system selection."
3096 :type 'boolean
3097 :group 'killing
3098 :version "23.1")
3100 (defun current-kill (n &optional do-not-move)
3101 "Rotate the yanking point by N places, and then return that kill.
3102 If N is zero and `interprogram-paste-function' is set to a
3103 function that returns a string or a list of strings, and if that
3104 function doesn't return nil, then that string (or list) is added
3105 to the front of the kill ring and the string (or first string in
3106 the list) is returned as the latest kill.
3108 If N is not zero, and if `yank-pop-change-selection' is
3109 non-nil, use `interprogram-cut-function' to transfer the
3110 kill at the new yank point into the window system selection.
3112 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3113 move the yanking point; just return the Nth kill forward."
3115 (let ((interprogram-paste (and (= n 0)
3116 interprogram-paste-function
3117 (funcall interprogram-paste-function))))
3118 (if interprogram-paste
3119 (progn
3120 ;; Disable the interprogram cut function when we add the new
3121 ;; text to the kill ring, so Emacs doesn't try to own the
3122 ;; selection, with identical text.
3123 (let ((interprogram-cut-function nil))
3124 (if (listp interprogram-paste)
3125 (mapc 'kill-new (nreverse interprogram-paste))
3126 (kill-new interprogram-paste)))
3127 (car kill-ring))
3128 (or kill-ring (error "Kill ring is empty"))
3129 (let ((ARGth-kill-element
3130 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3131 (length kill-ring))
3132 kill-ring)))
3133 (unless do-not-move
3134 (setq kill-ring-yank-pointer ARGth-kill-element)
3135 (when (and yank-pop-change-selection
3136 (> n 0)
3137 interprogram-cut-function)
3138 (funcall interprogram-cut-function (car ARGth-kill-element))))
3139 (car ARGth-kill-element)))))
3143 ;;;; Commands for manipulating the kill ring.
3145 (defcustom kill-read-only-ok nil
3146 "Non-nil means don't signal an error for killing read-only text."
3147 :type 'boolean
3148 :group 'killing)
3150 (put 'text-read-only 'error-conditions
3151 '(text-read-only buffer-read-only error))
3152 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3154 (defun kill-region (beg end &optional yank-handler)
3156 This deletes the text from the buffer and saves it in the kill ring.
3160 If you want to append the killed region to the last killed text,
3163 If the buffer is read-only, Emacs will beep and refrain from deleting
3164 the text, but put the text in the kill ring anyway. This means that
3165 you can use the killing commands to copy text from a read-only buffer.
3167 Lisp programs should use this function for killing text.
3168 (To delete text, use `delete-region'.)
3169 Supply two arguments, character positions indicating the stretch of text
3170 to be killed.
3172 If the previous command was also a kill command,
3173 the text killed this time appends to the text killed last time
3174 to make one entry in the kill ring."
3175 ;; Pass point first, then mark, because the order matters
3176 ;; when calling kill-append.
3177 (interactive (list (point) (mark)))
3178 (unless (and beg end)
3179 (error "The mark is not set now, so there is no region"))
3180 (condition-case nil
3181 (let ((string (filter-buffer-substring beg end t)))
3182 (when string ;STRING is nil if BEG = END
3183 ;; Add that string to the kill ring, one way or another.
3184 (if (eq last-command 'kill-region)
3185 (kill-append string (< end beg) yank-handler)
3186 (kill-new string nil yank-handler)))
3187 (when (or string (eq last-command 'kill-region))
3188 (setq this-command 'kill-region))
3189 nil)
3190 ((buffer-read-only text-read-only)
3191 ;; The code above failed because the buffer, or some of the characters
3192 ;; in the region, are read-only.
3193 ;; We should beep, in case the user just isn't aware of this.
3194 ;; However, there's no harm in putting
3195 ;; the region's text in the kill ring, anyway.
3196 (copy-region-as-kill beg end)
3197 ;; Set this-command now, so it will be set even if we get an error.
3198 (setq this-command 'kill-region)
3199 ;; This should barf, if appropriate, and give us the correct error.
3200 (if kill-read-only-ok
3201 (progn (message "Read only text copied to kill ring") nil)
3202 ;; Signal an error if the buffer is read-only.
3203 (barf-if-buffer-read-only)
3204 ;; If the buffer isn't read-only, the text is.
3205 (signal 'text-read-only (list (current-buffer)))))))
3206 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3208 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3209 ;; to get two copies of the text when the user accidentally types M-w and
3210 ;; then corrects it with the intended C-w.
3211 (defun copy-region-as-kill (beg end)
3212 "Save the region as if killed, but don't kill it.
3213 In Transient Mark mode, deactivate the mark.
3214 If `interprogram-cut-function' is non-nil, also save the text for a window
3215 system cut and paste.
3217 This command's old key binding has been given to `kill-ring-save'."
3218 (interactive "r")
3219 (if (eq last-command 'kill-region)
3220 (kill-append (filter-buffer-substring beg end) (< end beg))
3221 (kill-new (filter-buffer-substring beg end)))
3222 (setq deactivate-mark t)
3223 nil)
3225 (defun kill-ring-save (beg end)
3226 "Save the region as if killed, but don't kill it.
3227 In Transient Mark mode, deactivate the mark.
3228 If `interprogram-cut-function' is non-nil, also save the text for a window
3229 system cut and paste.
3231 If you want to append the killed line to the last killed text,
3234 This command is similar to `copy-region-as-kill', except that it gives
3235 visual feedback indicating the extent of the region being copied."
3236 (interactive "r")
3237 (copy-region-as-kill beg end)
3238 ;; This use of called-interactively-p is correct
3239 ;; because the code it controls just gives the user visual feedback.
3240 (if (called-interactively-p 'interactive)
3241 (let ((other-end (if (= (point) beg) end beg))
3242 (opoint (point))
3243 ;; Inhibit quitting so we can make a quit here
3244 ;; look like a C-g typed as a command.
3245 (inhibit-quit t))
3246 (if (pos-visible-in-window-p other-end (selected-window))
3247 ;; Swap point-and-mark quickly so as to show the region that
3248 ;; was selected. Don't do it if the region is highlighted.
3249 (unless (and (region-active-p)
3250 (face-background 'region))
3251 ;; Swap point and mark.
3252 (set-marker (mark-marker) (point) (current-buffer))
3253 (goto-char other-end)
3254 (sit-for blink-matching-delay)
3255 ;; Swap back.
3256 (set-marker (mark-marker) other-end (current-buffer))
3257 (goto-char opoint)
3258 ;; If user quit, deactivate the mark
3259 ;; as C-g would as a command.
3260 (and quit-flag mark-active
3261 (deactivate-mark)))
3262 (let* ((killed-text (current-kill 0))
3263 (message-len (min (length killed-text) 40)))
3264 (if (= (point) beg)
3265 ;; Don't say "killed"; that is misleading.
3267 (substring killed-text (- message-len)))
3269 (substring killed-text 0 message-len))))))))
3271 (defun append-next-kill (&optional interactive)
3272 "Cause following command, if it kills, to append to previous kill.
3273 The argument is used for internal purposes; do not supply one."
3274 (interactive "p")
3275 ;; We don't use (interactive-p), since that breaks kbd macros.
3276 (if interactive
3277 (progn
3278 (setq this-command 'kill-region)
3279 (message "If the next command is a kill, it will append"))
3280 (setq last-command 'kill-region)))
3281 \f
3282 ;; Yanking.
3284 ;; This is actually used in subr.el but defcustom does not work there.
3285 (defcustom yank-excluded-properties
3286 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3287 yank-handler follow-link fontified)
3288 "Text properties to discard when yanking.
3289 The value should be a list of text properties to discard or t,
3290 which means to discard all text properties."
3291 :type '(choice (const :tag "All" t) (repeat symbol))
3292 :group 'killing
3293 :version "22.1")
3295 (defvar yank-window-start nil)
3296 (defvar yank-undo-function nil
3297 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3298 Function is called with two parameters, START and END corresponding to
3299 the value of the mark and point; it is guaranteed that START <= END.
3300 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3302 (defun yank-pop (&optional arg)
3303 "Replace just-yanked stretch of killed text with a different stretch.
3304 This command is allowed only immediately after a `yank' or a `yank-pop'.
3305 At such a time, the region contains a stretch of reinserted
3306 previously-killed text. `yank-pop' deletes that text and inserts in its
3307 place a different stretch of killed text.
3309 With no argument, the previous kill is inserted.
3310 With argument N, insert the Nth previous kill.
3311 If N is negative, this is a more recent kill.
3313 The sequence of kills wraps around, so that after the oldest one
3314 comes the newest one.
3316 When this command inserts killed text into the buffer, it honors
3317 `yank-excluded-properties' and `yank-handler' as described in the
3318 doc string for `insert-for-yank-1', which see."
3319 (interactive "*p")
3320 (if (not (eq last-command 'yank))
3321 (error "Previous command was not a yank"))
3322 (setq this-command 'yank)
3323 (unless arg (setq arg 1))
3324 (let ((inhibit-read-only t)
3325 (before (< (point) (mark t))))
3326 (if before
3327 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3328 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3329 (setq yank-undo-function nil)
3330 (set-marker (mark-marker) (point) (current-buffer))
3331 (insert-for-yank (current-kill arg))
3332 ;; Set the window start back where it was in the yank command,
3333 ;; if possible.
3334 (set-window-start (selected-window) yank-window-start t)
3335 (if before
3336 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3337 ;; It is cleaner to avoid activation, even though the command
3338 ;; loop would deactivate the mark because we inserted text.
3339 (goto-char (prog1 (mark t)
3340 (set-marker (mark-marker) (point) (current-buffer))))))
3341 nil)
3343 (defun yank (&optional arg)
3345 More precisely, reinsert the stretch of killed text most recently
3346 killed OR yanked. Put point at end, and set mark at beginning.
3347 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3348 With argument N, reinsert the Nth most recently killed stretch of killed
3349 text.
3351 When this command inserts killed text into the buffer, it honors
3352 `yank-excluded-properties' and `yank-handler' as described in the
3353 doc string for `insert-for-yank-1', which see.
3356 (interactive "*P")
3357 (setq yank-window-start (window-start))
3358 ;; If we don't get all the way thru, make last-command indicate that
3359 ;; for the following command.
3360 (setq this-command t)
3361 (push-mark (point))
3362 (insert-for-yank (current-kill (cond
3363 ((listp arg) 0)
3364 ((eq arg '-) -2)
3365 (t (1- arg)))))
3366 (if (consp arg)
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 ;; If we do get all the way thru, make this-command indicate that.
3373 (if (eq this-command t)
3374 (setq this-command 'yank))
3375 nil)
3377 (defun rotate-yank-pointer (arg)
3378 "Rotate the yanking point in the kill ring.
3379 With ARG, rotate that many kills forward (or backward, if negative)."
3380 (interactive "p")
3381 (current-kill arg))
3382 \f
3383 ;; Some kill commands.
3385 ;; Internal subroutine of delete-char
3386 (defun kill-forward-chars (arg)
3387 (if (listp arg) (setq arg (car arg)))
3388 (if (eq arg '-) (setq arg -1))
3389 (kill-region (point) (+ (point) arg)))
3391 ;; Internal subroutine of backward-delete-char
3392 (defun kill-backward-chars (arg)
3393 (if (listp arg) (setq arg (car arg)))
3394 (if (eq arg '-) (setq arg -1))
3395 (kill-region (point) (- (point) arg)))
3397 (defcustom backward-delete-char-untabify-method 'untabify
3398 "The method for untabifying when deleting backward.
3399 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3400 `hungry' -- delete all whitespace, both tabs and spaces;
3401 `all' -- delete all whitespace, including tabs, spaces and newlines;
3402 nil -- just delete one character."
3403 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3404 :version "20.3"
3405 :group 'killing)
3407 (defun backward-delete-char-untabify (arg &optional killp)
3408 "Delete characters backward, changing tabs into spaces.
3409 The exact behavior depends on `backward-delete-char-untabify-method'.
3410 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3411 Interactively, ARG is the prefix arg (default 1)
3412 and KILLP is t if a prefix arg was specified."
3414 (when (eq backward-delete-char-untabify-method 'untabify)
3415 (let ((count arg))
3416 (save-excursion
3417 (while (and (> count 0) (not (bobp)))
3419 (let ((col (current-column)))
3420 (forward-char -1)
3421 (setq col (- col (current-column)))
3422 (insert-char ?\s col)
3423 (delete-char 1)))
3424 (forward-char -1)
3425 (setq count (1- count))))))
3427 ((eq backward-delete-char-untabify-method 'all)
3429 (n (if skip
3430 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3431 (point)))))
3432 (+ arg (if (zerop wh) 0 (1- wh))))
3433 arg)))
3434 ;; Avoid warning about delete-backward-char
3435 (with-no-warnings (delete-backward-char n killp))))
3437 (defun zap-to-char (arg char)
3438 "Kill up to and including ARGth occurrence of CHAR.
3439 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3440 Goes backward if ARG is negative; error if CHAR not found."
3442 ;; Avoid "obsolete" warnings for translation-table-for-input.
3443 (with-no-warnings
3444 (if (char-table-p translation-table-for-input)
3445 (setq char (or (aref translation-table-for-input char) char))))
3446 (kill-region (point) (progn
3447 (search-forward (char-to-string char) nil nil arg)
3448 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3449 (point))))
3451 ;; kill-line and its subroutines.
3453 (defcustom kill-whole-line nil
3454 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3455 :type 'boolean
3456 :group 'killing)
3458 (defun kill-line (&optional arg)
3459 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3460 With prefix argument ARG, kill that many lines from point.
3461 Negative arguments kill lines backward.
3462 With zero argument, kills the text before point on the current line.
3465 a number counts as a prefix arg.
3467 To kill a whole line, when point is not at the beginning, type \
3470 If `show-trailing-whitespace' is non-nil, this command will just
3471 kill the rest of the current line, even if there are only
3472 nonblanks there.
3474 If `kill-whole-line' is non-nil, then this command kills the whole line
3475 including its terminating newline, when used at the beginning of a line
3476 with no argument. As a consequence, you can always kill a whole line
3479 If you want to append the killed line to the last killed text,
3482 If the buffer is read-only, Emacs will beep and refrain from deleting
3483 the line, but put the line in the kill ring anyway. This means that
3484 you can use this command to copy text from a read-only buffer.
3485 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3486 even beep.)"
3487 (interactive "P")
3488 (kill-region (point)
3489 ;; It is better to move point to the other end of the kill
3490 ;; before killing. That way, in a read-only buffer, point
3491 ;; moves across the text that is copied to the kill ring.
3492 ;; The choice has no effect on undo now that undo records
3493 ;; the value of point from before the command was run.
3494 (progn
3495 (if arg
3496 (forward-visible-line (prefix-numeric-value arg))
3497 (if (eobp)
3498 (signal 'end-of-buffer nil))
3499 (let ((end
3500 (save-excursion
3501 (end-of-visible-line) (point))))
3502 (if (or (save-excursion
3503 ;; If trailing whitespace is visible,
3504 ;; don't treat it as nothing.
3505 (unless show-trailing-whitespace
3507 (= (point) end))
3508 (and kill-whole-line (bolp)))
3509 (forward-visible-line 1)
3510 (goto-char end))))
3511 (point))))
3513 (defun kill-whole-line (&optional arg)
3514 "Kill current line.
3515 With prefix ARG, kill that many lines starting from the current line.
3516 If ARG is negative, kill backward. Also kill the preceding newline.
3518 If ARG is zero, kill current line but exclude the trailing newline."
3519 (interactive "p")
3520 (or arg (setq arg 1))
3521 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3522 (signal 'end-of-buffer nil))
3523 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3524 (signal 'beginning-of-buffer nil))
3525 (unless (eq last-command 'kill-region)
3526 (kill-new "")
3527 (setq last-command 'kill-region))
3528 (cond ((zerop arg)
3529 ;; We need to kill in two steps, because the previous command
3530 ;; could have been a kill command, in which case the text
3531 ;; before point needs to be prepended to the current kill
3532 ;; ring entry and the text after point appended. Also, we
3533 ;; need to use save-excursion to avoid copying the same text
3534 ;; twice to the kill ring in read-only buffers.
3535 (save-excursion
3536 (kill-region (point) (progn (forward-visible-line 0) (point))))
3537 (kill-region (point) (progn (end-of-visible-line) (point))))
3538 ((< arg 0)
3539 (save-excursion
3540 (kill-region (point) (progn (end-of-visible-line) (point))))
3541 (kill-region (point)
3542 (progn (forward-visible-line (1+ arg))
3543 (unless (bobp) (backward-char))
3544 (point))))
3545 (t
3546 (save-excursion
3547 (kill-region (point) (progn (forward-visible-line 0) (point))))
3548 (kill-region (point)
3549 (progn (forward-visible-line arg) (point))))))
3551 (defun forward-visible-line (arg)
3552 "Move forward by ARG lines, ignoring currently invisible newlines only.
3553 If ARG is negative, move backward -ARG lines.
3554 If ARG is zero, move to the beginning of the current line."
3555 (condition-case nil
3556 (if (> arg 0)
3557 (progn
3558 (while (> arg 0)
3559 (or (zerop (forward-line 1))
3560 (signal 'end-of-buffer nil))
3561 ;; If the newline we just skipped is invisible,
3562 ;; don't count it.
3563 (let ((prop
3564 (get-char-property (1- (point)) 'invisible)))
3565 (if (if (eq buffer-invisibility-spec t)
3566 prop
3567 (or (memq prop buffer-invisibility-spec)
3568 (assq prop buffer-invisibility-spec)))
3569 (setq arg (1+ arg))))
3570 (setq arg (1- arg)))
3571 ;; If invisible text follows, and it is a number of complete lines,
3572 ;; skip it.
3573 (let ((opoint (point)))
3574 (while (and (not (eobp))
3575 (let ((prop
3576 (get-char-property (point) 'invisible)))
3577 (if (eq buffer-invisibility-spec t)
3578 prop
3579 (or (memq prop buffer-invisibility-spec)
3580 (assq prop buffer-invisibility-spec)))))
3581 (goto-char
3582 (if (get-text-property (point) 'invisible)
3583 (or (next-single-property-change (point) 'invisible)
3584 (point-max))
3585 (next-overlay-change (point)))))
3586 (unless (bolp)
3587 (goto-char opoint))))
3588 (let ((first t))
3589 (while (or first (<= arg 0))
3590 (if first
3591 (beginning-of-line)
3592 (or (zerop (forward-line -1))
3593 (signal 'beginning-of-buffer nil)))
3594 ;; If the newline we just moved to is invisible,
3595 ;; don't count it.
3596 (unless (bobp)
3597 (let ((prop
3598 (get-char-property (1- (point)) 'invisible)))
3599 (unless (if (eq buffer-invisibility-spec t)
3600 prop
3601 (or (memq prop buffer-invisibility-spec)
3602 (assq prop buffer-invisibility-spec)))
3603 (setq arg (1+ arg)))))
3604 (setq first nil))
3605 ;; If invisible text follows, and it is a number of complete lines,
3606 ;; skip it.
3607 (let ((opoint (point)))
3608 (while (and (not (bobp))
3609 (let ((prop
3610 (get-char-property (1- (point)) 'invisible)))
3611 (if (eq buffer-invisibility-spec t)
3612 prop
3613 (or (memq prop buffer-invisibility-spec)
3614 (assq prop buffer-invisibility-spec)))))
3615 (goto-char
3616 (if (get-text-property (1- (point)) 'invisible)
3617 (or (previous-single-property-change (point) 'invisible)
3618 (point-min))
3619 (previous-overlay-change (point)))))
3620 (unless (bolp)
3621 (goto-char opoint)))))
3622 ((beginning-of-buffer end-of-buffer)
3623 nil)))
3625 (defun end-of-visible-line ()
3626 "Move to end of current visible line."
3627 (end-of-line)
3628 ;; If the following character is currently invisible,
3629 ;; skip all characters with that same `invisible' property value,
3630 ;; then find the next newline.
3631 (while (and (not (eobp))
3632 (save-excursion
3634 (let ((prop
3635 (get-char-property (point) 'invisible)))
3636 (if (eq buffer-invisibility-spec t)
3637 prop
3638 (or (memq prop buffer-invisibility-spec)
3639 (assq prop buffer-invisibility-spec))))))
3641 (if (get-text-property (point) 'invisible)
3642 (goto-char (next-single-property-change (point) 'invisible))
3643 (goto-char (next-overlay-change (point))))
3644 (end-of-line)))
3645 \f
3646 (defun insert-buffer (buffer)
3647 "Insert after point the contents of BUFFER.
3648 Puts mark after the inserted text.
3649 BUFFER may be a buffer or a buffer name.
3651 This function is meant for the user to run interactively.
3652 Don't call it from programs: use `insert-buffer-substring' instead!"
3653 (interactive
3654 (list
3655 (progn
3656 (barf-if-buffer-read-only)
3657 (read-buffer "Insert buffer: "
3658 (if (eq (selected-window) (next-window (selected-window)))
3659 (other-buffer (current-buffer))
3660 (window-buffer (next-window (selected-window))))
3661 t))))
3662 (push-mark
3663 (save-excursion
3664 (insert-buffer-substring (get-buffer buffer))
3665 (point)))
3666 nil)
3668 (defun append-to-buffer (buffer start end)
3669 "Append to specified buffer the text of the region.
3670 It is inserted into that buffer before its point.
3672 When calling from a program, give three arguments:
3673 BUFFER (or buffer name), START and END.
3674 START and END specify the portion of the current buffer to be copied."
3675 (interactive
3676 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3677 (region-beginning) (region-end)))
3678 (let* ((oldbuf (current-buffer))
3679 (append-to (get-buffer-create buffer))
3680 (windows (get-buffer-window-list append-to t t))
3681 point)
3682 (save-excursion
3683 (with-current-buffer append-to
3684 (setq point (point))
3685 (barf-if-buffer-read-only)
3686 (insert-buffer-substring oldbuf start end)
3687 (dolist (window windows)
3688 (when (= (window-point window) point)
3689 (set-window-point window (point))))))))
3691 (defun prepend-to-buffer (buffer start end)
3692 "Prepend to specified buffer the text of the region.
3693 It is inserted into that buffer after its point.
3695 When calling from a program, give three arguments:
3696 BUFFER (or buffer name), START and END.
3697 START and END specify the portion of the current buffer to be copied."
3699 (let ((oldbuf (current-buffer)))
3700 (with-current-buffer (get-buffer-create buffer)
3701 (barf-if-buffer-read-only)
3702 (save-excursion
3703 (insert-buffer-substring oldbuf start end)))))
3705 (defun copy-to-buffer (buffer start end)
3706 "Copy to specified buffer the text of the region.
3707 It is inserted into that buffer, replacing existing text there.
3709 When calling from a program, give three arguments:
3710 BUFFER (or buffer name), START and END.
3711 START and END specify the portion of the current buffer to be copied."
3713 (let ((oldbuf (current-buffer)))
3714 (with-current-buffer (get-buffer-create buffer)
3715 (barf-if-buffer-read-only)
3716 (erase-buffer)
3717 (save-excursion
3718 (insert-buffer-substring oldbuf start end)))))
3719 \f
3720 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3721 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3723 (defvar activate-mark-hook nil
3724 "Hook run when the mark becomes active.
3725 It is also run at the end of a command, if the mark is active and
3726 it is possible that the region may have changed.")
3728 (defvar deactivate-mark-hook nil
3729 "Hook run when the mark becomes inactive.")
3731 (defun mark (&optional force)
3732 "Return this buffer's mark value as integer, or nil if never set.
3734 In Transient Mark mode, this function signals an error if
3735 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3736 or the argument FORCE is non-nil, it disregards whether the mark
3737 is active, and returns an integer or nil in the usual way.
3739 If you are using this in an editing command, you are most likely making
3740 a mistake; see the documentation of `set-mark'."
3741 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3742 (marker-position (mark-marker))
3743 (signal 'mark-inactive nil)))
3745 (defsubst deactivate-mark (&optional force)
3746 "Deactivate the mark by setting `mark-active' to nil.
3747 Unless FORCE is non-nil, this function does nothing if Transient
3748 Mark mode is disabled.
3749 This function also runs `deactivate-mark-hook'."
3750 (when (or transient-mark-mode force)
3751 (when (and (if (eq select-active-regions 'only)
3752 (eq (car-safe transient-mark-mode) 'only)
3753 select-active-regions)
3754 (region-active-p)
3755 (display-selections-p))
3756 ;; The var `saved-region-selection', if non-nil, is the text in
3757 ;; the region prior to the last command modifying the buffer.
3758 ;; Set the selection to that, or to the current region.
3759 (cond (saved-region-selection
3760 (x-set-selection 'PRIMARY saved-region-selection)
3761 (setq saved-region-selection nil))
3762 ((/= (region-beginning) (region-end))
3763 (x-set-selection 'PRIMARY
3764 (buffer-substring-no-properties
3765 (region-beginning)
3766 (region-end))))))
3767 (if (and (null force)
3768 (or (eq transient-mark-mode 'lambda)
3769 (and (eq (car-safe transient-mark-mode) 'only)
3770 (null (cdr transient-mark-mode)))))
3771 ;; When deactivating a temporary region, don't change
3772 ;; `mark-active' or run `deactivate-mark-hook'.
3773 (setq transient-mark-mode nil)
3774 (if (eq (car-safe transient-mark-mode) 'only)
3775 (setq transient-mark-mode (cdr transient-mark-mode)))
3776 (setq mark-active nil)
3777 (run-hooks 'deactivate-mark-hook))))
3779 (defun activate-mark ()
3780 "Activate the mark."
3781 (when (mark t)
3782 (setq mark-active t)
3783 (unless transient-mark-mode
3784 (setq transient-mark-mode 'lambda))))
3786 (defun set-mark (pos)
3787 "Set this buffer's mark to POS. Don't use this function!
3788 That is to say, don't use this function unless you want
3789 the user to see that the mark has moved, and you want the previous
3790 mark position to be lost.
3792 Normally, when a new mark is set, the old one should go on the stack.
3793 This is why most applications should use `push-mark', not `set-mark'.
3795 Novice Emacs Lisp programmers often try to use the mark for the wrong
3796 purposes. The mark saves a location for the user's convenience.
3797 Most editing commands should not alter the mark.
3798 To remember a location for internal use in the Lisp program,
3799 store it in a Lisp variable. Example:
3801 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3803 (if pos
3804 (progn
3805 (setq mark-active t)
3806 (run-hooks 'activate-mark-hook)
3807 (set-marker (mark-marker) pos (current-buffer)))
3808 ;; Normally we never clear mark-active except in Transient Mark mode.
3809 ;; But when we actually clear out the mark value too, we must
3810 ;; clear mark-active in any mode.
3811 (deactivate-mark t)
3812 (set-marker (mark-marker) nil)))
3814 (defcustom use-empty-active-region nil
3816 If nil, region-aware commands treat empty regions as inactive.
3817 If non-nil, region-aware commands treat the region as active as
3818 long as the mark is active, even if the region is empty.
3820 Region-aware commands are those that act on the region if it is
3821 active and Transient Mark mode is enabled, and on the text near
3822 point otherwise."
3823 :type 'boolean
3824 :version "23.1"
3825 :group 'editing-basics)
3827 (defun use-region-p ()
3828 "Return t if the region is active and it is appropriate to act on it.
3829 This is used by commands that act specially on the region under
3830 Transient Mark mode.
3832 The return value is t if Transient Mark mode is enabled and the
3833 mark is active; furthermore, if `use-empty-active-region' is nil,
3834 the region must not be empty. Otherwise, the return value is nil.
3836 For some commands, it may be appropriate to ignore the value of
3837 `use-empty-active-region'; in that case, use `region-active-p'."
3838 (and (region-active-p)
3839 (or use-empty-active-region (> (region-end) (region-beginning)))))
3841 (defun region-active-p ()
3842 "Return t if Transient Mark mode is enabled and the mark is active.
3844 Some commands act specially on the region when Transient Mark
3845 mode is enabled. Usually, such commands should use
3846 `use-region-p' instead of this function, because `use-region-p'
3847 also checks the value of `use-empty-active-region'."
3848 (and transient-mark-mode mark-active))
3850 (defvar mark-ring nil
3851 "The list of former marks of the current buffer, most recent first.")
3852 (make-variable-buffer-local 'mark-ring)
3853 (put 'mark-ring 'permanent-local t)
3855 (defcustom mark-ring-max 16
3856 "Maximum size of mark ring. Start discarding off end if gets this big."
3857 :type 'integer
3858 :group 'editing-basics)
3860 (defvar global-mark-ring nil
3861 "The list of saved global marks, most recent first.")
3863 (defcustom global-mark-ring-max 16
3864 "Maximum size of global mark ring. \
3865 Start discarding off end if gets this big."
3866 :type 'integer
3867 :group 'editing-basics)
3869 (defun pop-to-mark-command ()
3870 "Jump to mark, and pop a new position for mark off the ring.
3871 \(Does not affect global mark ring\)."
3872 (interactive)
3873 (if (null (mark t))
3874 (error "No mark set in this buffer")
3875 (if (= (point) (mark t))
3876 (message "Mark popped"))
3877 (goto-char (mark t))
3878 (pop-mark)))
3880 (defun push-mark-command (arg &optional nomsg)
3881 "Set mark at where point is.
3882 If no prefix ARG and mark is already set there, just activate it.
3883 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3884 (interactive "P")
3885 (let ((mark (marker-position (mark-marker))))
3886 (if (or arg (null mark) (/= mark (point)))
3887 (push-mark nil nomsg t)
3888 (setq mark-active t)
3889 (run-hooks 'activate-mark-hook)
3890 (unless nomsg
3891 (message "Mark activated")))))
3893 (defcustom set-mark-command-repeat-pop nil
3896 will pop the mark twice, and
3898 will pop the mark three times.
3902 :type 'boolean
3903 :group 'editing-basics)
3905 (defcustom set-mark-default-inactive nil
3906 "If non-nil, setting the mark does not activate it.
3908 behave the same whether or not `transient-mark-mode' is enabled."
3909 :type 'boolean
3910 :group 'editing-basics
3911 :version "23.1")
3913 (defun set-mark-command (arg)
3914 "Set the mark where point is, or jump to the mark.
3915 Setting the mark also alters the region, which is the text
3916 between point and mark; this is the closest equivalent in
3919 With no prefix argument, set the mark at point, and push the
3920 old mark position on local mark ring. Also push the old mark on
3921 global mark ring, if the previous mark was set in another buffer.
3923 When Transient Mark Mode is off, immediately repeating this
3924 command activates `transient-mark-mode' temporarily.
3927 jump to the mark, and set the mark from
3928 position popped off the local mark ring \(this does not affect the global
3930 mark ring \(see `pop-global-mark'\).
3932 If `set-mark-command-repeat-pop' is non-nil, repeating
3934 off the local (or global) mark ring and jumps there.
3937 argument, unconditionally set mark where point is, even if
3938 `set-mark-command-repeat-pop' is non-nil.
3940 Novice Emacs Lisp programmers often try to use the mark for the wrong
3941 purposes. See the documentation of `set-mark' for more information."
3942 (interactive "P")
3943 (cond ((eq transient-mark-mode 'lambda)
3944 (setq transient-mark-mode nil))
3945 ((eq (car-safe transient-mark-mode) 'only)
3946 (deactivate-mark)))
3947 (cond
3948 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3949 (push-mark-command nil))
3950 ((not (eq this-command 'set-mark-command))
3951 (if arg
3952 (pop-to-mark-command)
3953 (push-mark-command t)))
3954 ((and set-mark-command-repeat-pop
3955 (eq last-command 'pop-to-mark-command))
3956 (setq this-command 'pop-to-mark-command)
3957 (pop-to-mark-command))
3958 ((and set-mark-command-repeat-pop
3959 (eq last-command 'pop-global-mark)
3960 (not arg))
3961 (setq this-command 'pop-global-mark)
3962 (pop-global-mark))
3963 (arg
3964 (setq this-command 'pop-to-mark-command)
3965 (pop-to-mark-command))
3966 ((eq last-command 'set-mark-command)
3967 (if (region-active-p)
3968 (progn
3969 (deactivate-mark)
3970 (message "Mark deactivated"))
3971 (activate-mark)
3972 (message "Mark activated")))
3973 (t
3974 (push-mark-command nil)
3975 (if set-mark-default-inactive (deactivate-mark)))))
3977 (defun push-mark (&optional location nomsg activate)
3978 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3979 If the last global mark pushed was not in the current buffer,
3980 also push LOCATION on the global mark ring.
3981 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3983 Novice Emacs Lisp programmers often try to use the mark for the wrong
3984 purposes. See the documentation of `set-mark' for more information.
3986 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3987 (unless (null (mark t))
3988 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3989 (when (> (length mark-ring) mark-ring-max)
3990 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3991 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3992 (set-marker (mark-marker) (or location (point)) (current-buffer))
3993 ;; Now push the mark on the global mark ring.
3994 (if (and global-mark-ring
3995 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3996 ;; The last global mark pushed was in this same buffer.
3997 ;; Don't push another one.
3998 nil
3999 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4000 (when (> (length global-mark-ring) global-mark-ring-max)
4001 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4002 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4003 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4004 (message "Mark set"))
4005 (if (or activate (not transient-mark-mode))
4006 (set-mark (mark t)))
4007 nil)
4009 (defun pop-mark ()
4010 "Pop off mark ring into the buffer's actual mark.
4011 Does not set point. Does nothing if mark ring is empty."
4012 (when mark-ring
4013 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4014 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4015 (move-marker (car mark-ring) nil)
4016 (if (null (mark t)) (ding))
4017 (setq mark-ring (cdr mark-ring)))
4018 (deactivate-mark))
4020 (define-obsolete-function-alias
4021 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4022 (defun exchange-point-and-mark (&optional arg)
4023 "Put the mark where point is now, and point where the mark is now.
4024 This command works even when the mark is not active,
4025 and it reactivates the mark.
4027 If Transient Mark mode is on, a prefix ARG deactivates the mark
4028 if it is active, and otherwise avoids reactivating it. If
4029 Transient Mark mode is off, a prefix ARG enables Transient Mark
4030 mode temporarily."
4031 (interactive "P")
4032 (let ((omark (mark t))
4033 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4034 (if (null omark)
4035 (error "No mark set in this buffer"))
4036 (deactivate-mark)
4037 (set-mark (point))
4038 (goto-char omark)
4039 (if set-mark-default-inactive (deactivate-mark))
4040 (cond (temp-highlight
4041 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4042 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4043 (not (or arg (region-active-p))))
4044 (deactivate-mark))
4045 (t (activate-mark)))
4046 nil))
4048 (defcustom shift-select-mode t
4049 "When non-nil, shifted motion keys activate the mark momentarily.
4051 While the mark is activated in this way, any shift-translated point
4052 motion key extends the region, and if Transient Mark mode was off, it
4053 is temporarily turned on. Furthermore, the mark will be deactivated
4054 by any subsequent point motion key that was not shift-translated, or
4055 by any action that normally deactivates the mark in Transient Mark mode.
4057 See `this-command-keys-shift-translated' for the meaning of
4058 shift-translation."
4059 :type 'boolean
4060 :group 'editing-basics)
4062 (defun handle-shift-selection ()
4063 "Activate/deactivate mark depending on invocation thru shift translation.
4064 This function is called by `call-interactively' when a command
4065 with a `^' character in its `interactive' spec is invoked, before
4066 running the command itself.
4068 If `shift-select-mode' is enabled and the command was invoked
4069 through shift translation, set the mark and activate the region
4070 temporarily, unless it was already set in this way. See
4071 `this-command-keys-shift-translated' for the meaning of shift
4072 translation.
4074 Otherwise, if the region has been activated temporarily,
4075 deactivate it, and restore the variable `transient-mark-mode' to
4076 its earlier value."
4077 (cond ((and shift-select-mode this-command-keys-shift-translated)
4078 (unless (and mark-active
4079 (eq (car-safe transient-mark-mode) 'only))
4080 (setq transient-mark-mode
4081 (cons 'only
4082 (unless (eq transient-mark-mode 'lambda)
4083 transient-mark-mode)))
4084 (push-mark nil nil t)))
4085 ((eq (car-safe transient-mark-mode) 'only)
4086 (setq transient-mark-mode (cdr transient-mark-mode))
4087 (deactivate-mark))))
4089 (define-minor-mode transient-mark-mode
4090 "Toggle Transient Mark mode.
4091 With a prefix argument ARG, enable Transient Mark mode if ARG is
4092 positive, and disable it otherwise. If called from Lisp, enable
4093 Transient Mark mode if ARG is omitted or nil.
4095 Transient Mark mode is a global minor mode. When enabled, the
4096 region is highlighted whenever the mark is active. The mark is
4098 operations that set the mark but whose main purpose is something
4104 Many commands change their behavior when Transient Mark mode is in effect
4105 and the mark is active, by acting on the region instead of their usual
4106 default part of the buffer's text. Examples of such commands include
4111 commands which are sensitive to the Transient Mark mode."
4112 :global t
4113 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4114 :variable transient-mark-mode)
4116 (defvar widen-automatically t
4117 "Non-nil means it is ok for commands to call `widen' when they want to.
4118 Some commands will do this in order to go to positions outside
4119 the current accessible part of the buffer.
4121 If `widen-automatically' is nil, these commands will do something else
4122 as a fallback, and won't change the buffer bounds.")
4124 (defvar non-essential nil
4125 "Whether the currently executing code is performing an essential task.
4126 This variable should be non-nil only when running code which should not
4127 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4128 user for a password when we are simply scanning a set of files in the
4129 background or displaying possible completions before the user even asked
4130 for it.")
4132 (defun pop-global-mark ()
4133 "Pop off global mark ring and jump to the top location."
4134 (interactive)
4135 ;; Pop entries which refer to non-existent buffers.
4136 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4137 (setq global-mark-ring (cdr global-mark-ring)))
4138 (or global-mark-ring
4139 (error "No global mark set"))
4140 (let* ((marker (car global-mark-ring))
4141 (buffer (marker-buffer marker))
4142 (position (marker-position marker)))
4143 (setq global-mark-ring (nconc (cdr global-mark-ring)
4144 (list (car global-mark-ring))))
4145 (set-buffer buffer)
4146 (or (and (>= position (point-min))
4147 (<= position (point-max)))
4148 (if widen-automatically
4149 (widen)
4150 (error "Global mark position is outside accessible part of buffer")))
4151 (goto-char position)
4152 (switch-to-buffer buffer)))
4153 \f
4154 (defcustom next-line-add-newlines nil
4155 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4156 :type 'boolean
4157 :version "21.1"
4158 :group 'editing-basics)
4160 (defun next-line (&optional arg try-vscroll)
4161 "Move cursor vertically down ARG lines.
4162 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4163 If there is no character in the target line exactly under the current column,
4164 the cursor is positioned after the character in that line which spans this
4165 column, or at the end of the line if it is not long enough.
4166 If there is no line in the buffer after this one, behavior depends on the
4167 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4168 to create a line, and moves the cursor to that line. Otherwise it moves the
4169 cursor to the end of the buffer.
4171 If the variable `line-move-visual' is non-nil, this command moves
4172 by display lines. Otherwise, it moves by buffer lines, without
4173 taking variable-width characters or continued lines into account.
4176 a semipermanent goal column for this command.
4177 Then instead of trying to move exactly vertically (or as close as possible),
4178 this command moves to the specified goal column (or as close as possible).
4179 The goal column is stored in the variable `goal-column', which is nil
4180 when there is no goal column. Note that setting `goal-column'
4181 overrides `line-move-visual' and causes this command to move by buffer
4182 lines rather than by display lines.
4184 If you are thinking of using this in a Lisp program, consider
4185 using `forward-line' instead. It is usually easier to use
4186 and more reliable (no dependence on goal column, etc.)."
4188 (or arg (setq arg 1))
4189 (if (and next-line-add-newlines (= arg 1))
4190 (if (save-excursion (end-of-line) (eobp))
4191 ;; When adding a newline, don't expand an abbrev.
4192 (let ((abbrev-mode nil))
4193 (end-of-line)
4195 (line-move arg nil nil try-vscroll))
4196 (if (called-interactively-p 'interactive)
4197 (condition-case err
4198 (line-move arg nil nil try-vscroll)
4199 ((beginning-of-buffer end-of-buffer)
4200 (signal (car err) (cdr err))))
4201 (line-move arg nil nil try-vscroll)))
4202 nil)
4204 (defun previous-line (&optional arg try-vscroll)
4205 "Move cursor vertically up ARG lines.
4206 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4207 If there is no character in the target line exactly over the current column,
4208 the cursor is positioned after the character in that line which spans this
4209 column, or at the end of the line if it is not long enough.
4211 If the variable `line-move-visual' is non-nil, this command moves
4212 by display lines. Otherwise, it moves by buffer lines, without
4213 taking variable-width characters or continued lines into account.
4216 a semipermanent goal column for this command.
4217 Then instead of trying to move exactly vertically (or as close as possible),
4218 this command moves to the specified goal column (or as close as possible).
4219 The goal column is stored in the variable `goal-column', which is nil
4220 when there is no goal column. Note that setting `goal-column'
4221 overrides `line-move-visual' and causes this command to move by buffer
4222 lines rather than by display lines.
4224 If you are thinking of using this in a Lisp program, consider using
4225 `forward-line' with a negative argument instead. It is usually easier
4226 to use and more reliable (no dependence on goal column, etc.)."
4228 (or arg (setq arg 1))
4229 (if (called-interactively-p 'interactive)
4230 (condition-case err
4231 (line-move (- arg) nil nil try-vscroll)
4232 ((beginning-of-buffer end-of-buffer)
4233 (signal (car err) (cdr err))))
4234 (line-move (- arg) nil nil try-vscroll))
4235 nil)
4237 (defcustom track-eol nil
4238 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4239 This means moving to the end of each line moved onto.
4240 The beginning of a blank line does not count as the end of a line.
4241 This has no effect when `line-move-visual' is non-nil."
4242 :type 'boolean
4243 :group 'editing-basics)
4245 (defcustom goal-column nil
4247 A non-nil setting overrides `line-move-visual', which see."
4248 :type '(choice integer
4249 (const :tag "None" nil))
4250 :group 'editing-basics)
4251 (make-variable-buffer-local 'goal-column)
4253 (defvar temporary-goal-column 0
4254 "Current goal column for vertical motion.
4255 It is the column where point was at the start of the current run
4256 of vertical motion commands.
4258 When moving by visual lines via `line-move-visual', it is a cons
4259 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4260 divided by the default column width, and HSCROLL is the number of
4261 columns by which window is scrolled from left margin.
4263 When the `track-eol' feature is doing its job, the value is
4264 `most-positive-fixnum'.")
4266 (defcustom line-move-ignore-invisible t
4268 Outline mode sets this."
4269 :type 'boolean
4270 :group 'editing-basics)
4272 (defcustom line-move-visual t
4273 "When non-nil, `line-move' moves point by visual lines.
4274 This movement is based on where the cursor is displayed on the
4275 screen, instead of relying on buffer contents alone. It takes
4276 into account variable-width characters and line continuation.
4277 If nil, `line-move' moves point by logical lines.
4278 A non-nil setting of `goal-column' overrides the value of this variable
4279 and forces movement by logical lines.
4280 Disabling `auto-hscroll-mode' also overrides forces movement by logical
4281 lines when the window is horizontally scrolled."
4282 :type 'boolean
4283 :group 'editing-basics
4284 :version "23.1")
4286 ;; Returns non-nil if partial move was done.
4287 (defun line-move-partial (arg noerror to-end)
4288 (if (< arg 0)
4289 ;; Move backward (up).
4290 ;; If already vscrolled, reduce vscroll
4291 (let ((vs (window-vscroll nil t)))
4292 (when (> vs (frame-char-height))
4293 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4295 ;; Move forward (down).
4296 (let* ((lh (window-line-height -1))
4297 (vpos (nth 1 lh))
4298 (ypos (nth 2 lh))
4299 (rbot (nth 3 lh))
4300 py vs)
4301 (when (or (null lh)
4302 (>= rbot (frame-char-height))
4303 (<= ypos (- (frame-char-height))))
4304 (unless lh
4305 (let ((wend (pos-visible-in-window-p t nil t)))
4306 (setq rbot (nth 3 wend)
4307 vpos (nth 5 wend))))
4308 (cond
4309 ;; If last line of window is fully visible, move forward.
4310 ((or (null rbot) (= rbot 0))
4311 nil)
4312 ;; If cursor is not in the bottom scroll margin, move forward.
4313 ((and (> vpos 0)
4314 (< (setq py
4315 (or (nth 1 (window-line-height))
4316 (let ((ppos (posn-at-point)))
4317 (cdr (or (posn-actual-col-row ppos)
4318 (posn-col-row ppos))))))
4319 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4320 nil)
4321 ;; When already vscrolled, we vscroll some more if we can,
4322 ;; or clear vscroll and move forward at end of tall image.
4323 ((> (setq vs (window-vscroll nil t)) 0)
4324 (when (> rbot 0)
4325 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4326 ;; If cursor just entered the bottom scroll margin, move forward,
4327 ;; but also vscroll one line so redisplay won't recenter.
4328 ((and (> vpos 0)
4329 (= py (min (- (window-text-height) scroll-margin 1)
4330 (1- vpos))))
4331 (set-window-vscroll nil (frame-char-height) t)
4332 (line-move-1 arg noerror to-end)
4333 t)
4334 ;; If there are lines above the last line, scroll-up one line.
4335 ((> vpos 0)
4336 (scroll-up 1)
4337 t)
4338 ;; Finally, start vscroll.
4339 (t
4340 (set-window-vscroll nil (frame-char-height) t)))))))
4343 ;; This is like line-move-1 except that it also performs
4344 ;; vertical scrolling of tall images if appropriate.
4345 ;; That is not really a clean thing to do, since it mixes
4346 ;; scrolling with cursor motion. But so far we don't have
4347 ;; a cleaner solution to the problem of making C-n do something
4348 ;; useful given a tall image.
4349 (defun line-move (arg &optional noerror to-end try-vscroll)
4350 (unless (and auto-window-vscroll try-vscroll
4351 ;; Only vscroll for single line moves
4352 (= (abs arg) 1)
4353 ;; But don't vscroll in a keyboard macro.
4354 (not defining-kbd-macro)
4355 (not executing-kbd-macro)
4356 (line-move-partial arg noerror to-end))
4357 (set-window-vscroll nil 0 t)
4358 (if (and line-move-visual
4359 ;; Display-based column are incompatible with goal-column.
4360 (not goal-column)
4361 ;; When auto-hscroll-mode is turned off and the text in
4362 ;; the window is scrolled to the left, display-based
4363 ;; motion doesn't make sense (because each logical line
4364 ;; occupies exactly one screen line).
4365 (not (and (null auto-hscroll-mode)
4366 (> (window-hscroll) 0))))
4367 (line-move-visual arg noerror)
4368 (line-move-1 arg noerror to-end))))
4370 ;; Display-based alternative to line-move-1.
4371 ;; Arg says how many lines to move. The value is t if we can move the
4372 ;; specified number of lines.
4373 (defun line-move-visual (arg &optional noerror)
4374 (let ((opoint (point))
4375 (hscroll (window-hscroll))
4376 target-hscroll)
4377 ;; Check if the previous command was a line-motion command, or if
4378 ;; we were called from some other command.
4379 (if (and (consp temporary-goal-column)
4380 (memq last-command `(next-line previous-line ,this-command)))
4381 ;; If so, there's no need to reset `temporary-goal-column',
4382 ;; but we may need to hscroll.
4383 (if (or (/= (cdr temporary-goal-column) hscroll)
4384 (> (cdr temporary-goal-column) 0))
4385 (setq target-hscroll (cdr temporary-goal-column)))
4386 ;; Otherwise, we should reset `temporary-goal-column'.
4387 (let ((posn (posn-at-point)))
4388 (cond
4389 ;; Handle the `overflow-newline-into-fringe' case:
4390 ((eq (nth 1 posn) 'right-fringe)
4391 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4392 ((car (posn-x-y posn))
4393 (setq temporary-goal-column
4394 (cons (/ (float (car (posn-x-y posn)))
4395 (frame-char-width)) hscroll))))))
4396 (if target-hscroll
4397 (set-window-hscroll (selected-window) target-hscroll))
4398 (or (and (= (vertical-motion
4399 (cons (or goal-column
4400 (if (consp temporary-goal-column)
4401 (car temporary-goal-column)
4402 temporary-goal-column))
4403 arg))
4404 arg)
4405 (or (>= arg 0)
4406 (/= (point) opoint)
4407 ;; If the goal column lies on a display string,
4408 ;; `vertical-motion' advances the cursor to the end
4409 ;; of the string. For arg < 0, this can cause the
4410 ;; cursor to get stuck. (Bug#3020).
4411 (= (vertical-motion arg) arg)))
4412 (unless noerror
4413 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4414 nil)))))
4416 ;; This is the guts of next-line and previous-line.
4417 ;; Arg says how many lines to move.
4418 ;; The value is t if we can move the specified number of lines.
4419 (defun line-move-1 (arg &optional noerror _to-end)
4420 ;; Don't run any point-motion hooks, and disregard intangibility,
4421 ;; for intermediate positions.
4422 (let ((inhibit-point-motion-hooks t)
4423 (opoint (point))
4424 (orig-arg arg))
4425 (if (consp temporary-goal-column)
4426 (setq temporary-goal-column (+ (car temporary-goal-column)
4427 (cdr temporary-goal-column))))
4428 (unwind-protect
4429 (progn
4430 (if (not (memq last-command '(next-line previous-line)))
4431 (setq temporary-goal-column
4432 (if (and track-eol (eolp)
4433 ;; Don't count beg of empty line as end of line
4434 ;; unless we just did explicit end-of-line.
4435 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4436 most-positive-fixnum
4437 (current-column))))
4439 (if (not (or (integerp selective-display)
4440 line-move-ignore-invisible))
4441 ;; Use just newline characters.
4442 ;; Set ARG to 0 if we move as many lines as requested.
4443 (or (if (> arg 0)
4444 (progn (if (> arg 1) (forward-line (1- arg)))
4445 ;; This way of moving forward ARG lines
4446 ;; verifies that we have a newline after the last one.
4447 ;; It doesn't get confused by intangible text.
4448 (end-of-line)
4449 (if (zerop (forward-line 1))
4450 (setq arg 0)))
4451 (and (zerop (forward-line arg))
4452 (bolp)
4453 (setq arg 0)))
4454 (unless noerror
4455 (signal (if (< arg 0)
4456 'beginning-of-buffer
4457 'end-of-buffer)
4458 nil)))
4459 ;; Move by arg lines, but ignore invisible ones.
4460 (let (done)
4461 (while (and (> arg 0) (not done))
4462 ;; If the following character is currently invisible,
4463 ;; skip all characters with that same `invisible' property value.
4464 (while (and (not (eobp)) (invisible-p (point)))
4465 (goto-char (next-char-property-change (point))))
4466 ;; Move a line.
4467 ;; We don't use `end-of-line', since we want to escape
4468 ;; from field boundaries occurring exactly at point.
4469 (goto-char (constrain-to-field
4470 (let ((inhibit-field-text-motion t))
4471 (line-end-position))
4472 (point) t t
4473 'inhibit-line-move-field-capture))
4474 ;; If there's no invisibility here, move over the newline.
4475 (cond
4476 ((eobp)
4477 (if (not noerror)
4478 (signal 'end-of-buffer nil)
4479 (setq done t)))
4480 ((and (> arg 1) ;; Use vertical-motion for last move
4481 (not (integerp selective-display))
4482 (not (invisible-p (point))))
4483 ;; We avoid vertical-motion when possible
4484 ;; because that has to fontify.
4485 (forward-line 1))
4486 ;; Otherwise move a more sophisticated way.
4487 ((zerop (vertical-motion 1))
4488 (if (not noerror)
4489 (signal 'end-of-buffer nil)
4490 (setq done t))))
4491 (unless done
4492 (setq arg (1- arg))))
4493 ;; The logic of this is the same as the loop above,
4494 ;; it just goes in the other direction.
4495 (while (and (< arg 0) (not done))
4496 ;; For completely consistency with the forward-motion
4497 ;; case, we should call beginning-of-line here.
4498 ;; However, if point is inside a field and on a
4499 ;; continued line, the call to (vertical-motion -1)
4500 ;; below won't move us back far enough; then we return
4501 ;; to the same column in line-move-finish, and point
4502 ;; gets stuck -- cyd
4503 (forward-line 0)
4504 (cond
4505 ((bobp)
4506 (if (not noerror)
4507 (signal 'beginning-of-buffer nil)
4508 (setq done t)))
4509 ((and (< arg -1) ;; Use vertical-motion for last move
4510 (not (integerp selective-display))
4511 (not (invisible-p (1- (point)))))
4512 (forward-line -1))
4513 ((zerop (vertical-motion -1))
4514 (if (not noerror)
4515 (signal 'beginning-of-buffer nil)
4516 (setq done t))))
4517 (unless done
4518 (setq arg (1+ arg))
4519 (while (and ;; Don't move over previous invis lines
4520 ;; if our target is the middle of this line.
4521 (or (zerop (or goal-column temporary-goal-column))
4522 (< arg 0))
4523 (not (bobp)) (invisible-p (1- (point))))
4524 (goto-char (previous-char-property-change (point))))))))
4525 ;; This is the value the function returns.
4526 (= arg 0))
4528 (cond ((> arg 0)
4529 ;; If we did not move down as far as desired, at least go
4530 ;; to end of line. Be sure to call point-entered and
4531 ;; point-left-hooks.
4532 (let* ((npoint (prog1 (line-end-position)
4533 (goto-char opoint)))
4534 (inhibit-point-motion-hooks nil))
4535 (goto-char npoint)))
4536 ((< arg 0)
4537 ;; If we did not move up as far as desired,
4538 ;; at least go to beginning of line.
4539 (let* ((npoint (prog1 (line-beginning-position)
4540 (goto-char opoint)))
4541 (inhibit-point-motion-hooks nil))
4542 (goto-char npoint)))
4543 (t
4544 (line-move-finish (or goal-column temporary-goal-column)
4545 opoint (> orig-arg 0)))))))
4547 (defun line-move-finish (column opoint forward)
4548 (let ((repeat t))
4549 (while repeat
4550 ;; Set REPEAT to t to repeat the whole thing.
4551 (setq repeat nil)
4553 (let (new
4554 (old (point))
4555 (line-beg (line-beginning-position))
4556 (line-end
4557 ;; Compute the end of the line
4558 ;; ignoring effectively invisible newlines.
4559 (save-excursion
4560 ;; Like end-of-line but ignores fields.
4562 (while (and (not (eobp)) (invisible-p (point)))
4563 (goto-char (next-char-property-change (point)))
4565 (point))))
4567 ;; Move to the desired column.
4568 (line-move-to-column (truncate column))
4570 ;; Corner case: suppose we start out in a field boundary in
4571 ;; the middle of a continued line. When we get to
4572 ;; line-move-finish, point is at the start of a new *screen*
4573 ;; line but the same text line; then line-move-to-column would
4574 ;; move us backwards. Test using C-n with point on the "x" in
4575 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4576 (and forward
4577 (< (point) old)
4578 (goto-char old))
4580 (setq new (point))
4582 ;; Process intangibility within a line.
4583 ;; With inhibit-point-motion-hooks bound to nil, a call to
4584 ;; goto-char moves point past intangible text.
4586 ;; However, inhibit-point-motion-hooks controls both the
4587 ;; intangibility and the point-entered/point-left hooks. The
4588 ;; following hack avoids calling the point-* hooks
4589 ;; unnecessarily. Note that we move *forward* past intangible
4590 ;; text when the initial and final points are the same.
4591 (goto-char new)
4592 (let ((inhibit-point-motion-hooks nil))
4593 (goto-char new)
4595 ;; If intangibility moves us to a different (later) place
4596 ;; in the same line, use that as the destination.
4597 (if (<= (point) line-end)
4598 (setq new (point))
4599 ;; If that position is "too late",
4600 ;; try the previous allowable position.
4601 ;; See if it is ok.
4602 (backward-char)
4603 (if (if forward
4604 ;; If going forward, don't accept the previous
4605 ;; allowable position if it is before the target line.
4606 (< line-beg (point))
4607 ;; If going backward, don't accept the previous
4608 ;; allowable position if it is still after the target line.
4609 (<= (point) line-end))
4610 (setq new (point))
4611 ;; As a last resort, use the end of the line.
4612 (setq new line-end))))
4614 ;; Now move to the updated destination, processing fields
4615 ;; as well as intangibility.
4616 (goto-char opoint)
4617 (let ((inhibit-point-motion-hooks nil))
4618 (goto-char
4619 ;; Ignore field boundaries if the initial and final
4620 ;; positions have the same `field' property, even if the
4621 ;; fields are non-contiguous. This seems to be "nicer"
4622 ;; behavior in many situations.
4623 (if (eq (get-char-property new 'field)
4624 (get-char-property opoint 'field))
4625 new
4626 (constrain-to-field new opoint t t
4627 'inhibit-line-move-field-capture))))
4629 ;; If all this moved us to a different line,
4630 ;; retry everything within that new line.
4631 (when (or (< (point) line-beg) (> (point) line-end))
4632 ;; Repeat the intangibility and field processing.
4633 (setq repeat t))))))
4635 (defun line-move-to-column (col)
4636 "Try to find column COL, considering invisibility.
4637 This function works only in certain cases,
4638 because what we really need is for `move-to-column'
4639 and `current-column' to be able to ignore invisible text."
4640 (if (zerop col)
4641 (beginning-of-line)
4642 (move-to-column col))
4644 (when (and line-move-ignore-invisible
4645 (not (bolp)) (invisible-p (1- (point))))
4646 (let ((normal-location (point))
4647 (normal-column (current-column)))
4648 ;; If the following character is currently invisible,
4649 ;; skip all characters with that same `invisible' property value.
4650 (while (and (not (eobp))
4651 (invisible-p (point)))
4652 (goto-char (next-char-property-change (point))))
4653 ;; Have we advanced to a larger column position?
4654 (if (> (current-column) normal-column)
4655 ;; We have made some progress towards the desired column.
4656 ;; See if we can make any further progress.
4657 (line-move-to-column (+ (current-column) (- col normal-column)))
4658 ;; Otherwise, go to the place we originally found
4659 ;; and move back over invisible text.
4660 ;; that will get us to the same place on the screen
4661 ;; but with a more reasonable buffer position.
4662 (goto-char normal-location)
4663 (let ((line-beg (line-beginning-position)))
4664 (while (and (not (bolp)) (invisible-p (1- (point))))
4665 (goto-char (previous-char-property-change (point) line-beg))))))))
4667 (defun move-end-of-line (arg)
4668 "Move point to end of current line as displayed.
4669 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4670 If point reaches the beginning or end of buffer, it stops there.
4672 To ignore the effects of the `intangible' text or overlay
4673 property, bind `inhibit-point-motion-hooks' to t.
4674 If there is an image in the current line, this function
4675 disregards newlines that are part of the text on which the image
4676 rests."
4677 (interactive "^p")
4678 (or arg (setq arg 1))
4679 (let (done)
4680 (while (not done)
4681 (let ((newpos
4682 (save-excursion
4683 (let ((goal-column 0)
4684 (line-move-visual nil))
4685 (and (line-move arg t)
4686 ;; With bidi reordering, we may not be at bol,
4687 ;; so make sure we are.
4689 (not (bobp))
4690 (progn
4691 (while (and (not (bobp)) (invisible-p (1- (point))))
4692 (goto-char (previous-single-char-property-change
4693 (point) 'invisible)))
4694 (backward-char 1)))
4695 (point)))))
4696 (goto-char newpos)
4697 (if (and (> (point) newpos)
4699 (backward-char 1)
4700 (if (and (> (point) newpos) (not (eobp))
4702 ;; If we skipped something intangible and now we're not
4703 ;; really at eol, keep going.
4704 (setq arg 1)
4705 (setq done t)))))))
4707 (defun move-beginning-of-line (arg)
4708 "Move point to beginning of current line as displayed.
4709 \(If there's an image in the line, this disregards newlines
4710 which are part of the text that the image rests on.)
4712 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4713 If point reaches the beginning or end of buffer, it stops there.
4714 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4715 (interactive "^p")
4716 (or arg (setq arg 1))
4718 (let ((orig (point))
4719 first-vis first-vis-field-value)
4721 ;; Move by lines, if ARG is not 1 (the default).
4722 (if (/= arg 1)
4723 (let ((line-move-visual nil))
4724 (line-move (1- arg) t)))
4726 ;; Move to beginning-of-line, ignoring fields and invisibles.
4728 (while (and (not (bobp)) (invisible-p (1- (point))))
4729 (goto-char (previous-char-property-change (point)))
4732 ;; Now find first visible char in the line
4733 (while (and (not (eobp)) (invisible-p (point)))
4734 (goto-char (next-char-property-change (point))))
4735 (setq first-vis (point))
4737 ;; See if fields would stop us from reaching FIRST-VIS.
4738 (setq first-vis-field-value
4739 (constrain-to-field first-vis orig (/= arg 1) t nil))
4741 (goto-char (if (/= first-vis-field-value first-vis)
4742 ;; If yes, obey them.
4743 first-vis-field-value
4744 ;; Otherwise, move to START with attention to fields.
4745 ;; (It is possible that fields never matter in this case.)
4746 (constrain-to-field (point) orig
4747 (/= arg 1) t nil)))))
4750 ;; Many people have said they rarely use this feature, and often type
4751 ;; it by accident. Maybe it shouldn't even be on a key.
4752 (put 'set-goal-column 'disabled t)
4754 (defun set-goal-column (arg)
4756 Those commands will move to this position in the line moved to
4757 rather than trying to keep the same horizontal position.
4758 With a non-nil argument ARG, clears out the goal column
4760 The goal column is stored in the variable `goal-column'."
4761 (interactive "P")
4762 (if arg
4763 (progn
4764 (setq goal-column nil)
4765 (message "No goal column"))
4766 (setq goal-column (current-column))
4767 ;; The older method below can be erroneous if `set-goal-column' is bound
4768 ;; to a sequence containing %
4769 ;;(message (substitute-command-keys
4771 ;;goal-column)
4772 (message "%s"
4773 (concat
4774 (format "Goal column %d " goal-column)
4775 (substitute-command-keys
4778 )
4779 nil)
4780 \f
4781 ;;; Editing based on visual lines, as opposed to logical lines.
4783 (defun end-of-visual-line (&optional n)
4784 "Move point to end of current visual line.
4785 With argument N not nil or 1, move forward N - 1 visual lines first.
4786 If point reaches the beginning or end of buffer, it stops there.
4787 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4788 (interactive "^p")
4789 (or n (setq n 1))
4790 (if (/= n 1)
4791 (let ((line-move-visual t))
4792 (line-move (1- n) t)))
4793 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4794 ;; constrain to field boundaries, so we don't either.
4795 (vertical-motion (cons (window-width) 0)))
4797 (defun beginning-of-visual-line (&optional n)
4798 "Move point to beginning of current visual line.
4799 With argument N not nil or 1, move forward N - 1 visual lines first.
4800 If point reaches the beginning or end of buffer, it stops there.
4801 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4802 (interactive "^p")
4803 (or n (setq n 1))
4804 (let ((opoint (point)))
4805 (if (/= n 1)
4806 (let ((line-move-visual t))
4807 (line-move (1- n) t)))
4808 (vertical-motion 0)
4809 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4810 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4812 (defun kill-visual-line (&optional arg)
4813 "Kill the rest of the visual line.
4814 With prefix argument ARG, kill that many visual lines from point.
4815 If ARG is negative, kill visual lines backward.
4816 If ARG is zero, kill the text before point on the current visual
4817 line.
4819 If you want to append the killed line to the last killed text,
4822 If the buffer is read-only, Emacs will beep and refrain from deleting
4823 the line, but put the line in the kill ring anyway. This means that
4824 you can use this command to copy text from a read-only buffer.
4825 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4826 even beep.)"
4827 (interactive "P")
4828 ;; Like in `kill-line', it's better to move point to the other end
4829 ;; of the kill before killing.
4830 (let ((opoint (point))
4831 (kill-whole-line (and kill-whole-line (bolp))))
4832 (if arg
4833 (vertical-motion (prefix-numeric-value arg))
4834 (end-of-visual-line 1)
4835 (if (= (point) opoint)
4836 (vertical-motion 1)
4837 ;; Skip any trailing whitespace at the end of the visual line.
4838 ;; We used to do this only if `show-trailing-whitespace' is
4839 ;; nil, but that's wrong; the correct thing would be to check
4840 ;; whether the trailing whitespace is highlighted. But, it's
4841 ;; OK to just do this unconditionally.
4844 (1+ (point))
4845 (point)))))
4847 (defun next-logical-line (&optional arg try-vscroll)
4848 "Move cursor vertically down ARG lines.
4849 This is identical to `next-line', except that it always moves
4850 by logical lines instead of visual lines, ignoring the value of
4851 the variable `line-move-visual'."
4853 (let ((line-move-visual nil))
4854 (with-no-warnings
4855 (next-line arg try-vscroll))))
4857 (defun previous-logical-line (&optional arg try-vscroll)
4858 "Move cursor vertically up ARG lines.
4859 This is identical to `previous-line', except that it always moves
4860 by logical lines instead of visual lines, ignoring the value of
4861 the variable `line-move-visual'."
4863 (let ((line-move-visual nil))
4864 (with-no-warnings
4865 (previous-line arg try-vscroll))))
4867 (defgroup visual-line nil
4868 "Editing based on visual lines."
4869 :group 'convenience
4870 :version "23.1")
4872 (defvar visual-line-mode-map
4873 (let ((map (make-sparse-keymap)))
4874 (define-key map [remap kill-line] 'kill-visual-line)
4875 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4876 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4877 ;; These keybindings interfere with xterm function keys. Are
4878 ;; there any other suitable bindings?
4879 ;; (define-key map "\M-[" 'previous-logical-line)
4880 ;; (define-key map "\M-]" 'next-logical-line)
4881 map))
4883 (defcustom visual-line-fringe-indicators '(nil nil)
4884 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4885 The value should be a list of the form (LEFT RIGHT), where LEFT
4886 and RIGHT are symbols representing the bitmaps to display, to
4887 indicate wrapped lines, in the left and right fringes respectively.
4888 See also `fringe-indicator-alist'.
4889 The default is not to display fringe indicators for wrapped lines.
4890 This variable does not affect fringe indicators displayed for
4891 other purposes."
4892 :type '(list (choice (const :tag "Hide left indicator" nil)
4893 (const :tag "Left curly arrow" left-curly-arrow)
4894 (symbol :tag "Other bitmap"))
4895 (choice (const :tag "Hide right indicator" nil)
4896 (const :tag "Right curly arrow" right-curly-arrow)
4897 (symbol :tag "Other bitmap")))
4898 :set (lambda (symbol value)
4899 (dolist (buf (buffer-list))
4900 (with-current-buffer buf
4901 (when (and (boundp 'visual-line-mode)
4902 (symbol-value 'visual-line-mode))
4903 (setq fringe-indicator-alist
4904 (cons (cons 'continuation value)
4905 (assq-delete-all
4906 'continuation
4907 (copy-tree fringe-indicator-alist)))))))
4908 (set-default symbol value)))
4910 (defvar visual-line--saved-state nil)
4912 (define-minor-mode visual-line-mode
4913 "Toggle visual line based editing (Visual Line mode).
4914 With a prefix argument ARG, enable Visual Line mode if ARG is
4915 positive, and disable it otherwise. If called from Lisp, enable
4916 the mode if ARG is omitted or nil.
4918 When Visual Line mode is enabled, `word-wrap' is turned on in
4919 this buffer, and simple editing commands are redefined to act on
4920 visual lines, not logical lines. See Info node `Visual Line
4921 Mode' for details."
4922 :keymap visual-line-mode-map
4923 :group 'visual-line
4924 :lighter " Wrap"
4925 (if visual-line-mode
4926 (progn
4927 (set (make-local-variable 'visual-line--saved-state) nil)
4928 ;; Save the local values of some variables, to be restored if
4929 ;; visual-line-mode is turned off.
4930 (dolist (var '(line-move-visual truncate-lines
4931 truncate-partial-width-windows
4932 word-wrap fringe-indicator-alist))
4933 (if (local-variable-p var)
4934 (push (cons var (symbol-value var))
4935 visual-line--saved-state)))
4936 (set (make-local-variable 'line-move-visual) t)
4937 (set (make-local-variable 'truncate-partial-width-windows) nil)
4938 (setq truncate-lines nil
4939 word-wrap t
4940 fringe-indicator-alist
4941 (cons (cons 'continuation visual-line-fringe-indicators)
4942 fringe-indicator-alist)))
4943 (kill-local-variable 'line-move-visual)
4944 (kill-local-variable 'word-wrap)
4945 (kill-local-variable 'truncate-lines)
4946 (kill-local-variable 'truncate-partial-width-windows)
4947 (kill-local-variable 'fringe-indicator-alist)
4948 (dolist (saved visual-line--saved-state)
4949 (set (make-local-variable (car saved)) (cdr saved)))
4950 (kill-local-variable 'visual-line--saved-state)))
4952 (defun turn-on-visual-line-mode ()
4953 (visual-line-mode 1))
4955 (define-globalized-minor-mode global-visual-line-mode
4956 visual-line-mode turn-on-visual-line-mode
4957 :lighter " vl")
4959 \f
4960 (defun transpose-chars (arg)
4961 "Interchange characters around point, moving forward one character.
4962 With prefix arg ARG, effect is to take character before point
4963 and drag it forward past ARG other characters (backward if ARG negative).
4964 If no argument and at end of line, the previous two chars are exchanged."
4965 (interactive "*P")
4966 (and (null arg) (eolp) (forward-char -1))
4967 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4969 (defun transpose-words (arg)
4970 "Interchange words around point, leaving point at end of them.
4971 With prefix arg ARG, effect is to take word before or around point
4972 and drag it forward past ARG other words (backward if ARG negative).
4973 If ARG is zero, the words around or after point and around or after mark
4974 are interchanged."
4975 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4976 (interactive "*p")
4977 (transpose-subr 'forward-word arg))
4979 (defun transpose-sexps (arg)
4981 Does not work on a sexp that point is in the middle of
4982 if it is a list or string."
4983 (interactive "*p")
4984 (transpose-subr
4985 (lambda (arg)
4986 ;; Here we should try to simulate the behavior of
4987 ;; (cons (progn (forward-sexp x) (point))
4988 ;; (progn (forward-sexp (- x)) (point)))
4989 ;; Except that we don't want to rely on the second forward-sexp
4990 ;; putting us back to where we want to be, since forward-sexp-function
4991 ;; might do funny things like infix-precedence.
4992 (if (if (> arg 0)
4994 (and (not (bobp))
4996 ;; Jumping over a symbol. We might be inside it, mind you.
4997 (progn (funcall (if (> arg 0)
4998 'skip-syntax-backward 'skip-syntax-forward)
4999 "w_")
5000 (cons (save-excursion (forward-sexp arg) (point)) (point)))
5001 ;; Otherwise, we're between sexps. Take a step back before jumping
5002 ;; to make sure we'll obey the same precedence no matter which direction
5003 ;; we're going.
5004 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
5005 (cons (save-excursion (forward-sexp arg) (point))
5006 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
5007 (not (zerop (funcall (if (> arg 0)
5008 'skip-syntax-forward
5009 'skip-syntax-backward)
5010 ".")))))
5011 (point)))))
5012 arg 'special))
5014 (defun transpose-lines (arg)
5015 "Exchange current line and previous line, leaving point after both.
5016 With argument ARG, takes previous line and moves it past ARG lines.
5017 With argument 0, interchanges line point is in with line mark is in."
5018 (interactive "*p")
5019 (transpose-subr (function
5020 (lambda (arg)
5021 (if (> arg 0)
5022 (progn
5023 ;; Move forward over ARG lines,
5024 ;; but create newlines if necessary.
5025 (setq arg (forward-line arg))
5027 (setq arg (1+ arg)))
5028 (if (> arg 0)
5029 (newline arg)))
5030 (forward-line arg))))
5031 arg))
5033 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5034 ;; which seems inconsistent with the ARG /= 0 case.
5035 ;; FIXME document SPECIAL.
5036 (defun transpose-subr (mover arg &optional special)
5037 "Subroutine to do the work of transposing objects.
5038 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5039 moves forward by units of the given object (e.g. forward-sentence,
5040 forward-paragraph). If ARG is zero, exchanges the current object
5041 with the one containing mark. If ARG is an integer, moves the
5042 current object past ARG following (if ARG is positive) or
5043 preceding (if ARG is negative) objects, leaving point after the
5044 current object."
5045 (let ((aux (if special mover
5046 (lambda (x)
5047 (cons (progn (funcall mover x) (point))
5048 (progn (funcall mover (- x)) (point))))))
5049 pos1 pos2)
5050 (cond
5051 ((= arg 0)
5052 (save-excursion
5053 (setq pos1 (funcall aux 1))
5054 (goto-char (or (mark) (error "No mark set in this buffer")))
5055 (setq pos2 (funcall aux 1))
5056 (transpose-subr-1 pos1 pos2))
5057 (exchange-point-and-mark))
5058 ((> arg 0)
5059 (setq pos1 (funcall aux -1))
5060 (setq pos2 (funcall aux arg))
5061 (transpose-subr-1 pos1 pos2)
5062 (goto-char (car pos2)))
5063 (t
5064 (setq pos1 (funcall aux -1))
5065 (goto-char (car pos1))
5066 (setq pos2 (funcall aux arg))
5067 (transpose-subr-1 pos1 pos2)))))
5069 (defun transpose-subr-1 (pos1 pos2)
5070 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5071 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5072 (when (> (car pos1) (car pos2))
5073 (let ((swap pos1))
5074 (setq pos1 pos2 pos2 swap)))
5075 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5076 (atomic-change-group
5077 (let (word2)
5078 ;; FIXME: We first delete the two pieces of text, so markers that
5079 ;; used to point to after the text end up pointing to before it :-(
5080 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5081 (goto-char (car pos2))
5082 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5083 (goto-char (car pos1))
5084 (insert word2))))
5085 \f
5086 (defun backward-word (&optional arg)
5087 "Move backward until encountering the beginning of a word.
5088 With argument ARG, do this that many times."
5089 (interactive "^p")
5090 (forward-word (- (or arg 1))))
5092 (defun mark-word (&optional arg allow-extend)
5093 "Set mark ARG words away from point.
5095 move to with the same argument.
5096 Interactively, if this command is repeated
5097 or (in Transient Mark mode) if the mark is active,
5098 it marks the next ARG words after the ones already marked."
5100 (cond ((and allow-extend
5101 (or (and (eq last-command this-command) (mark t))
5102 (region-active-p)))
5103 (setq arg (if arg (prefix-numeric-value arg)
5104 (if (< (mark) (point)) -1 1)))
5105 (set-mark
5106 (save-excursion
5107 (goto-char (mark))
5108 (forward-word arg)
5109 (point))))
5110 (t
5111 (push-mark
5112 (save-excursion
5113 (forward-word (prefix-numeric-value arg))
5114 (point))
5115 nil t))))
5117 (defun kill-word (arg)
5118 "Kill characters forward until encountering the end of a word.
5119 With argument ARG, do this that many times."
5120 (interactive "p")
5121 (kill-region (point) (progn (forward-word arg) (point))))
5123 (defun backward-kill-word (arg)
5124 "Kill characters backward until encountering the beginning of a word.
5125 With argument ARG, do this that many times."
5126 (interactive "p")
5127 (kill-word (- arg)))
5129 (defun current-word (&optional strict really-word)
5130 "Return the symbol or word that point is on (or a nearby one) as a string.
5131 The return value includes no text properties.
5132 If optional arg STRICT is non-nil, return nil unless point is within
5133 or adjacent to a symbol or word. In all cases the value can be nil
5134 if there is no word nearby.
5135 The function, belying its name, normally finds a symbol.
5136 If optional arg REALLY-WORD is non-nil, it finds just a word."
5137 (save-excursion
5138 (let* ((oldpoint (point)) (start (point)) (end (point))
5139 (syntaxes (if really-word "w" "w_"))
5140 (not-syntaxes (concat "^" syntaxes)))
5141 (skip-syntax-backward syntaxes) (setq start (point))
5142 (goto-char oldpoint)
5143 (skip-syntax-forward syntaxes) (setq end (point))
5144 (when (and (eq start oldpoint) (eq end oldpoint)
5145 ;; Point is neither within nor adjacent to a word.
5146 (not strict))
5147 ;; Look for preceding word in same line.
5148 (skip-syntax-backward not-syntaxes (line-beginning-position))
5149 (if (bolp)
5150 ;; No preceding word in same line.
5151 ;; Look for following word in same line.
5152 (progn
5153 (skip-syntax-forward not-syntaxes (line-end-position))
5154 (setq start (point))
5155 (skip-syntax-forward syntaxes)
5156 (setq end (point)))
5157 (setq end (point))
5158 (skip-syntax-backward syntaxes)
5159 (setq start (point))))
5160 ;; If we found something nonempty, return it as a string.
5161 (unless (= start end)
5162 (buffer-substring-no-properties start end)))))
5163 \f
5164 (defcustom fill-prefix nil
5165 "String for filling to insert at front of new line, or nil for none."
5166 :type '(choice (const :tag "None" nil)
5167 string)
5168 :group 'fill)
5169 (make-variable-buffer-local 'fill-prefix)
5170 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5172 (defcustom auto-fill-inhibit-regexp nil
5173 "Regexp to match lines which should not be auto-filled."
5174 :type '(choice (const :tag "None" nil)
5175 regexp)
5176 :group 'fill)
5178 (defun do-auto-fill ()
5179 "The default value for `normal-auto-fill-function'.
5180 This is the default auto-fill function, some major modes use a different one.
5181 Returns t if it really did any work."
5182 (let (fc justify give-up
5183 (fill-prefix fill-prefix))
5184 (if (or (not (setq justify (current-justification)))
5185 (null (setq fc (current-fill-column)))
5186 (and (eq justify 'left)
5187 (<= (current-column) fc))
5188 (and auto-fill-inhibit-regexp
5189 (save-excursion (beginning-of-line)
5190 (looking-at auto-fill-inhibit-regexp))))
5191 nil ;; Auto-filling not required
5192 (if (memq justify '(full center right))
5193 (save-excursion (unjustify-current-line)))
5195 ;; Choose a fill-prefix automatically.
5196 (when (and adaptive-fill-mode
5197 (or (null fill-prefix) (string= fill-prefix "")))
5198 (let ((prefix
5199 (fill-context-prefix
5200 (save-excursion (fill-forward-paragraph -1) (point))
5201 (save-excursion (fill-forward-paragraph 1) (point)))))
5202 (and prefix (not (equal prefix ""))
5203 ;; Use auto-indentation rather than a guessed empty prefix.
5204 (not (and fill-indent-according-to-mode
5206 (setq fill-prefix prefix))))
5208 (while (and (not give-up) (> (current-column) fc))
5209 ;; Determine where to split the line.
5210 (let* (after-prefix
5211 (fill-point
5212 (save-excursion
5213 (beginning-of-line)
5214 (setq after-prefix (point))
5215 (and fill-prefix
5216 (looking-at (regexp-quote fill-prefix))
5217 (setq after-prefix (match-end 0)))
5218 (move-to-column (1+ fc))
5219 (fill-move-to-break-point after-prefix)
5220 (point))))
5222 ;; See whether the place we found is any good.
5223 (if (save-excursion
5224 (goto-char fill-point)
5225 (or (bolp)
5226 ;; There is no use breaking at end of line.
5227 (save-excursion (skip-chars-forward " ") (eolp))
5228 ;; It is futile to split at the end of the prefix
5229 ;; since we would just insert the prefix again.
5230 (and after-prefix (<= (point) after-prefix))
5231 ;; Don't split right after a comment starter
5232 ;; since we would just make another comment starter.
5233 (and comment-start-skip
5234 (let ((limit (point)))
5235 (beginning-of-line)
5236 (and (re-search-forward comment-start-skip
5237 limit t)
5238 (eq (point) limit))))))
5239 ;; No good place to break => stop trying.
5240 (setq give-up t)
5241 ;; Ok, we have a useful place to break the line. Do it.
5242 (let ((prev-column (current-column)))
5243 ;; If point is at the fill-point, do not `save-excursion'.
5244 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5245 ;; point will end up before it rather than after it.
5246 (if (save-excursion
5248 (= (point) fill-point))
5249 (default-indent-new-line t)
5250 (save-excursion
5251 (goto-char fill-point)
5252 (default-indent-new-line t)))
5253 ;; Now do justification, if required
5254 (if (not (eq justify 'left))
5255 (save-excursion
5256 (end-of-line 0)
5257 (justify-current-line justify nil t)))
5258 ;; If making the new line didn't reduce the hpos of
5259 ;; the end of the line, then give up now;
5260 ;; trying again will not help.
5261 (if (>= (current-column) prev-column)
5262 (setq give-up t))))))
5263 ;; Justify last line.
5264 (justify-current-line justify t t)
5265 t)))
5267 (defvar comment-line-break-function 'comment-indent-new-line
5268 "*Mode-specific function which line breaks and continues a comment.
5269 This function is called during auto-filling when a comment syntax
5270 is defined.
5271 The function should take a single optional argument, which is a flag
5272 indicating whether it should use soft newlines.")
5274 (defun default-indent-new-line (&optional soft)
5275 "Break line at point and indent.
5276 If a comment syntax is defined, call `comment-indent-new-line'.
5278 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5279 unless optional argument SOFT is non-nil."
5280 (interactive)
5281 (if comment-start
5282 (funcall comment-line-break-function soft)
5283 ;; Insert the newline before removing empty space so that markers
5284 ;; get preserved better.
5286 (save-excursion (forward-char -1) (delete-horizontal-space))
5287 (delete-horizontal-space)
5289 (if (and fill-prefix (not adaptive-fill-mode))
5290 ;; Blindly trust a non-adaptive fill-prefix.
5291 (progn
5292 (indent-to-left-margin)
5293 (insert-before-markers-and-inherit fill-prefix))
5295 (cond
5296 ;; If there's an adaptive prefix, use it unless we're inside
5297 ;; a comment and the prefix is not a comment starter.
5298 (fill-prefix
5299 (indent-to-left-margin)
5300 (insert-and-inherit fill-prefix))
5301 ;; If we're not inside a comment, just try to indent.
5302 (t (indent-according-to-mode))))))
5304 (defvar normal-auto-fill-function 'do-auto-fill
5305 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5306 Some major modes set this.")
5308 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5309 ;; `functions' and `hooks' are usually unsafe to set, but setting
5310 ;; auto-fill-function to nil in a file-local setting is safe and
5311 ;; can be useful to prevent auto-filling.
5312 (put 'auto-fill-function 'safe-local-variable 'null)
5314 (define-minor-mode auto-fill-mode
5315 "Toggle automatic line breaking (Auto Fill mode).
5316 With a prefix argument ARG, enable Auto Fill mode if ARG is
5317 positive, and disable it otherwise. If called from Lisp, enable
5318 the mode if ARG is omitted or nil.
5320 When Auto Fill mode is enabled, inserting a space at a column
5321 beyond `current-fill-column' automatically breaks the line at a
5322 previous space.
5324 When `auto-fill-mode' is on, the `auto-fill-function' variable is
5325 non-`nil'.
5327 The value of `normal-auto-fill-function' specifies the function to use
5328 for `auto-fill-function' when turning Auto Fill mode on."
5329 :variable (eq auto-fill-function normal-auto-fill-function))
5331 ;; This holds a document string used to document auto-fill-mode.
5332 (defun auto-fill-function ()
5333 "Automatically break line at a previous space, in insertion of text."
5334 nil)
5336 (defun turn-on-auto-fill ()
5337 "Unconditionally turn on Auto Fill mode."
5338 (auto-fill-mode 1))
5340 (defun turn-off-auto-fill ()
5341 "Unconditionally turn off Auto Fill mode."
5342 (auto-fill-mode -1))
5344 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5346 (defun set-fill-column (arg)
5347 "Set `fill-column' to specified argument.
5350 (interactive
5351 (list (or current-prefix-arg
5352 ;; We used to use current-column silently, but C-x f is too easily
5353 ;; typed as a typo for C-x C-f, so we turned it into an error and
5354 ;; now an interactive prompt.
5355 (read-number "Set fill-column to: " (current-column)))))
5356 (if (consp arg)
5357 (setq arg (current-column)))
5358 (if (not (integerp arg))
5359 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5360 (error "set-fill-column requires an explicit argument")
5361 (message "Fill column set to %d (was %d)" arg fill-column)
5362 (setq fill-column arg)))
5363 \f
5364 (defun set-selective-display (arg)
5365 "Set `selective-display' to ARG; clear it if no arg.
5366 When the value of `selective-display' is a number > 0,
5367 lines whose indentation is >= that value are not displayed.
5368 The variable `selective-display' has a separate value for each buffer."
5369 (interactive "P")
5370 (if (eq selective-display t)
5371 (error "selective-display already in use for marked lines"))
5372 (let ((current-vpos
5373 (save-restriction
5374 (narrow-to-region (point-min) (point))
5375 (goto-char (window-start))
5376 (vertical-motion (window-height)))))
5377 (setq selective-display
5378 (and arg (prefix-numeric-value arg)))
5379 (recenter current-vpos))
5380 (set-window-start (selected-window) (window-start (selected-window)))
5381 (princ "selective-display set to " t)
5382 (prin1 selective-display t)
5383 (princ "." t))
5385 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5387 (defun toggle-truncate-lines (&optional arg)
5388 "Toggle truncating of long lines for the current buffer.
5389 When truncating is off, long lines are folded.
5390 With prefix argument ARG, truncate long lines if ARG is positive,
5391 otherwise fold them. Note that in side-by-side windows, this
5392 command has no effect if `truncate-partial-width-windows' is
5393 non-nil."
5394 (interactive "P")
5395 (setq truncate-lines
5396 (if (null arg)
5397 (not truncate-lines)
5398 (> (prefix-numeric-value arg) 0)))
5399 (force-mode-line-update)
5400 (unless truncate-lines
5401 (let ((buffer (current-buffer)))
5402 (walk-windows (lambda (window)
5403 (if (eq buffer (window-buffer window))
5404 (set-window-hscroll window 0)))
5405 nil t)))
5406 (message "Truncate long lines %s"
5407 (if truncate-lines "enabled" "disabled")))
5409 (defun toggle-word-wrap (&optional arg)
5410 "Toggle whether to use word-wrapping for continuation lines.
5411 With prefix argument ARG, wrap continuation lines at word boundaries
5412 if ARG is positive, otherwise wrap them at the right screen edge.
5413 This command toggles the value of `word-wrap'. It has no effect
5414 if long lines are truncated."
5415 (interactive "P")
5416 (setq word-wrap
5417 (if (null arg)
5418 (not word-wrap)
5419 (> (prefix-numeric-value arg) 0)))
5420 (force-mode-line-update)
5421 (message "Word wrapping %s"
5422 (if word-wrap "enabled" "disabled")))
5424 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5425 "The string displayed in the mode line when in overwrite mode.")
5426 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5427 "The string displayed in the mode line when in binary overwrite mode.")
5429 (define-minor-mode overwrite-mode
5430 "Toggle Overwrite mode.
5431 With a prefix argument ARG, enable Overwrite mode if ARG is
5432 positive, and disable it otherwise. If called from Lisp, enable
5433 the mode if ARG is omitted or nil.
5435 When Overwrite mode is enabled, printing characters typed in
5436 replace existing text on a one-for-one basis, rather than pushing
5437 it to the right. At the end of a line, such characters extend
5438 the line. Before a tab, such characters insert until the tab is
5440 overwrite mode; this is supposed to make it easier to insert
5441 characters when necessary."
5442 :variable (eq overwrite-mode 'overwrite-mode-textual))
5444 (define-minor-mode binary-overwrite-mode
5445 "Toggle Binary Overwrite mode.
5446 With a prefix argument ARG, enable Binary Overwrite mode if ARG
5447 is positive, and disable it otherwise. If called from Lisp,
5448 enable the mode if ARG is omitted or nil.
5450 When Binary Overwrite mode is enabled, printing characters typed
5451 in replace existing text. Newlines are not treated specially, so
5452 typing at the end of a line joins the line to the next, with the
5453 typed character between them. Typing before a tab character
5454 simply replaces the tab with the character typed.
5456 ordinary typing characters do.
5458 Note that Binary Overwrite mode is not its own minor mode; it is
5459 a specialization of overwrite mode, entered by setting the
5460 `overwrite-mode' variable to `overwrite-mode-binary'."
5461 :variable (eq overwrite-mode 'overwrite-mode-binary))
5463 (define-minor-mode line-number-mode
5464 "Toggle line number display in the mode line (Line Number mode).
5465 With a prefix argument ARG, enable Line Number mode if ARG is
5466 positive, and disable it otherwise. If called from Lisp, enable
5467 the mode if ARG is omitted or nil.
5469 Line numbers do not appear for very large buffers and buffers
5470 with very long lines; see variables `line-number-display-limit'
5471 and `line-number-display-limit-width'."
5472 :init-value t :global t :group 'mode-line)
5474 (define-minor-mode column-number-mode
5475 "Toggle column number display in the mode line (Column Number mode).
5476 With a prefix argument ARG, enable Column Number mode if ARG is
5477 positive, and disable it otherwise.
5479 If called from Lisp, enable the mode if ARG is omitted or nil."
5480 :global t :group 'mode-line)
5482 (define-minor-mode size-indication-mode
5483 "Toggle buffer size display in the mode line (Size Indication mode).
5484 With a prefix argument ARG, enable Size Indication mode if ARG is
5485 positive, and disable it otherwise.
5487 If called from Lisp, enable the mode if ARG is omitted or nil."
5488 :global t :group 'mode-line)
5490 (define-minor-mode auto-save-mode
5491 "Toggle auto-saving in the current buffer (Auto Save mode).
5492 With a prefix argument ARG, enable Auto Save mode if ARG is
5493 positive, and disable it otherwise.
5495 If called from Lisp, enable the mode if ARG is omitted or nil."
5496 :variable ((and buffer-auto-save-file-name
5497 ;; If auto-save is off because buffer has shrunk,
5498 ;; then toggling should turn it on.
5499 (>= buffer-saved-size 0))
5500 . (lambda (val)
5501 (setq buffer-auto-save-file-name
5502 (cond
5503 ((null val) nil)
5504 ((and buffer-file-name auto-save-visited-file-name
5505 (not buffer-read-only))
5506 buffer-file-name)
5507 (t (make-auto-save-file-name))))))
5508 ;; If -1 was stored here, to temporarily turn off saving,
5509 ;; turn it back on.
5510 (and (< buffer-saved-size 0)
5511 (setq buffer-saved-size 0)))
5512 \f
5513 (defgroup paren-blinking nil
5514 "Blinking matching of parens and expressions."
5515 :prefix "blink-matching-"
5516 :group 'paren-matching)
5518 (defcustom blink-matching-paren t
5519 "Non-nil means show matching open-paren when close-paren is inserted."
5520 :type 'boolean
5521 :group 'paren-blinking)
5523 (defcustom blink-matching-paren-on-screen t
5524 "Non-nil means show matching open-paren when it is on screen.
5525 If nil, don't show it (but the open-paren can still be shown
5526 when it is off screen).
5528 This variable has no effect if `blink-matching-paren' is nil.
5529 \(In that case, the open-paren is never shown.)
5530 It is also ignored if `show-paren-mode' is enabled."
5531 :type 'boolean
5532 :group 'paren-blinking)
5534 (defcustom blink-matching-paren-distance (* 100 1024)
5535 "If non-nil, maximum distance to search backwards for matching open-paren.
5536 If nil, search stops at the beginning of the accessible portion of the buffer."
5537 :version "23.2" ; 25->100k
5538 :type '(choice (const nil) integer)
5539 :group 'paren-blinking)
5541 (defcustom blink-matching-delay 1
5542 "Time in seconds to delay after showing a matching paren."
5543 :type 'number
5544 :group 'paren-blinking)
5546 (defcustom blink-matching-paren-dont-ignore-comments nil
5547 "If nil, `blink-matching-paren' ignores comments.
5548 More precisely, when looking for the matching parenthesis,
5549 it skips the contents of comments that end before point."
5550 :type 'boolean
5551 :group 'paren-blinking)
5553 (defun blink-matching-check-mismatch (start end)
5554 "Return whether or not START...END are matching parens.
5555 END is the current point and START is the blink position.
5556 START might be nil if no matching starter was found.
5557 Returns non-nil if we find there is a mismatch."
5558 (let* ((end-syntax (syntax-after (1- end)))
5559 (matching-paren (and (consp end-syntax)
5560 (eq (syntax-class end-syntax) 5)
5561 (cdr end-syntax))))
5562 ;; For self-matched chars like " and $, we can't know when they're
5563 ;; mismatched or unmatched, so we can only do it for parens.
5564 (when matching-paren
5565 (not (and start
5566 (or
5567 (eq (char-after start) matching-paren)
5568 ;; The cdr might hold a new paren-class info rather than
5569 ;; a matching-char info, in which case the two CDRs
5570 ;; should match.
5571 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5573 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5574 "Function to check parentheses mismatches.
5575 The function takes two arguments (START and END) where START is the
5576 position just before the opening token and END is the position right after.
5577 START can be nil, if it was not found.
5578 The function should return non-nil if the two tokens do not match.")
5580 (defun blink-matching-open ()
5581 "Move cursor momentarily to the beginning of the sexp before point."
5582 (interactive)
5583 (when (and (not (bobp))
5584 blink-matching-paren)
5585 (let* ((oldpos (point))
5586 (message-log-max nil) ; Don't log messages about paren matching.
5587 (blinkpos
5588 (save-excursion
5589 (save-restriction
5590 (if blink-matching-paren-distance
5591 (narrow-to-region
5592 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5593 (- (point) blink-matching-paren-distance))
5594 oldpos))
5595 (let ((parse-sexp-ignore-comments
5596 (and parse-sexp-ignore-comments
5597 (not blink-matching-paren-dont-ignore-comments))))
5598 (condition-case ()
5599 (progn
5600 (forward-sexp -1)
5601 ;; backward-sexp skips backward over prefix chars,
5602 ;; so move back to the matching paren.
5603 (while (and (< (point) (1- oldpos))
5604 (let ((code (syntax-after (point))))
5605 (or (eq (syntax-class code) 6)
5606 (eq (logand 1048576 (car code))
5607 1048576))))
5608 (forward-char 1))
5609 (point))
5610 (error nil))))))
5611 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5612 (cond
5613 (mismatch
5614 (if blinkpos
5615 (if (minibufferp)
5616 (minibuffer-message "Mismatched parentheses")
5617 (message "Mismatched parentheses"))
5618 (if (minibufferp)
5619 (minibuffer-message "No matching parenthesis found")
5620 (message "No matching parenthesis found"))))
5621 ((not blinkpos) nil)
5622 ((pos-visible-in-window-p blinkpos)
5623 ;; Matching open within window, temporarily move to blinkpos but only
5624 ;; if `blink-matching-paren-on-screen' is non-nil.
5625 (and blink-matching-paren-on-screen
5626 (not show-paren-mode)
5627 (save-excursion
5628 (goto-char blinkpos)
5629 (sit-for blink-matching-delay))))
5630 (t
5631 (save-excursion
5632 (goto-char blinkpos)
5633 (let ((open-paren-line-string
5634 ;; Show what precedes the open in its line, if anything.
5635 (cond
5637 (buffer-substring (line-beginning-position)
5638 (1+ blinkpos)))
5639 ;; Show what follows the open in its line, if anything.
5640 ((save-excursion
5641 (forward-char 1)
5643 (not (eolp)))
5644 (buffer-substring blinkpos
5645 (line-end-position)))
5646 ;; Otherwise show the previous nonblank line,
5647 ;; if there is one.
5649 (concat
5650 (buffer-substring (progn
5652 (line-beginning-position))
5653 (progn (end-of-line)
5655 (point)))
5656 ;; Replace the newline and other whitespace with `...'.
5657 "..."
5658 (buffer-substring blinkpos (1+ blinkpos))))
5659 ;; There is nothing to show except the char itself.
5660 (t (buffer-substring blinkpos (1+ blinkpos))))))
5661 (message "Matches %s"
5662 (substring-no-properties open-paren-line-string)))))))))
5664 (defvar blink-paren-function 'blink-matching-open
5665 "Function called, if non-nil, whenever a close parenthesis is inserted.
5666 More precisely, a char with closeparen syntax is self-inserted.")
5668 (defun blink-paren-post-self-insert-function ()
5669 (when (and (eq (char-before) last-command-event) ; Sanity check.
5670 (memq (char-syntax last-command-event) '(?\) ?\$))
5671 blink-paren-function
5672 (not executing-kbd-macro)
5673 (not noninteractive)
5674 ;; Verify an even number of quoting characters precede the close.
5675 (= 1 (logand 1 (- (point)
5676 (save-excursion
5677 (forward-char -1)
5679 (point))))))
5680 (funcall blink-paren-function)))
5682 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5683 ;; Most likely, this hook is nil, so this arg doesn't matter,
5684 ;; but I use it as a reminder that this function usually
5685 ;; likes to be run after others since it does `sit-for'.
5686 'append)
5687 \f
5688 ;; This executes C-g typed while Emacs is waiting for a command.
5689 ;; Quitting out of a program does not go through here;
5690 ;; that happens in the QUIT macro at the C code level.
5691 (defun keyboard-quit ()
5692 "Signal a `quit' condition.
5693 During execution of Lisp code, this character causes a quit directly.
5694 At top-level, as an editor command, this simply beeps."
5695 (interactive)
5696 ;; Avoid adding the region to the window selection.
5697 (setq saved-region-selection nil)
5698 (let (select-active-regions)
5699 (deactivate-mark))
5700 (if (fboundp 'kmacro-keyboard-quit)
5701 (kmacro-keyboard-quit))
5702 (setq defining-kbd-macro nil)
5703 (let ((debug-on-quit nil))
5704 (signal 'quit nil)))
5706 (defvar buffer-quit-function nil
5709 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5711 (defun keyboard-escape-quit ()
5713 This command can exit an interactive command such as `query-replace',
5714 can clear out a prefix argument or a region,
5715 can get out of the minibuffer or other recursive edit,
5716 cancel the use of the current buffer (for special-purpose buffers),
5717 or go back to just one window (by deleting all but the selected window)."
5718 (interactive)
5719 (cond ((eq last-command 'mode-exited) nil)
5720 ((region-active-p)
5721 (deactivate-mark))
5722 ((> (minibuffer-depth) 0)
5723 (abort-recursive-edit))
5724 (current-prefix-arg
5725 nil)
5726 ((> (recursion-depth) 0)
5727 (exit-recursive-edit))
5728 (buffer-quit-function
5729 (funcall buffer-quit-function))
5730 ((not (one-window-p t))
5731 (delete-other-windows))
5733 (bury-buffer))))
5735 (defun play-sound-file (file &optional volume device)
5736 "Play sound stored in FILE.
5737 VOLUME and DEVICE correspond to the keywords of the sound
5738 specification for `play-sound'."
5739 (interactive "fPlay sound file: ")
5740 (let ((sound (list :file file)))
5741 (if volume
5742 (plist-put sound :volume volume))
5743 (if device
5744 (plist-put sound :device device))
5745 (push 'sound sound)
5746 (play-sound sound)))
5748 \f
5749 (defcustom read-mail-command 'rmail
5750 "Your preference for a mail reading package.
5751 This is used by some keybindings which support reading mail.
5752 See also `mail-user-agent' concerning sending mail."
5755 (function-item :tag "Emacs interface to MH"
5757 (function :tag "Other"))
5758 :version "21.1"
5759 :group 'mail)
5761 (defcustom mail-user-agent 'message-user-agent
5762 "Your preference for a mail composition package.
5763 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5764 outgoing email message. This variable lets you specify which
5765 mail-sending package you prefer.
5767 Valid values include:
5769 `message-user-agent' -- use the Message package.
5770 See Info node `(message)'.
5771 `sendmail-user-agent' -- use the Mail package.
5772 See Info node `(emacs)Sending Mail'.
5773 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5774 See Info node `(mh-e)'.
5775 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5776 paraphernalia, particularly the Gcc: header for
5777 archiving.
5779 Additional valid symbols may be available; check with the author of
5780 your package for details. The function should return non-nil if it
5781 succeeds.
5783 See also `read-mail-command' concerning reading mail."
5784 :type '(radio (function-item :tag "Message package"
5786 message-user-agent)
5787 (function-item :tag "Mail package"
5789 sendmail-user-agent)
5790 (function-item :tag "Emacs interface to MH"
5792 mh-e-user-agent)
5793 (function-item :tag "Message with full Gnus features"
5795 gnus-user-agent)
5796 (function :tag "Other"))
5797 :version "23.2" ; sendmail->message
5798 :group 'mail)
5800 (defcustom compose-mail-user-agent-warnings t
5801 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5802 If the value of `mail-user-agent' is the default, and the user
5803 appears to have customizations applying to the old default,
5804 `compose-mail' issues a warning."
5805 :type 'boolean
5806 :version "23.2"
5807 :group 'mail)
5809 (defun rfc822-goto-eoh ()
5810 "If the buffer starts with a mail header, move point to the header's end.
5811 Otherwise, moves to `point-min'.
5812 The end of the header is the start of the next line, if there is one,
5813 else the end of the last line. This function obeys RFC822."
5814 (goto-char (point-min))
5815 (when (re-search-forward
5817 (goto-char (match-beginning 0))))
5819 ;; Used by Rmail (e.g., rmail-forward).
5820 (defvar mail-encode-mml nil
5821 "If non-nil, mail-user-agent's `sendfunc' command should mml-encode
5822 the outgoing message before sending it.")
5824 (defun compose-mail (&optional to subject other-headers continue
5825 switch-function yank-action send-actions
5826 return-action)
5827 "Start composing a mail message to send.
5828 This uses the user's chosen mail composition package
5829 as selected with the variable `mail-user-agent'.
5830 The optional arguments TO and SUBJECT specify recipients
5831 and the initial Subject field, respectively.
5833 OTHER-HEADERS is an alist specifying additional
5834 header fields. Elements look like (HEADER . VALUE) where both
5835 HEADER and VALUE are strings.
5837 CONTINUE, if non-nil, says to continue editing a message already
5838 being composed. Interactively, CONTINUE is the prefix argument.
5840 SWITCH-FUNCTION, if non-nil, is a function to use to
5841 switch to and display the buffer used for mail composition.
5843 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5844 to insert the raw text of the message being replied to.
5845 It has the form (FUNCTION . ARGS). The user agent will apply
5846 FUNCTION to ARGS, to insert the raw text of the original message.
5847 \(The user agent will also run `mail-citation-hook', *after* the
5848 original text has been inserted in this way.)
5850 SEND-ACTIONS is a list of actions to call when the message is sent.
5851 Each action has the form (FUNCTION . ARGS).
5853 RETURN-ACTION, if non-nil, is an action for returning to the
5854 caller. It has the form (FUNCTION . ARGS). The function is
5855 called after the mail has been sent or put aside, and the mail
5856 buffer buried."
5857 (interactive
5858 (list nil nil nil current-prefix-arg))
5860 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5861 ;; from sendmail-user-agent to message-user-agent. Some users may
5862 ;; encounter incompatibilities. This hack tries to detect problems
5863 ;; and warn about them.
5864 (and compose-mail-user-agent-warnings
5865 (eq mail-user-agent 'message-user-agent)
5866 (let (warn-vars)
5867 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5868 mail-yank-hooks mail-archive-file-name
5869 mail-default-reply-to mail-mailing-lists
5870 mail-self-blind))
5871 (and (boundp var)
5872 (symbol-value var)
5873 (push var warn-vars)))
5874 (when warn-vars
5875 (display-warning 'mail
5876 (format "\
5877 The default mail mode is now Message mode.
5878 You have the following Mail mode variable%s customized:
5880 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5881 (if (> (length warn-vars) 1) "s" "")
5882 (mapconcat 'symbol-name
5883 warn-vars " "))))))
5885 (let ((function (get mail-user-agent 'composefunc)))
5886 (funcall function to subject other-headers continue switch-function
5887 yank-action send-actions return-action)))
5889 (defun compose-mail-other-window (&optional to subject other-headers continue
5890 yank-action send-actions
5891 return-action)
5893 (interactive (list nil nil nil current-prefix-arg))
5894 (compose-mail to subject other-headers continue
5895 'switch-to-buffer-other-window yank-action send-actions
5896 return-action))
5898 (defun compose-mail-other-frame (&optional to subject other-headers continue
5899 yank-action send-actions
5900 return-action)
5902 (interactive (list nil nil nil current-prefix-arg))
5903 (compose-mail to subject other-headers continue
5904 'switch-to-buffer-other-frame yank-action send-actions
5905 return-action))
5907 \f
5908 (defvar set-variable-value-history nil
5909 "History of values entered with `set-variable'.
5911 Maximum length of the history list is determined by the value
5912 of `history-length', which see.")
5914 (defun set-variable (variable value &optional make-local)
5915 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5916 VARIABLE should be a user option variable name, a Lisp variable
5917 meant to be customized by users. You should enter VALUE in Lisp syntax,
5918 so if you want VALUE to be a string, you must surround it with doublequotes.
5919 VALUE is used literally, not evaluated.
5921 If VARIABLE has a `variable-interactive' property, that is used as if
5922 it were the arg to `interactive' (which see) to interactively read VALUE.
5924 If VARIABLE has been defined with `defcustom', then the type information
5925 in the definition is used to check that VALUE is valid.
5927 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5928 (interactive
5929 (let* ((default-var (variable-at-point))
5930 (var (if (user-variable-p default-var)
5931 (read-variable (format "Set variable (default %s): " default-var)
5932 default-var)
5933 (read-variable "Set variable: ")))
5934 (minibuffer-help-form '(describe-variable var))
5935 (prop (get var 'variable-interactive))
5936 (obsolete (car (get var 'byte-obsolete-variable)))
5937 (prompt (format "Set %s %s to value: " var
5938 (cond ((local-variable-p var)
5939 "(buffer-local)")
5940 ((or current-prefix-arg
5941 (local-variable-if-set-p var))
5942 "buffer-locally")
5943 (t "globally"))))
5944 (val (progn
5945 (when obsolete
5946 (message (concat "`%S' is obsolete; "
5947 (if (symbolp obsolete) "use `%S' instead" "%s"))
5948 var obsolete)
5949 (sit-for 3))
5950 (if prop
5951 ;; Use VAR's `variable-interactive' property
5952 ;; as an interactive spec for prompting.
5953 (call-interactively `(lambda (arg)
5954 (interactive ,prop)
5955 arg))
5956 (read
5957 (read-string prompt nil
5958 'set-variable-value-history
5959 (format "%S" (symbol-value var))))))))
5960 (list var val current-prefix-arg)))
5962 (and (custom-variable-p variable)
5963 (not (get variable 'custom-type))
5964 (custom-load-symbol variable))
5965 (let ((type (get variable 'custom-type)))
5966 (when type
5967 ;; Match with custom type.
5968 (require 'cus-edit)
5969 (setq type (widget-convert type))
5970 (unless (widget-apply type :match value)
5971 (error "Value `%S' does not match type %S of %S"
5972 value (car type) variable))))
5974 (if make-local
5975 (make-local-variable variable))
5977 (set variable value)
5979 ;; Force a thorough redisplay for the case that the variable
5980 ;; has an effect on the display, like `tab-width' has.
5981 (force-mode-line-update))
5982 \f
5983 ;; Define the major mode for lists of completions.
5985 (defvar completion-list-mode-map
5986 (let ((map (make-sparse-keymap)))
5987 (define-key map [mouse-2] 'mouse-choose-completion)
5988 (define-key map [follow-link] 'mouse-face)
5989 (define-key map [down-mouse-2] nil)
5990 (define-key map "\C-m" 'choose-completion)
5991 (define-key map "\e\e\e" 'delete-completion-window)
5992 (define-key map [left] 'previous-completion)
5993 (define-key map [right] 'next-completion)
5994 (define-key map "q" 'quit-window)
5995 (define-key map "z" 'kill-this-buffer)
5996 map)
5997 "Local map for completion list buffers.")
5999 ;; Completion mode is suitable only for specially formatted data.
6000 (put 'completion-list-mode 'mode-class 'special)
6002 (defvar completion-reference-buffer nil
6003 "Record the buffer that was current when the completion list was requested.
6004 This is a local variable in the completion list buffer.
6005 Initial value is nil to avoid some compiler warnings.")
6007 (defvar completion-no-auto-exit nil
6008 "Non-nil means `choose-completion-string' should never exit the minibuffer.
6009 This also applies to other functions such as `choose-completion'.")
6011 (defvar completion-base-position nil
6012 "Position of the base of the text corresponding to the shown completions.
6013 This variable is used in the *Completions* buffers.
6014 Its value is a list of the form (START END) where START is the place
6015 where the completion should be inserted and END (if non-nil) is the end
6016 of the text to replace. If END is nil, point is used instead.")
6018 (defvar completion-list-insert-choice-function #'completion--replace
6019 "Function to use to insert the text chosen in *Completions*.
6020 Called with 3 arguments (BEG END TEXT), it should replace the text
6021 between BEG and END with TEXT. Expected to be set buffer-locally
6022 in the *Completions* buffer.")
6024 (defvar completion-base-size nil
6025 "Number of chars before point not involved in completion.
6026 This is a local variable in the completion list buffer.
6027 It refers to the chars in the minibuffer if completing in the
6028 minibuffer, or in `completion-reference-buffer' otherwise.
6029 Only characters in the field at point are included.
6031 If nil, Emacs determines which part of the tail end of the
6032 buffer's text is involved in completion by comparing the text
6033 directly.")
6034 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
6036 (defun delete-completion-window ()
6037 "Delete the completion list window.
6038 Go to the window from which completion was requested."
6039 (interactive)
6040 (let ((buf completion-reference-buffer))
6041 (if (one-window-p t)
6042 (if (window-dedicated-p (selected-window))
6043 (delete-frame (selected-frame)))
6044 (delete-window (selected-window))
6045 (if (get-buffer-window buf)
6046 (select-window (get-buffer-window buf))))))
6048 (defun previous-completion (n)
6049 "Move to the previous item in the completion list."
6050 (interactive "p")
6051 (next-completion (- n)))
6053 (defun next-completion (n)
6054 "Move to the next item in the completion list.
6055 With prefix argument N, move N items (negative N means move backward)."
6056 (interactive "p")
6057 (let ((beg (point-min)) (end (point-max)))
6058 (while (and (> n 0) (not (eobp)))
6059 ;; If in a completion, move to the end of it.
6060 (when (get-text-property (point) 'mouse-face)
6061 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6062 ;; Move to start of next one.
6063 (unless (get-text-property (point) 'mouse-face)
6064 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6065 (setq n (1- n)))
6066 (while (and (< n 0) (not (bobp)))
6067 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6068 ;; If in a completion, move to the start of it.
6069 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6070 (goto-char (previous-single-property-change
6071 (point) 'mouse-face nil beg)))
6072 ;; Move to end of the previous completion.
6073 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6074 (goto-char (previous-single-property-change
6075 (point) 'mouse-face nil beg)))
6076 ;; Move to the start of that one.
6077 (goto-char (previous-single-property-change
6078 (point) 'mouse-face nil beg))
6079 (setq n (1+ n))))))
6081 (defun choose-completion (&optional event)
6082 "Choose the completion at point."
6083 (interactive (list last-nonmenu-event))
6084 ;; In case this is run via the mouse, give temporary modes such as
6085 ;; isearch a chance to turn off.
6086 (run-hooks 'mouse-leave-buffer-hook)
6087 (with-current-buffer (window-buffer (posn-window (event-start event)))
6088 (let ((buffer completion-reference-buffer)
6089 (base-size completion-base-size)
6090 (base-position completion-base-position)
6091 (insert-function completion-list-insert-choice-function)
6092 (choice
6093 (save-excursion
6094 (goto-char (posn-point (event-start event)))
6095 (let (beg end)
6096 (cond
6097 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6098 (setq end (point) beg (1+ (point))))
6099 ((and (not (bobp))
6100 (get-text-property (1- (point)) 'mouse-face))
6101 (setq end (1- (point)) beg (point)))
6102 (t (error "No completion here")))
6103 (setq beg (previous-single-property-change beg 'mouse-face))
6104 (setq end (or (next-single-property-change end 'mouse-face)
6105 (point-max)))
6106 (buffer-substring-no-properties beg end))))
6107 (owindow (selected-window)))
6109 (unless (buffer-live-p buffer)
6110 (error "Destination buffer is dead"))
6111 (select-window (posn-window (event-start event)))
6112 (if (and (one-window-p t 'selected-frame)
6113 (window-dedicated-p (selected-window)))
6114 ;; This is a special buffer's frame
6115 (iconify-frame (selected-frame))
6116 (or (window-dedicated-p (selected-window))
6117 (bury-buffer)))
6118 (select-window
6119 (or (get-buffer-window buffer 0)
6120 owindow))
6122 (with-current-buffer buffer
6123 (choose-completion-string
6124 choice buffer
6125 (or base-position
6126 (when base-size
6127 ;; Someone's using old completion code that doesn't know
6128 ;; about base-position yet.
6129 (list (+ base-size (field-beginning))))
6130 ;; If all else fails, just guess.
6131 (list (choose-completion-guess-base-position choice)))
6132 insert-function)))))
6134 ;; Delete the longest partial match for STRING
6135 ;; that can be found before POINT.
6136 (defun choose-completion-guess-base-position (string)
6137 (save-excursion
6138 (let ((opoint (point))
6139 len)
6140 ;; Try moving back by the length of the string.
6141 (goto-char (max (- (point) (length string))
6142 (minibuffer-prompt-end)))
6143 ;; See how far back we were actually able to move. That is the
6144 ;; upper bound on how much we can match and delete.
6145 (setq len (- opoint (point)))
6146 (if completion-ignore-case
6147 (setq string (downcase string)))
6148 (while (and (> len 0)
6149 (let ((tail (buffer-substring (point) opoint)))
6150 (if completion-ignore-case
6151 (setq tail (downcase tail)))
6152 (not (string= tail (substring string 0 len)))))
6153 (setq len (1- len))
6154 (forward-char 1))
6155 (point))))
6157 (defun choose-completion-delete-max-match (string)
6158 (delete-region (choose-completion-guess-base-position string) (point)))
6159 (make-obsolete 'choose-completion-delete-max-match
6160 'choose-completion-guess-base-position "23.2")
6162 (defvar choose-completion-string-functions nil
6163 "Functions that may override the normal insertion of a completion choice.
6164 These functions are called in order with four arguments:
6165 CHOICE - the string to insert in the buffer,
6166 BUFFER - the buffer in which the choice should be inserted,
6167 MINI-P - non-nil if BUFFER is a minibuffer, and
6168 BASE-SIZE - the number of characters in BUFFER before
6169 the string being completed.
6171 If a function in the list returns non-nil, that function is supposed
6172 to have inserted the CHOICE in the BUFFER, and possibly exited
6173 the minibuffer; no further functions will be called.
6175 If all functions in the list return nil, that means to use
6176 the default method of inserting the completion in BUFFER.")
6178 (defun choose-completion-string (choice &optional
6179 buffer base-position insert-function)
6180 "Switch to BUFFER and insert the completion choice CHOICE.
6181 BASE-POSITION, says where to insert the completion."
6183 ;; If BUFFER is the minibuffer, exit the minibuffer
6184 ;; unless it is reading a file name and CHOICE is a directory,
6185 ;; or completion-no-auto-exit is non-nil.
6187 ;; Some older code may call us passing `base-size' instead of
6188 ;; `base-position'. It's difficult to make any use of `base-size',
6189 ;; so we just ignore it.
6190 (unless (consp base-position)
6191 (message "Obsolete `base-size' passed to choose-completion-string")
6192 (setq base-position nil))
6194 (let* ((buffer (or buffer completion-reference-buffer))
6195 (mini-p (minibufferp buffer)))
6196 ;; If BUFFER is a minibuffer, barf unless it's the currently
6197 ;; active minibuffer.
6198 (if (and mini-p
6199 (not (and (active-minibuffer-window)
6200 (equal buffer
6201 (window-buffer (active-minibuffer-window))))))
6202 (error "Minibuffer is not active for completion")
6203 ;; Set buffer so buffer-local choose-completion-string-functions works.
6204 (set-buffer buffer)
6205 (unless (run-hook-with-args-until-success
6206 'choose-completion-string-functions
6207 ;; The fourth arg used to be `mini-p' but was useless
6208 ;; (since minibufferp can be used on the `buffer' arg)
6209 ;; and indeed unused. The last used to be `base-size', so we
6210 ;; keep it to try and avoid breaking old code.
6211 choice buffer base-position nil)
6212 ;; This remove-text-properties should be unnecessary since `choice'
6213 ;; comes from buffer-substring-no-properties.
6214 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6215 ;; Insert the completion into the buffer where it was requested.
6216 (funcall (or insert-function completion-list-insert-choice-function)
6217 (or (car base-position) (point))
6218 (or (cadr base-position) (point))
6219 choice)
6220 ;; Update point in the window that BUFFER is showing in.
6221 (let ((window (get-buffer-window buffer t)))
6222 (set-window-point window (point)))
6223 ;; If completing for the minibuffer, exit it with this choice.
6224 (and (not completion-no-auto-exit)
6225 (minibufferp buffer)
6226 minibuffer-completion-table
6227 ;; If this is reading a file name, and the file name chosen
6228 ;; is a directory, don't exit the minibuffer.
6229 (let* ((result (buffer-substring (field-beginning) (point)))
6230 (bounds
6231 (completion-boundaries result minibuffer-completion-table
6232 minibuffer-completion-predicate
6233 "")))
6234 (if (eq (car bounds) (length result))
6235 ;; The completion chosen leads to a new set of completions
6236 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6237 (let ((mini (active-minibuffer-window)))
6238 (select-window mini)
6239 (when minibuffer-auto-raise
6240 (raise-frame (window-frame mini))))
6241 (exit-minibuffer))))))))
6243 (define-derived-mode completion-list-mode nil "Completion List"
6244 "Major mode for buffers showing lists of possible completions.
6246 to select the completion near point.
6248 with the mouse.
6251 (set (make-local-variable 'completion-base-size) nil))
6253 (defun completion-list-mode-finish ()
6254 "Finish setup of the completions buffer.
6255 Called from `temp-buffer-show-hook'."
6256 (when (eq major-mode 'completion-list-mode)
6257 (toggle-read-only 1)))
6259 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6262 ;; Variables and faces used in `completion-setup-function'.
6264 (defcustom completion-show-help t
6265 "Non-nil means show help message in *Completions* buffer."
6266 :type 'boolean
6267 :version "22.1"
6268 :group 'completion)
6270 ;; This function goes in completion-setup-hook, so that it is called
6271 ;; after the text of the completion list buffer is written.
6272 (defun completion-setup-function ()
6273 (let* ((mainbuf (current-buffer))
6274 (base-dir
6275 ;; When reading a file name in the minibuffer,
6276 ;; try and find the right default-directory to set in the
6277 ;; completion list buffer.
6278 ;; FIXME: Why do we do that, actually? --Stef
6279 (if minibuffer-completing-file-name
6280 (file-name-as-directory
6281 (expand-file-name
6282 (substring (minibuffer-completion-contents)
6283 0 (or completion-base-size 0)))))))
6284 (with-current-buffer standard-output
6285 (let ((base-size completion-base-size) ;Read before killing localvars.
6286 (base-position completion-base-position)
6287 (insert-fun completion-list-insert-choice-function))
6288 (completion-list-mode)
6289 (set (make-local-variable 'completion-base-size) base-size)
6290 (set (make-local-variable 'completion-base-position) base-position)
6291 (set (make-local-variable 'completion-list-insert-choice-function)
6292 insert-fun))
6293 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6294 (if base-dir (setq default-directory base-dir))
6295 ;; Maybe insert help string.
6296 (when completion-show-help
6297 (goto-char (point-min))
6298 (if (display-mouse-p)
6299 (insert (substitute-command-keys
6301 (insert (substitute-command-keys
6305 (add-hook 'completion-setup-hook 'completion-setup-function)
6307 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6308 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6310 (defun switch-to-completions ()
6311 "Select the completion list window."
6312 (interactive)
6313 (let ((window (or (get-buffer-window "*Completions*" 0)
6314 ;; Make sure we have a completions window.
6315 (progn (minibuffer-completion-help)
6316 (get-buffer-window "*Completions*" 0)))))
6317 (when window
6318 (select-window window)
6319 ;; In the new buffer, go to the first completion.
6320 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6321 (when (bobp)
6322 (next-completion 1)))))
6323 \f
6324 ;;; Support keyboard commands to turn on various modifiers.
6326 ;; These functions -- which are not commands -- each add one modifier
6327 ;; to the following event.
6329 (defun event-apply-alt-modifier (_ignore-prompt)
6332 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6333 (defun event-apply-super-modifier (_ignore-prompt)
6336 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6337 (defun event-apply-hyper-modifier (_ignore-prompt)
6340 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6341 (defun event-apply-shift-modifier (_ignore-prompt)
6344 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6345 (defun event-apply-control-modifier (_ignore-prompt)
6348 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6349 (defun event-apply-meta-modifier (_ignore-prompt)
6352 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6354 (defun event-apply-modifier (event symbol lshiftby prefix)
6355 "Apply a modifier flag to event EVENT.
6356 SYMBOL is the name of this modifier, as a symbol.
6357 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6358 PREFIX is the string that represents this modifier in an event type symbol."
6359 (if (numberp event)
6360 (cond ((eq symbol 'control)
6361 (if (and (<= (downcase event) ?z)
6362 (>= (downcase event) ?a))
6363 (- (downcase event) ?a -1)
6364 (if (and (<= (downcase event) ?Z)
6365 (>= (downcase event) ?A))
6366 (- (downcase event) ?A -1)
6367 (logior (lsh 1 lshiftby) event))))
6368 ((eq symbol 'shift)
6369 (if (and (<= (downcase event) ?z)
6370 (>= (downcase event) ?a))
6371 (upcase event)
6372 (logior (lsh 1 lshiftby) event)))
6373 (t
6374 (logior (lsh 1 lshiftby) event)))
6375 (if (memq symbol (event-modifiers event))
6376 event
6377 (let ((event-type (if (symbolp event) event (car event))))
6378 (setq event-type (intern (concat prefix (symbol-name event-type))))
6379 (if (symbolp event)
6380 event-type
6381 (cons event-type (cdr event)))))))
6383 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6384 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6385 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6386 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6387 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6388 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6389 \f
6390 ;;;; Keypad support.
6392 ;; Make the keypad keys act like ordinary typing keys. If people add
6393 ;; bindings for the function key symbols, then those bindings will
6394 ;; override these, so this shouldn't interfere with any existing
6395 ;; bindings.
6397 ;; Also tell read-char how to handle these keys.
6398 (mapc
6399 (lambda (keypad-normal)
6400 (let ((keypad (nth 0 keypad-normal))
6401 (normal (nth 1 keypad-normal)))
6402 (put keypad 'ascii-character normal)
6403 (define-key function-key-map (vector keypad) (vector normal))))
6404 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6405 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6406 (kp-space ?\s)
6409 (kp-multiply ?*)
6410 (kp-add ?+)
6411 (kp-separator ?,)
6412 (kp-subtract ?-)
6413 (kp-decimal ?.)
6414 (kp-divide ?/)
6415 (kp-equal ?=)
6416 ;; Do the same for various keys that are represented as symbols under
6417 ;; GUIs but naturally correspond to characters.
6418 (backspace 127)
6419 (delete 127)
6422 (clear ?\C-l)
6423 (return ?\C-m)
6424 (escape ?\e)
6425 ))
6426 \f
6427 ;;;;
6428 ;;;; forking a twin copy of a buffer.
6429 ;;;;
6431 (defvar clone-buffer-hook nil
6432 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6434 (defvar clone-indirect-buffer-hook nil
6435 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6437 (defun clone-process (process &optional newname)
6438 "Create a twin copy of PROCESS.
6439 If NEWNAME is nil, it defaults to PROCESS' name;
6440 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6441 If PROCESS is associated with a buffer, the new process will be associated
6442 with the current buffer instead.
6443 Returns nil if PROCESS has already terminated."
6444 (setq newname (or newname (process-name process)))
6446 (setq newname (substring newname 0 (match-beginning 0))))
6447 (when (memq (process-status process) '(run stop open))
6448 (let* ((process-connection-type (process-tty-name process))
6449 (new-process
6450 (if (memq (process-status process) '(open))
6451 (let ((args (process-contact process t)))
6452 (setq args (plist-put args :name newname))
6453 (setq args (plist-put args :buffer
6454 (if (process-buffer process)
6455 (current-buffer))))
6456 (apply 'make-network-process args))
6457 (apply 'start-process newname
6458 (if (process-buffer process) (current-buffer))
6459 (process-command process)))))
6460 (set-process-query-on-exit-flag
6461 new-process (process-query-on-exit-flag process))
6462 (set-process-inherit-coding-system-flag
6463 new-process (process-inherit-coding-system-flag process))
6464 (set-process-filter new-process (process-filter process))
6465 (set-process-sentinel new-process (process-sentinel process))
6466 (set-process-plist new-process (copy-sequence (process-plist process)))
6467 new-process)))
6469 ;; things to maybe add (currently partly covered by `funcall mode'):
6470 ;; - syntax-table
6471 ;; - overlays
6472 (defun clone-buffer (&optional newname display-flag)
6473 "Create and return a twin copy of the current buffer.
6474 Unlike an indirect buffer, the new buffer can be edited
6475 independently of the old one (if it is not read-only).
6476 NEWNAME is the name of the new buffer. It may be modified by
6477 adding or incrementing <N> at the end as necessary to create a
6478 unique buffer name. If nil, it defaults to the name of the
6479 current buffer, with the proper suffix. If DISPLAY-FLAG is
6480 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6481 clone a file-visiting buffer, or a buffer whose major mode symbol
6482 has a non-nil `no-clone' property, results in an error.
6484 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6485 current buffer with appropriate suffix. However, if a prefix
6486 argument is given, then the command prompts for NEWNAME in the
6487 minibuffer.
6489 This runs the normal hook `clone-buffer-hook' in the new buffer
6490 after it has been set up properly in other respects."
6491 (interactive
6492 (progn
6493 (if buffer-file-name
6494 (error "Cannot clone a file-visiting buffer"))
6495 (if (get major-mode 'no-clone)
6496 (error "Cannot clone a buffer in %s mode" mode-name))
6497 (list (if current-prefix-arg
6498 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6499 t)))
6500 (if buffer-file-name
6501 (error "Cannot clone a file-visiting buffer"))
6502 (if (get major-mode 'no-clone)
6503 (error "Cannot clone a buffer in %s mode" mode-name))
6504 (setq newname (or newname (buffer-name)))
6506 (setq newname (substring newname 0 (match-beginning 0))))
6507 (let ((buf (current-buffer))
6508 (ptmin (point-min))
6509 (ptmax (point-max))
6510 (pt (point))
6511 (mk (if mark-active (mark t)))
6512 (modified (buffer-modified-p))
6513 (mode major-mode)
6514 (lvars (buffer-local-variables))
6515 (process (get-buffer-process (current-buffer)))
6516 (new (generate-new-buffer (or newname (buffer-name)))))
6517 (save-restriction
6518 (widen)
6519 (with-current-buffer new
6520 (insert-buffer-substring buf)))
6521 (with-current-buffer new
6522 (narrow-to-region ptmin ptmax)
6523 (goto-char pt)
6524 (if mk (set-mark mk))
6525 (set-buffer-modified-p modified)
6527 ;; Clone the old buffer's process, if any.
6528 (when process (clone-process process))
6530 ;; Now set up the major mode.
6531 (funcall mode)
6533 ;; Set up other local variables.
6534 (mapc (lambda (v)
6535 (condition-case () ;in case var is read-only
6536 (if (symbolp v)
6537 (makunbound v)
6538 (set (make-local-variable (car v)) (cdr v)))
6539 (error nil)))
6540 lvars)
6542 ;; Run any hooks (typically set up by the major mode
6543 ;; for cloning to work properly).
6544 (run-hooks 'clone-buffer-hook))
6545 (if display-flag
6546 ;; Presumably the current buffer is shown in the selected frame, so
6547 ;; we want to display the clone elsewhere.
6548 (let ((same-window-regexps nil)
6549 (same-window-buffer-names))
6550 (pop-to-buffer new)))
6551 new))
6554 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6555 "Create an indirect buffer that is a twin copy of the current buffer.
6557 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6558 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6559 or if not called with a prefix arg, NEWNAME defaults to the current
6560 buffer's name. The name is modified by adding a `<N>' suffix to it
6561 or by incrementing the N in an existing suffix. Trying to clone a
6562 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6563 property results in an error.
6565 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6566 This is always done when called interactively.
6568 Optional third arg NORECORD non-nil means do not put this buffer at the
6569 front of the list of recently selected ones."
6570 (interactive
6571 (progn
6572 (if (get major-mode 'no-clone-indirect)
6573 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6574 (list (if current-prefix-arg
6575 (read-buffer "Name of indirect buffer: " (current-buffer)))
6576 t)))
6577 (if (get major-mode 'no-clone-indirect)
6578 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6579 (setq newname (or newname (buffer-name)))
6581 (setq newname (substring newname 0 (match-beginning 0))))
6582 (let* ((name (generate-new-buffer-name newname))
6583 (buffer (make-indirect-buffer (current-buffer) name t)))
6584 (with-current-buffer buffer
6585 (run-hooks 'clone-indirect-buffer-hook))
6586 (when display-flag
6587 (pop-to-buffer buffer norecord))
6588 buffer))
6591 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6592 "Like `clone-indirect-buffer' but display in another window."
6593 (interactive
6594 (progn
6595 (if (get major-mode 'no-clone-indirect)
6596 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6597 (list (if current-prefix-arg
6598 (read-buffer "Name of indirect buffer: " (current-buffer)))
6599 t)))
6600 (let ((pop-up-windows t))
6601 (clone-indirect-buffer newname display-flag norecord)))
6603 \f
6604 ;;; Handling of Backspace and Delete keys.
6606 (defcustom normal-erase-is-backspace 'maybe
6607 "Set the default behavior of the Delete and Backspace keys.
6609 If set to t, Delete key deletes forward and Backspace key deletes
6610 backward.
6612 If set to nil, both Delete and Backspace keys delete backward.
6614 If set to 'maybe (which is the default), Emacs automatically
6615 selects a behavior. On window systems, the behavior depends on
6616 the keyboard used. If the keyboard has both a Backspace key and
6617 a Delete key, and both are mapped to their usual meanings, the
6618 option's default value is set to t, so that Backspace can be used
6619 to delete backward, and Delete can be used to delete forward.
6621 If not running under a window system, customizing this option
6622 accomplishes a similar effect by mapping C-h, which is usually
6623 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6624 via `keyboard-translate'. The former functionality of C-h is
6625 available on the F1 key. You should probably not use this
6626 setting if you don't have both Backspace, Delete and F1 keys.
6628 Setting this variable with setq doesn't take effect. Programmatically,
6629 call `normal-erase-is-backspace-mode' (which see) instead."
6630 :type '(choice (const :tag "Off" nil)
6631 (const :tag "Maybe" maybe)
6632 (other :tag "On" t))
6633 :group 'editing-basics
6634 :version "21.1"
6635 :set (lambda (symbol value)
6636 ;; The fboundp is because of a problem with :set when
6637 ;; dumping Emacs. It doesn't really matter.
6638 (if (fboundp 'normal-erase-is-backspace-mode)
6639 (normal-erase-is-backspace-mode (or value 0))
6640 (set-default symbol value))))
6642 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6643 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6644 (unless frame (setq frame (selected-frame)))
6645 (with-selected-frame frame
6646 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6647 (normal-erase-is-backspace-mode
6648 (if (if (eq normal-erase-is-backspace 'maybe)
6649 (and (not noninteractive)
6650 (or (memq system-type '(ms-dos windows-nt))
6651 (memq window-system '(ns))
6652 (and (memq window-system '(x))
6653 (fboundp 'x-backspace-delete-keys-p)
6654 (x-backspace-delete-keys-p))
6655 ;; If the terminal Emacs is running on has erase char
6656 ;; set to ^H, use the Backspace key for deleting
6657 ;; backward, and the Delete key for deleting forward.
6658 (and (null window-system)
6659 (eq tty-erase-char ?\^H))))
6660 normal-erase-is-backspace)
6661 1 0)))))
6663 (define-minor-mode normal-erase-is-backspace-mode
6664 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6665 With a prefix argument ARG, enable this feature if ARG is
6666 positive, and disable it otherwise. If called from Lisp, enable
6667 the mode if ARG is omitted or nil.
6669 On window systems, when this mode is on, Delete is mapped to C-d
6670 and Backspace is mapped to DEL; when this mode is off, both
6671 Delete and Backspace are mapped to DEL. (The remapping goes via
6672 `local-function-key-map', so binding Delete or Backspace in the
6673 global or local keymap will override that.)
6675 In addition, on window systems, the bindings of C-Delete, M-Delete,
6676 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6677 the global keymap in accordance with the functionality of Delete and
6678 Backspace. For example, if Delete is remapped to C-d, which deletes
6679 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6680 to DEL, which deletes backward, C-Delete is bound to
6681 `backward-kill-word'.
6683 If not running on a window system, a similar effect is accomplished by
6684 remapping C-h (normally produced by the Backspace key) and DEL via
6685 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6686 to C-d; if it's off, the keys are not remapped.
6688 When not running on a window system, and this mode is turned on, the
6689 former functionality of C-h is available on the F1 key. You should
6690 probably not turn on this mode on a text-only terminal if you don't
6691 have both Backspace, Delete and F1 keys.
6693 See also `normal-erase-is-backspace'."
6694 :variable (eq (terminal-parameter
6695 nil 'normal-erase-is-backspace) 1)
6696 (let ((enabled (eq 1 (terminal-parameter
6697 nil 'normal-erase-is-backspace))))
6699 (cond ((or (memq window-system '(x w32 ns pc))
6700 (memq system-type '(ms-dos windows-nt)))
6701 (let ((bindings
6702 `(([M-delete] [M-backspace])
6703 ([C-M-delete] [C-M-backspace])
6704 ([?\e C-delete] [?\e C-backspace]))))
6706 (if enabled
6707 (progn
6708 (define-key local-function-key-map [delete] [deletechar])
6709 (define-key local-function-key-map [kp-delete] [?\C-d])
6710 (define-key local-function-key-map [backspace] [?\C-?])
6711 (dolist (b bindings)
6712 ;; Not sure if input-decode-map is really right, but
6713 ;; keyboard-translate-table (used below) only works
6714 ;; for integer events, and key-translation-table is
6715 ;; global (like the global-map, used earlier).
6716 (define-key input-decode-map (car b) nil)
6717 (define-key input-decode-map (cadr b) nil)))
6718 (define-key local-function-key-map [delete] [?\C-?])
6719 (define-key local-function-key-map [kp-delete] [?\C-?])
6720 (define-key local-function-key-map [backspace] [?\C-?])
6721 (dolist (b bindings)
6722 (define-key input-decode-map (car b) (cadr b))
6723 (define-key input-decode-map (cadr b) (car b))))))
6724 (t
6725 (if enabled
6726 (progn
6727 (keyboard-translate ?\C-h ?\C-?)
6728 (keyboard-translate ?\C-? ?\C-d))
6729 (keyboard-translate ?\C-h ?\C-h)
6730 (keyboard-translate ?\C-? ?\C-?))))
6732 (if (called-interactively-p 'interactive)
6733 (message "Delete key deletes %s"
6734 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6735 "forward" "backward")))))
6736 \f
6737 (defvar vis-mode-saved-buffer-invisibility-spec nil
6738 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6740 (define-minor-mode visible-mode
6741 "Toggle making all invisible text temporarily visible (Visible mode).
6742 With a prefix argument ARG, enable Visible mode if ARG is
6743 positive, and disable it otherwise. If called from Lisp, enable
6744 the mode if ARG is omitted or nil.
6746 This mode works by saving the value of `buffer-invisibility-spec'
6747 and setting it to nil."
6748 :lighter " Vis"
6749 :group 'editing-basics
6750 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6751 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6752 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6753 (when visible-mode
6754 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6755 buffer-invisibility-spec)
6756 (setq buffer-invisibility-spec nil)))
6757 \f
6758 ;; Minibuffer prompt stuff.
6760 ;;(defun minibuffer-prompt-modification (start end)
6761 ;; (error "You cannot modify the prompt"))
6762 ;;
6763 ;;
6764 ;;(defun minibuffer-prompt-insertion (start end)
6765 ;; (let ((inhibit-modification-hooks t))
6766 ;; (delete-region start end)
6767 ;; ;; Discard undo information for the text insertion itself
6768 ;; ;; and for the text deletion.above.
6769 ;; (when (consp buffer-undo-list)
6770 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6771 ;; (message "You cannot modify the prompt")))
6772 ;;
6773 ;;
6774 ;;(setq minibuffer-prompt-properties
6775 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6776 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6778 \f
6779 ;;;; Problematic external packages.
6781 ;; rms says this should be done by specifying symbols that define
6782 ;; versions together with bad values. This is therefore not as
6783 ;; flexible as it could be. See the thread:
6784 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6785 (defconst bad-packages-alist
6786 ;; Not sure exactly which semantic versions have problems.
6787 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6789 "The version of `semantic' loaded does not work in Emacs 22.
6790 It can cause constant high CPU load.
6791 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6792 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6793 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6794 ;; provided the `CUA-mode' feature. Since this is no longer true,
6795 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6796 (CUA-mode t nil
6797 "CUA-mode is now part of the standard GNU Emacs distribution,
6798 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6800 You have loaded an older version of CUA-mode which does not work
6801 correctly with this version of Emacs. You should remove the old
6802 version and use the one distributed with Emacs."))
6803 "Alist of packages known to cause problems in this version of Emacs.
6804 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6805 PACKAGE is either a regular expression to match file names, or a
6806 symbol (a feature name); see the documentation of
6807 `after-load-alist', to which this variable adds functions.
6808 SYMBOL is either the name of a string variable, or `t'. Upon
6809 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6810 warning using STRING as the message.")
6812 (defun bad-package-check (package)
6813 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6814 (condition-case nil
6815 (let* ((list (assoc package bad-packages-alist))
6816 (symbol (nth 1 list)))
6817 (and list
6818 (boundp symbol)
6819 (or (eq symbol t)
6820 (and (stringp (setq symbol (eval symbol)))
6821 (string-match-p (nth 2 list) symbol)))
6822 (display-warning package (nth 3 list) :warning)))
6823 (error nil)))
6825 (mapc (lambda (elem)
6826 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6827 bad-packages-alist)
6830 (provide 'simple)
6832 ;;; simple.el ends here