| blob | 5b4f267ebe3a5623af95243aa6bed8fb2c153d07 |
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."
85 "Highlighting of locations in `next-error-no-select'.
86 If number, highlight the locus in `next-error' face for given time in seconds.
87 If t, highlight the locus indefinitely until some other locus replaces it.
88 If nil, don't highlight the locus in the source buffer.
89 If `fringe-arrow', indicate the locus by the fringe arrow."
98 "Display the line in the visited source file recentered as specified.
99 If non-nil, the value is passed directly to `recenter'."
107 "List of hook functions run by `next-error' after visiting source file."
118 "The most recent `next-error' buffer.
119 A buffer becomes most recent when its compilation, grep, or
124 "Function to use to find the next error in the current buffer.
125 The function is called with 2 parameters:
126 ARG is an integer specifying by how many errors to move.
127 RESET is a boolean which, if non-nil, says to go back to the beginning
128 of the errors before moving.
129 Major modes providing compile-like functionality should set this variable
130 to indicate to `next-error' that this is a candidate buffer and how
135 "Function to use to move to an error locus.
136 It takes two arguments, a buffer position in the error buffer
137 and a buffer position in the error locus buffer.
138 The buffer for the error locus should already be current.
143 &optional avoid-current
144 extra-test-inclusive
145 extra-test-exclusive)
146 "Test if BUFFER is a `next-error' capable buffer.
148 If AVOID-CURRENT is non-nil, treat the current buffer
149 as an absolute last resort only.
151 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
152 that normally would not qualify. If it returns t, the buffer
153 in question is treated as usable.
155 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
156 that would normally be considered usable. If it returns nil,
157 that buffer is rejected."
162 ;; Optionally reject some buffers.
165 t)
166 ;; Optionally accept some other buffers.
171 extra-test-inclusive
172 extra-test-exclusive)
173 "Return a `next-error' capable buffer.
175 If AVOID-CURRENT is non-nil, treat the current buffer
176 as an absolute last resort only.
178 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
179 that normally would not qualify. If it returns t, the buffer
180 in question is treated as usable.
182 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
183 that would normally be considered usable. If it returns nil,
184 that buffer is rejected."
186 ;; 1. If one window on the selected frame displays such buffer, return it.
192 avoid-current
193 extra-test-inclusive extra-test-exclusive)
198 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
201 extra-test-inclusive extra-test-exclusive))
202 next-error-last-buffer)
203 ;; 3. If the current buffer is acceptable, choose it.
205 extra-test-inclusive extra-test-exclusive)
207 ;; 4. Look for any acceptable buffer.
212 extra-test-inclusive extra-test-exclusive)))
215 ;; 5. Use the current buffer as a last resort if it qualifies,
216 ;; even despite AVOID-CURRENT.
219 extra-test-inclusive extra-test-exclusive)
223 ;; 6. Give up.
227 "Visit next `next-error' message and corresponding source code.
229 If all the error messages parsed so far have been processed already,
230 the message buffer is checked for new ones.
232 A prefix ARG specifies how many error messages to move;
233 negative means move back to previous error messages.
235 and start at the first error.
237 The RESET argument specifies that we should restart from the beginning.
240 compilation, grep, or occur buffer. It can also operate on any
242 more generally, on any buffer in Compilation mode or with
243 Compilation Minor mode enabled, or any buffer in which
244 `next-error-function' is bound to an appropriate function.
245 To specify use of a particular buffer for error messages, type
247 in the current frame.
250 runs `next-error-hook' with `run-hooks', and stays with that buffer
251 until you use it in some other buffer which uses Compilation mode
252 or Compilation Minor mode.
254 To control which errors are matched, customize the variable
255 `compilation-error-regexp-alist'."
259 ;; we know here that next-error-function is a valid symbol we can funcall
267 "Visit the source code corresponding to the `next-error' message at point."
269 ;; we know here that next-error-function is a valid symbol we can funcall
280 "Visit previous `next-error' message and corresponding source code.
282 Prefix arg N says how many error messages to move backwards (or
283 forwards, if negative).
290 "Restart at the first error.
291 Visit corresponding source code.
292 With prefix arg N, visit the source code of the Nth error.
298 "Move point to the next error in the `next-error' buffer and highlight match.
299 Prefix arg N says how many error messages to move forwards (or
300 backwards, if negative).
302 select the source buffer."
309 "Move point to the previous error in the `next-error' buffer and highlight match.
310 Prefix arg N says how many error messages to move backwards (or
311 forwards, if negative).
313 select the source buffer."
317 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
321 "Minor mode for compilation, occur and diff modes.
322 When turned on, cursor motion in the compilation, grep, occur or diff
323 buffer causes automatic display of the corresponding source code
324 location."
331 ;; Used as a `post-command-hook' by `next-error-follow-mode'
332 ;; for the *Compilation* *grep* and *Occur* buffers.
342 \f
343 ;;;
346 "Major mode not specialized for anything in particular.
347 Other major modes are defined by comparison with this one."
352 ;; Special major modes to view specially formatted data rather than files.
366 map))
370 "Parent major mode from which special major modes should inherit."
373 ;; Major mode meant to be the parent of programming modes.
378 map)
382 "Indent the expression after point."
389 "Major mode for editing programming language source code."
392 ;; Any programming language is always written left to right.
395 ;; Making and deleting lines.
401 "Insert a newline, and move to left margin of the new line if it's blank.
402 If `use-hard-newlines' is non-nil, the newline is marked with the
403 text-property `hard'.
404 With ARG, insert that many newlines.
405 Call `auto-fill-function' if the current column number is greater
406 than the value of `fill-column' and ARG is nil."
409 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
410 ;; Set last-command-event to tell self-insert what to insert.
414 ;; Don't auto-fill if we have a numeric argument.
417 ;; Do the rest in post-self-insert-hook, because we want to do it
418 ;; *before* other functions on that hook.
420 ;; Mark the newline(s) `hard'.
424 ;; If the newline leaves the previous line blank, and we
425 ;; have a left margin, delete that from the blank line.
433 ;; Indent the line after the newline, except in one case:
434 ;; when we added the newline at the beginning of a line which
435 ;; starts a page.
442 ;; We first used let-binding to protect the hook, but that was naive
443 ;; since add-hook affects the symbol-default value of the variable,
444 ;; whereas the let-binding might only protect the buffer-local value.
446 nil)
451 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
457 "Insert a newline and leave point before it.
458 If there is a fill prefix and/or a `left-margin', insert them
459 on the new line if the line would have been blank.
460 With arg N, insert N newlines."
465 ;; Don't expand an abbrev before point.
479 "Split current line, moving portion beyond point vertically down.
480 If the current line starts with `fill-prefix', insert it on the new
481 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
483 When called from Lisp code, ARG may be a prefix string to copy."
488 ;; What prefix should we check for (nil means don't).
492 ;; Does this line start with it?
503 "Join this line to previous and fix up whitespace at join.
504 If there is a fill prefix, delete it from the beginning of this line.
505 With argument, join this line to following line."
512 ;; If the second line started with the fill prefix,
513 ;; delete the prefix.
525 "On blank line, delete all surrounding blank lines, leaving just one.
526 On isolated blank line, delete that one.
527 On nonblank line, delete any immediately following blank lines."
533 ;; Set singleblank if there is just one blank line here.
540 ;; Delete preceding blank lines, and this one too if it's the only one.
549 ;; Delete following blank lines, unless the current line is blank
550 ;; and there are no following blank lines.
559 ;; Handle the special case where point is followed by newline and eob.
560 ;; Delete the line, leaving point at eob.
565 "Delete all the trailing whitespace across the current buffer.
566 All whitespace after the last non-whitespace character in a line is deleted.
568 A formfeed is not considered whitespace by this function.
569 If the region is active, only delete whitespace within the region."
582 ;; Don't delete formfeeds, even if they are considered whitespace.
588 ;; Return nil for the benefit of `write-file-functions'.
589 nil)
592 "Insert a newline, then indent according to major mode.
593 Indentation is done using the value of `indent-line-function'.
594 In programming language modes, this is the same as TAB.
595 In some text modes, where TAB inserts a tab, this command indents to the
596 column specified by the function `current-left-margin'."
603 "Reindent current line, insert newline, then indent the new line.
604 Indentation of both lines is done according to the current major mode,
605 which means calling the current value of `indent-line-function'.
606 In programming language modes, this is the same as TAB.
607 In some text modes, where TAB inserts a tab, this indents to the
608 column specified by the function `current-left-margin'."
611 ;; Be careful to insert the newline before indenting the line.
612 ;; Otherwise, the indentation might be wrong.
616 ;; We are at EOL before the call to indent-according-to-mode, and
617 ;; after it we usually are as well, but not always. We tried to
618 ;; address it with `save-excursion' but that uses a normal marker
619 ;; whereas we need `move after insertion', so we do the save/restore
620 ;; by hand.
624 ;; Remove the trailing white-space after indentation because
625 ;; indentation may introduce the whitespace.
630 "Read next input character and insert it.
631 This is useful for inserting control characters.
632 With argument, insert ARG copies of the character.
634 If the first character you type after this command is an octal digit,
635 you should type a sequence of octal digits which specify a character code.
636 Any nondigit terminates the sequence. If the terminator is a RET,
637 it is discarded; any other terminator is used itself as input.
638 The variable `read-quoted-char-radix' specifies the radix for this feature;
639 set it to 10 or 16 to use decimal or hex instead of octal.
641 In overwrite mode, this function inserts the character anyway, and
642 does not handle octal digits specially. This means that if you use
643 overwrite as your normal editing mode, you can use this function to
644 insert characters when necessary.
646 In binary overwrite mode, this function does overwrite, and octal
647 digits are interpreted as a character code. This is intended to be
648 useful for editing binary files."
651 ;; Avoid "obsolete" warnings for translation-table-for-input.
658 ;; This used to assume character codes 0240 - 0377 stand for
659 ;; characters in some single-byte character set, and converted them
660 ;; to Emacs characters. But in 23.1 this feature is deprecated
661 ;; in favor of inserting the corresponding Unicode characters.
662 ;; (if (and enable-multibyte-characters
663 ;; (>= char ?\240)
664 ;; (<= char ?\377))
665 ;; (setq char (unibyte-char-to-multibyte char)))
674 "Move forward ARG lines and position at first nonblank character."
680 "Move backward ARG lines and position at first nonblank character."
686 "Move point to the first non-whitespace character on this line."
690 ;; Move back over chars that have whitespace syntax but have the p flag.
694 "Fixup white space between objects around point.
695 Leave one space or none, according to the context."
702 nil
706 "Delete all spaces and tabs around point.
707 If BACKWARD-ONLY is non-nil, only delete them before point."
712 orig-pos
721 "Delete all spaces and tabs around point, leaving one space (or N spaces).
722 If N is negative, delete newlines as well."
739 \f
741 "Move point to the beginning of the buffer.
742 With numeric arg N, put point N/10 of the way from the beginning.
743 If the buffer is narrowed, this command uses the beginning of the
744 accessible part of the buffer.
746 If Transient Mark mode is disabled, leave mark at previous
749 Don't use this command in Lisp programs!
750 \(goto-char (point-min)) is faster."
759 ;; Avoid overflow for large buffer sizes!
767 "Move point to the end of the buffer.
768 With numeric arg N, put point N/10 of the way from the end.
769 If the buffer is narrowed, this command uses the end of the
770 accessible part of the buffer.
772 If Transient Mark mode is disabled, leave mark at previous
775 Don't use this command in Lisp programs!
776 \(goto-char (point-max)) is faster."
783 ;; Avoid overflow for large buffer sizes!
788 ;; If we went to a place in the middle of the buffer,
789 ;; adjust it to the beginning of a line.
792 ;; If the end of the buffer is not already on the screen,
793 ;; then scroll specially to put it near, but not at, the bottom.
798 "Whether single-char deletion commands delete an active region.
799 This has an effect only if Transient Mark mode is enabled, and
800 affects `delete-forward-char' and `delete-backward-char', though
801 not `delete-char'.
803 If the value is the symbol `kill', the active region is killed
804 instead of deleted."
812 "Delete the previous N characters (following if N is negative).
813 If Transient Mark mode is enabled, the mark is active, and N is 1,
814 delete the text in the region and deactivate the mark instead.
815 To disable this, set `delete-active-region' to nil.
817 Optional second arg KILLFLAG, if non-nil, means to kill (save in
818 kill ring) instead of delete. Interactively, N is the prefix
819 arg, and KILLFLAG is set if N is explicitly specified.
821 In Overwrite mode, single character backward deletion may replace
822 tabs with spaces so as to back over columns, unless point is at
823 the end of the line."
828 delete-active-region
830 ;; If a region is active, kill or delete it.
834 ;; In Overwrite mode, maybe untabify while deleting
844 ;; Otherwise, do simple deletion.
848 "Delete the following N characters (previous if N is negative).
849 If Transient Mark mode is enabled, the mark is active, and N is 1,
850 delete the text in the region and deactivate the mark instead.
851 To disable this, set `delete-active-region' to nil.
853 Optional second arg KILLFLAG non-nil means to kill (save in kill
854 ring) instead of delete. Interactively, N is the prefix arg, and
855 KILLFLAG is set if N was explicitly specified."
860 delete-active-region
862 ;; If a region is active, kill or delete it.
866 ;; Otherwise, do simple deletion.
870 "Put point at beginning and mark at end of buffer.
871 You probably should not use this function in Lisp programs;
872 it is usually a mistake for a Lisp function to use any subroutine
873 that uses or sets the mark."
878 \f
880 ;; Counting lines, one way or another.
883 "Goto LINE, counting from line 1 at beginning of buffer.
884 Normally, move point in the current buffer, and leave mark at the
886 move point in the most recently selected other buffer, and switch to it.
888 If there's a number in the buffer at point, it is the default for LINE.
890 This function is usually the wrong thing to use in a Lisp program.
891 What you probably want instead is something like:
892 (goto-char (point-min)) (forward-line (1- N))
893 If at all possible, an even better solution is to use char counts
894 rather than line counts."
898 ;; Look for a default, a number in the buffer at point.
907 ;; Decide if we're switching buffers.
915 ;; Read the argument, offering that number (if any) as default.
918 buffer-prompt
919 default)
920 nil nil t
921 'minibuffer-history
922 default)
923 buffer))))
924 ;; Switch to the desired buffer, one way or another.
930 ;; Leave mark at previous position
932 ;; Move to the specified line number in that buffer.
941 "Print the number of words in the region.
942 When called interactively, the word count is printed in echo area."
953 count))
956 "Print number of lines and characters in the region."
962 "Print the current buffer line number and narrowed line number of point."
975 "Return number of lines between START and END.
976 This is usually the number of newlines between them,
977 but can be one more if START is not equal to END
978 and the greater of them is not at the start of a line."
994 done)))
998 "Return (narrowed) buffer line number at position POS.
999 If POS is nil, use current buffer location.
1000 Counting starts at (point-min), so the value refers
1001 to the contents of the accessible portion of the buffer."
1011 "Print info on cursor position (on screen and within buffer).
1012 Also describe the character after point, and give its character code
1013 in octal, decimal and hex.
1015 For a non-ASCII multibyte character, also give its encoding in the
1016 buffer's selected coding system if the coding system encodes the
1017 character safely. If the character is encoded into one byte, that
1018 code is shown in hex. If the character is encoded into more than one
1021 In addition, with prefix argument, show details about that character
1022 in *Help* buffer. See also the command `describe-char'."
1030 ;; Avoid overflow from multiplying by 100!
1034 ""
1040 pos total percent beg end col hscroll)
1042 pos total col hscroll))
1044 encoded encoding-msg display-prop under-display)
1051 ;; Check if the character is displayed with some `display'
1052 ;; text property. In that case, set under-display to the
1053 ;; buffer substring covered by that property.
1064 under-display)))
1070 char char char under-display)
1072 char char char under-display display-prop))
1075 char char char
1077 "..."
1081 ;; We show the detailed information about CHAR.
1088 encoding-msg pos total percent beg end col hscroll)
1095 encoding-msg pos total percent col hscroll))))))
1096 \f
1097 ;; Initialize read-expression-map. It is defined at C level.
1100 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1101 ;; too rarely useful.
1111 "The current default value or list of default values in the minibuffer.
1112 The functions `read-from-minibuffer' and `completing-read' bind
1116 "Value for `print-level' while printing value in `eval-expression'.
1117 A value of nil means no limit."
1123 "Value for `print-length' while printing value in `eval-expression'.
1124 A value of nil means no limit."
1130 "If non-nil set `debug-on-error' to t in `eval-expression'.
1131 If nil, don't change the value of `debug-on-error'."
1137 "Format VALUE as a result of evaluated expression.
1138 Return a formatted string which is displayed in the echo area
1139 in addition to the value printed by prin1 in functions which
1140 display the result of expression evaluation."
1153 ;; We define this, rather than making `eval' interactive,
1154 ;; for the sake of completion of names like eval-region, eval-buffer.
1157 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1158 Value is also consed on to front of the variable `values'.
1159 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1160 with prefix argument) means insert the result into the current buffer
1161 instead of printing it in the echo area. Truncates long output
1162 according to the value of the variables `eval-expression-print-length'
1163 and `eval-expression-print-level'.
1165 If `eval-expression-debug-on-error' is non-nil, which is the default,
1166 this command arranges for all errors to enter the debugger."
1170 nil read-expression-map t
1172 current-prefix-arg))
1177 ;; Bind debug-on-error to something unique so that we can
1178 ;; detect when evaled code changes it.
1182 ;; If evaled code has changed the value of debug-on-error,
1183 ;; propagate that change to the global binding.
1199 "Prompting with PROMPT, let user edit COMMAND and eval result.
1200 COMMAND is a Lisp expression. Let user edit that expression in
1201 the minibuffer, then read and evaluate the result."
1208 read-expression-map t
1210 ;; If command was added to command-history as a string,
1211 ;; get rid of that. We want only evaluable expressions there.
1215 ;; If command to be redone does not match front of history,
1216 ;; add it to the history.
1222 "Edit and re-evaluate last complex command, or ARGth from last.
1223 A complex command is one which used the minibuffer.
1224 The command is placed in the minibuffer as a Lisp form for editing.
1225 The result is executed, repeating the command as changed.
1226 If the command has been changed or is not the most recent previous
1227 command it is added to the front of the command history.
1228 You can use the minibuffer history commands \
1230 to get different commands to edit and resubmit."
1233 newcmd)
1245 ;; If command was added to command-history as a
1246 ;; string, get rid of that. We want only
1247 ;; evaluable expressions there.
1251 ;; If command to be redone does not match front of history,
1252 ;; add it to the history.
1261 "Read command name to invoke in `execute-extended-command'."
1266 ;; Get a command name at point in the original buffer
1267 ;; to propose it after M-n.
1271 ;; Read a string, completing from and restricting to the set of
1272 ;; all defined commands. Don't provide any initial input.
1273 ;; Save the command read on the extended-command history list.
1284 ;; This isn't strictly correct if `execute-extended-command'
1285 ;; is bound to anything else (e.g. [menu]).
1286 ;; It could use (key-description (this-single-command-keys)),
1287 ;; but actually a prompt other than "M-x" would be confusing,
1288 ;; because "M-x" is a well-known prompt to read a command
1289 ;; and it serves as a shorthand for "Extended command: ".
1293 \f
1295 "Default minibuffer history list.
1296 This is used for all minibuffer input
1297 except when an alternate history list is specified.
1299 Maximum length of the history list is determined by the value
1302 "Control whether history list elements are expressions or strings.
1303 If the value of this variable equals current minibuffer depth,
1304 they are expressions; otherwise they are strings.
1305 \(That convention is designed to do the right thing for
1312 "Text that was in this minibuffer before any history commands.
1313 This is nil if there have not yet been any history commands
1322 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1326 "Minibuffer history variables for which matching should ignore case.
1327 If a history variable is a member of this list, then the
1329 commands ignore case when searching it, regardless of `case-fold-search'."
1334 "Find the previous history element that matches REGEXP.
1335 \(Previous history elements refer to earlier actions.)
1336 With prefix argument N, search for Nth previous match.
1337 If N is negative, find the next or Nth next match.
1338 Normally, history elements are matched case-insensitively if
1339 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1340 makes the search case-sensitive.
1341 See also `minibuffer-history-case-insensitive-variables'."
1345 nil
1346 minibuffer-local-map
1347 nil
1348 'minibuffer-history-search-history
1350 ;; Use the last regexp specified, by default, if input is empty.
1355 regexp)
1365 ;; On some systems, ignore case for file names.
1367 minibuffer-history-case-insensitive-variables)
1368 t
1369 ;; Respect the user's setting for case-fold-search:
1370 case-fold-search)
1371 nil))
1372 prevpos
1373 match-string
1374 match-offset
1381 "No later matching history item"
1402 next-matching-history-element))
1406 "Find the next history element that matches REGEXP.
1407 \(The next history element refers to a more recent action.)
1408 With prefix argument N, search for Nth next match.
1409 If N is negative, find the previous or Nth previous match.
1410 Normally, history elements are matched case-insensitively if
1411 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1412 makes the search case-sensitive."
1416 nil
1417 minibuffer-local-map
1418 nil
1419 'minibuffer-history-search-history
1421 ;; Use the last regexp specified, by default, if input is empty.
1426 regexp)
1433 "Function run by `goto-history-element' before consuming default values.
1434 This is useful to dynamically add more elements to the list of default values
1435 when `goto-history-element' reaches the end of this list.
1436 Before calling this function `goto-history-element' sets the variable
1437 `minibuffer-default-add-done' to t, so it will call this function only
1438 once. In special cases, when this function needs to be called more
1439 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1443 "When nil, add more elements to the end of the list of default values.
1444 The value nil causes `goto-history-element' to add more elements to
1445 the list of defaults when it reaches the end of this list. It does
1451 "Return a list of all completions without the default value.
1452 This function is used to add all elements of the completion table to
1453 the end of the list of defaults just after the default value."
1456 minibuffer-completion-table
1457 minibuffer-completion-predicate)))
1463 "Puts element of the minibuffer history in the minibuffer.
1464 The argument NABS specifies the absolute history position."
1478 elt minibuffer-returned-to-present)
1490 previous-history-element))
1502 minibuffer-default)))
1514 elt))
1518 "Puts next element of the minibuffer history in the minibuffer.
1519 With argument N, it uses the Nth following element."
1525 "Puts previous element of the minibuffer history in the minibuffer.
1526 With argument N, it uses the Nth previous element."
1532 "Get next history element which completes the minibuffer before the point.
1533 The contents of the minibuffer after the point are deleted, and replaced
1534 by the new completion."
1540 n)
1541 ;; next-matching-history-element always puts us at (point-min).
1542 ;; Move to the position we were at before changing the buffer contents.
1543 ;; This is still sensical, because the text before point has not changed.
1547 "\
1548 Get previous history element which completes the minibuffer before the point.
1549 The contents of the minibuffer after the point are deleted, and replaced
1550 by the new completion."
1554 ;; For compatibility with the old subr of the same name.
1556 "Return the display width of the minibuffer prompt.
1557 Return 0 if current buffer is not a minibuffer."
1558 ;; Return the width of everything before the field at the end of
1559 ;; the buffer; this should be 0 for normal buffers.
1561 \f
1562 ;; isearch minibuffer history
1569 "Set up a minibuffer for using isearch to search the minibuffer history.
1570 Intended to be added to `minibuffer-setup-hook'."
1582 "Clean up the minibuffer after terminating isearch in the minibuffer."
1587 "Return the proper search function, for isearch in minibuffer history."
1594 ;; Use standard functions to search within minibuffer text
1600 found)
1601 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1602 ;; searching forward. Lazy-highlight calls this lambda with the
1603 ;; bound arg, so skip the minibuffer prompt.
1607 ;; 1. First try searching in the initial minibuffer text
1610 noerror)
1611 ;; 2. If the above search fails, start putting next/prev history
1612 ;; elements in the minibuffer successively, and search the string
1613 ;; in them. Do this only when bound is nil (i.e. not while
1614 ;; lazy-highlighting search strings in the current minibuffer text).
1626 ;; After putting the next/prev history element, search
1627 ;; the string in them again, until next-history-element
1628 ;; or previous-history-element raises an error at the
1629 ;; beginning/end of history.
1632 ;; For backward search, don't search
1633 ;; in the minibuffer prompt
1635 noerror)))
1636 ;; Return point of the new search result
1638 ;; Return nil when next(prev)-history-element fails
1642 "Display the minibuffer history search prompt.
1643 If there are no search errors, this function displays an overlay with
1644 the isearch prompt which replaces the original minibuffer prompt.
1645 Otherwise, it displays the standard isearch message returned from
1646 `isearch-message'."
1648 ;; Use standard function `isearch-message' when not in the minibuffer,
1649 ;; or search fails, or has an error (like incomplete regexp).
1650 ;; This function overwrites minibuffer text with isearch message,
1651 ;; so it's possible to see what is wrong in the search string.
1653 ;; Otherwise, put the overlay with the standard isearch prompt over
1654 ;; the initial minibuffer prompt.
1663 ;; And clear any previous isearch message.
1667 "Wrap the minibuffer history search when search fails.
1668 Move point to the first history element for a forward search,
1669 or to the last history element for a backward search."
1671 ;; When `minibuffer-history-isearch-search' fails on reaching the
1672 ;; beginning/end of the history, wrap the search to the first/last
1673 ;; minibuffer history element.
1681 "Save a function restoring the state of minibuffer history search.
1682 Save `minibuffer-history-position' to the additional state parameter
1683 in the search status stack."
1688 "Restore the minibuffer history search state.
1689 Go to the history element by the absolute history position HIST-POS."
1692 \f
1693 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1697 "Table mapping redo records to the corresponding undo one.
1698 A redo record for undo-in-region maps to t.
1708 "Within a run of consecutive undo commands, list remaining to be undone.
1712 "Undo some previous changes.
1713 Repeat this command to undo more changes.
1714 A numeric ARG serves as a repeat count.
1716 In Transient Mark mode when the mark is active, only undo changes within
1718 as an argument limits undo to changes within the current region."
1720 ;; Make last-command indicate for the next command that this was an undo.
1721 ;; That way, another undo will undo more.
1722 ;; If we get to the end of the undo history and get an error,
1723 ;; another undo command will find the undo history empty
1724 ;; and will get another error. To begin undoing the undos,
1725 ;; you must type some other command.
1728 message)
1729 ;; If we get an error in undo-start,
1730 ;; the next command should not be a "consecutive undo".
1731 ;; So set `this-command' to something other than `undo'.
1736 ;; If something (a timer or filter?) changed the buffer
1737 ;; since the previous command, don't continue the undo seq.
1741 ;; If the last undo record made was made by undo
1742 ;; it shows nothing else happened in between.
1749 ;; get rid of initial undo boundary
1751 ;; If we got this far, the next command should be a consecutive undo.
1753 ;; Check to see whether we're hitting a redo record, and if
1754 ;; so, ask the user whether she wants to skip the redo/undo pair.
1761 ;; The equiv entry might point to another redo record if we have done
1762 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1770 ;; Record the fact that the just-generated undo records come from an
1771 ;; undo operation--that is, they are redo records.
1772 ;; In the ordinary case (not within a region), map the redo
1773 ;; record to the following undos.
1774 ;; I don't know how to do that in the undo-in-region case.
1776 ;; Strip any leading undo boundaries there might be, like we do
1777 ;; above when checking.
1781 undo-equiv-table))
1782 ;; Don't specify a position in the undo record for the undo command.
1783 ;; Instead, undoing this should move point to where the change is.
1802 ;; Record what the current undo list says,
1803 ;; so the next command can tell if the buffer was modified in between.
1806 ;; Display a message announcing success.
1811 "Make BUFFER stop keeping undo information.
1812 No argument or nil as argument means do this for the current buffer."
1818 "Undo some previous changes.
1819 Repeat this command to undo more changes.
1820 A numeric ARG serves as a repeat count.
1821 Contrary to `undo', this will not redo a previous undo."
1826 "Non-nil while performing an undo.
1830 "Undo back N undo-boundaries beyond what was already undone recently.
1831 Call `undo-start' to get ready to undo recent changes,
1832 then call `undo-more' one or more times to undo them."
1837 ;; Note: The following, while pulling elements off
1838 ;; `pending-undo-list' will call primitive change functions which
1839 ;; will push more elements onto `buffer-undo-list'.
1844 ;; Deep copy of a list
1846 "Make a copy of undo list LIST."
1852 elt))
1855 "Set `pending-undo-list' to the front of the undo list.
1856 The next call to `undo-more' will undo the most recently made change.
1857 If BEG and END are specified, then only undo elements
1858 that apply to text between BEG and END are used; other undo elements
1859 are ignored. If BEG and END are nil, all undo elements are used."
1865 buffer-undo-list)))
1870 "Return a list of undo elements for the region START to END.
1871 The elements come from `buffer-undo-list', but we keep only
1872 the elements inside this region, and discard those outside this region.
1873 If we find an element that crosses an edge of this region,
1874 we stop and ignore all further elements."
1877 undo-adjusted-markers
1878 some-rejected
1879 undo-elt temp-undo-list delta)
1884 ;; This is a "was unmodified" element.
1885 ;; Keep it if we have kept everything thus far.
1892 ;; Don't put two nils together in the list
1906 ;; Loop down the earlier events adjusting their buffer
1907 ;; positions to reflect the fact that a change to the buffer
1908 ;; isn't being undone. We only need to process those element
1909 ;; types which undo-elt-in-region will return as being in
1910 ;; the region since only those types can ever get into the
1911 ;; output
1920 ;; (TEXT . POSITION)
1927 ;; (BEGIN . END)
1932 ;; (nil PROPERTY VALUE BEG . END)
1942 "Determine whether UNDO-ELT falls inside the region START ... END.
1943 If it crosses the edge, we return nil."
1948 t)
1950 nil)
1952 ;; (TEXT . POSITION)
1956 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1957 ;; See if MARKER is inside the region.
1968 ;; (nil PROPERTY VALUE BEG . END)
1973 ;; (BEGIN . END)
1978 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1979 This assumes we have already decided that UNDO-ELT
1980 is not *inside* the region START...END."
1983 ;; (nil PROPERTY VALUE BEG . END)
1988 ;; (BEGIN . END)
1992 ;; Return the first affected buffer position and the delta for an undo element
1993 ;; delta is defined as the change in subsequent buffer positions if we *did*
1994 ;; the undo.
1998 ;; (TEXT . POSITION)
2001 ;; (BEGIN . END)
2008 "If non-nil ask about discarding undo info for the current command.
2009 Normally, Emacs discards the undo info for the current command if
2010 it exceeds `undo-outer-limit'. But if you set this option
2011 non-nil, it asks in the echo area whether to discard the info.
2012 If you answer no, there is a slight risk that Emacs might crash, so
2013 only do it if you really want to undo the command.
2015 This option is mainly intended for debugging. You have to be
2016 careful if you use it for other purposes. Garbage collection is
2017 inhibited while the question is asked, meaning that Emacs might
2018 leak memory. So you should make sure that you do not wait
2019 excessively long before answering the question."
2025 "If non-nil, an extra level of size that's ok in an undo item.
2026 We don't ask the user about truncating the undo list until the
2027 current item gets bigger than this amount.
2032 ;; When the first undo batch in an undo list is longer than
2033 ;; undo-outer-limit, this function gets called to warn the user that
2034 ;; the undo info for the current command was discarded. Garbage
2035 ;; collection is inhibited around the call, so it had better not do a
2036 ;; lot of consing.
2042 ;; Don't ask the question again unless it gets even bigger.
2043 ;; This applies, in particular, if the user quits from the question.
2044 ;; Such a quit quits out of GC, but something else will call GC
2045 ;; again momentarily. It will call this function again,
2046 ;; but we don't want to ask the question again.
2053 t)
2054 nil))
2059 "The undo info was discarded because it exceeded \
2060 `undo-outer-limit'.
2062 This is normal if you executed a command that made a huge change
2063 to the buffer. In that case, to prevent similar problems in the
2064 future, set `undo-outer-limit' to a value that is large enough to
2065 cover the maximum size of normal changes you expect a single
2066 command to make, but not so large that it might exceed the
2067 maximum memory allotted to Emacs.
2069 If you did not execute any such command, the situation is
2070 probably due to a bug and you should report it.
2072 You can disable the popping up of this buffer by adding the entry
2073 \(undo discard-info) to the user option `warning-suppress-types',
2077 t))
2078 \f
2080 "History list for some commands that read shell commands.
2082 Maximum length of the history list is determined by the value
2089 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2090 This buffer is used when `shell-command' or `shell-command-on-region'
2091 is run interactively. A value of nil means that output to stderr and
2098 "Return a list of all commands associated with the current file.
2099 This function is used to add all related commands retrieved by `mailcap'
2100 to the end of the list of defaults just after the default value."
2104 minibuffer-default))
2109 commands))
2120 map)
2124 "Read a shell command from the minibuffer.
2125 The arguments are the same as the ones of `read-from-minibuffer',
2126 except READ and KEYMAP are missing and HIST defaults
2127 to `shell-command-history'."
2135 minibuffer-local-shell-command-map
2136 nil
2138 args)))
2141 "Execute string COMMAND asynchronously in background.
2143 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2144 surrounded by whitespace and executes the command asynchronously.
2145 The output appears in the buffer `*Async Shell Command*'.
2147 In Elisp, you will often be better served by calling `start-process'
2148 directly, since it offers more control and does not impose the use of a
2149 shell (with its need to quote arguments)."
2155 current-prefix-arg
2156 shell-command-default-error-buffer))
2162 "Execute string COMMAND in inferior shell; display output, if any.
2163 With prefix argument, insert the COMMAND's output at point.
2165 If COMMAND ends in ampersand, execute it asynchronously.
2166 The output appears in the buffer `*Async Shell Command*'.
2167 That buffer is in shell mode.
2169 Otherwise, COMMAND is executed synchronously. The output appears in
2170 the buffer `*Shell Command Output*'. If the output is short enough to
2171 display in the echo area (which is determined by the variables
2172 `resize-mini-windows' and `max-mini-window-height'), it is shown
2173 there, but it is nonetheless available in buffer `*Shell Command
2174 Output*' even though that buffer is not automatically displayed.
2176 To specify a coding system for converting non-ASCII characters
2178 before this command.
2180 Noninteractive callers can specify coding systems by binding
2181 `coding-system-for-read' and `coding-system-for-write'.
2183 The optional second argument OUTPUT-BUFFER, if non-nil,
2184 says to put the output in some other buffer.
2185 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2186 If OUTPUT-BUFFER is not a buffer and not nil,
2187 insert output in current buffer. (This cannot be done asynchronously.)
2188 In either case, the buffer is first erased, and the output is
2189 inserted after point (leaving mark after it).
2191 If the command terminates without error, but generates output,
2193 the output can be displayed in the echo area or in its buffer.
2194 If the output is short enough to display in the echo area
2195 \(determined by the variable `max-mini-window-height' if
2196 `resize-mini-windows' is non-nil), it is shown there.
2197 Otherwise,the buffer containing the output is displayed.
2201 of the output.
2203 If there is no output, or if output is inserted in the current buffer,
2204 then `*Shell Command Output*' is deleted.
2206 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2207 or buffer name to which to direct the command's standard error output.
2208 If it is nil, error output is mingled with regular output.
2209 In an interactive call, the variable `shell-command-default-error-buffer'
2210 specifies the value of ERROR-BUFFER.
2212 In Elisp, you will often be better served by calling `call-process' or
2213 `start-process' directly, since it offers more control and does not impose
2214 the use of a shell (with its need to quote arguments)."
2225 current-prefix-arg
2226 shell-command-default-error-buffer))
2227 ;; Look for a handler in case default-directory is a remote file name.
2235 ;; Output goes in current buffer.
2241 temporary-file-directory)))
2242 nil)))
2245 ;; We do not use -f for csh; we will not support broken use of
2246 ;; .cshrcs. Even the BSD csh manual says to use
2247 ;; "if ($?prompt) exit" before things which are not useful
2248 ;; non-interactively. Besides, if someone wants their other
2249 ;; aliases for shell commands then they can still have them.
2253 t)
2254 nil shell-command-switch command)
2261 ;; Do no formatting while reading error file,
2262 ;; because that can run a shell command, and we
2263 ;; don't want that to cause an infinite recursion.
2265 ;; Put point after the inserted errors.
2269 ;; This is like exchange-point-and-mark, but doesn't
2270 ;; activate the mark. It is cleaner to avoid activation,
2271 ;; even though the command loop would deactivate the mark
2272 ;; because we inserted text.
2276 ;; Output goes in a separate buffer.
2277 ;; Preserve the match data in case called from a program.
2280 ;; Command ending with ampersand means asynchronous.
2284 proc)
2285 ;; Remove the ampersand.
2287 ;; If will kill a process, query first.
2295 ;; Setting buffer-read-only to nil doesn't suffice
2296 ;; if some text has a non-nil read-only property,
2297 ;; which comint sometimes adds for prompts.
2303 shell-command-switch command))
2307 ;; Use the comint filter for proper handling of carriage motion
2308 ;; (see `comint-inhibit-carriage-motion'),.
2310 ))
2311 ;; Otherwise, command is executed synchronously.
2313 output-buffer nil error-buffer)))))))
2317 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2318 MESSAGE may be either a string or a buffer.
2320 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2321 the maximum height of the echo area, as defined by `max-mini-window-height'
2322 if `resize-mini-windows' is non-nil.
2324 Returns either the string shown in the echo area, or when a pop-up
2325 buffer is used, the window used to display it.
2327 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2328 name of the buffer used to display it in the case where a pop-up buffer
2329 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2330 string and it is displayed in the echo area, it is not specified whether
2331 the contents are inserted into the buffer anyway.
2333 Optional argument NOT-THIS-WINDOW is as for `display-buffer', and
2334 only used if a buffer is displayed. Optional argument IGNORE is
2335 ignored."
2337 ;; Trivial case where we can use the echo area
2341 ;; Trivial case where we can just remove single trailing newline
2344 ;; General case
2347 message
2356 0
2360 (<= lines
2364 max-mini-window-height))
2366 max-mini-window-height)
2370 ;; Don't use the echo area if the output buffer is
2371 ;; already dispayed in the selected frame.
2373 ;; Echo area
2379 ;; Buffer
2384 ;; We have a sentinel to prevent insertion of a termination message
2385 ;; in the buffer itself.
2393 &optional output-buffer replace
2394 error-buffer display-error-buffer)
2395 "Execute string COMMAND in inferior shell with region as input.
2396 Normally display output (if any) in temp buffer `*Shell Command Output*';
2397 Prefix arg means replace the region with it. Return the exit code of
2398 COMMAND.
2400 To specify a coding system for converting non-ASCII characters
2402 before this command. By default, the input (from the current buffer)
2403 is encoded in the same coding system that will be used to save the file,
2404 `buffer-file-coding-system'. If the output is going to replace the region,
2405 then it is decoded from that same coding system.
2407 The noninteractive arguments are START, END, COMMAND,
2408 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2409 Noninteractive callers can specify coding systems by binding
2410 `coding-system-for-read' and `coding-system-for-write'.
2412 If the command generates output, the output may be displayed
2413 in the echo area or in a buffer.
2414 If the output is short enough to display in the echo area
2415 \(determined by the variable `max-mini-window-height' if
2416 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2417 it is displayed in the buffer `*Shell Command Output*'. The output
2418 is available in that buffer in both cases.
2420 If there is output and an error, a message about the error
2421 appears at the end of the output.
2423 If there is no output, or if output is inserted in the current buffer,
2424 then `*Shell Command Output*' is deleted.
2426 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2427 that says to put the output in some other buffer.
2428 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2429 If OUTPUT-BUFFER is not a buffer and not nil,
2430 insert output in the current buffer.
2431 In either case, the output is inserted after point (leaving mark after it).
2433 If REPLACE, the optional fifth argument, is non-nil, that means insert
2434 the output in place of text from START to END, putting point and mark
2435 around it.
2437 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2438 or buffer name to which to direct the command's standard error output.
2439 If it is nil, error output is mingled with regular output.
2440 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2441 were any errors. (This is always t, interactively.)
2442 In an interactive call, the variable `shell-command-default-error-buffer'
2443 specifies the value of ERROR-BUFFER."
2447 ;; Do this before calling region-beginning
2448 ;; and region-end, in case subprocess output
2449 ;; relocates them while we are in the minibuffer.
2451 ;; call-interactively recognizes region-beginning and
2452 ;; region-end specially, leaving them in the history.
2454 string
2455 current-prefix-arg
2456 current-prefix-arg
2457 shell-command-default-error-buffer
2458 t)))
2464 temporary-file-directory)))
2465 nil))
2466 exit-status)
2470 ;; Replace specified region with output from command.
2472 ;; Don't muck with mark unless REPLACE says we should.
2479 t)
2480 nil shell-command-switch command))
2481 ;; It is rude to delete a buffer which the command is not using.
2482 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2483 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2484 ;; (kill-buffer shell-buffer)))
2485 ;; Don't muck with mark unless REPLACE says we should.
2487 ;; No prefix argument: put the output in a temp buffer,
2488 ;; replacing its entire contents.
2493 ;; If the input is the same buffer as the output,
2494 ;; delete everything but the specified region,
2495 ;; then replace that region with the output.
2501 shell-file-name t
2504 t)
2505 nil shell-command-switch
2506 command)))
2507 ;; Clear the output buffer, then run the command with
2508 ;; output there.
2519 buffer)
2520 nil shell-command-switch command)))
2521 ;; Report the output.
2531 ;; There's some output, display it
2533 ;; No output; error?
2537 "some error output"
2543 output))
2546 exit-status))
2549 exit-status output))))
2550 ;; Don't kill: there might be useful info in the undo-log.
2551 ;; (kill-buffer buffer)
2552 ))))
2560 ;; Do no formatting while reading error file,
2561 ;; because that can run a shell command, and we
2562 ;; don't want that to cause an infinite recursion.
2564 ;; Put point after the inserted errors.
2569 exit-status))
2572 "Execute shell command COMMAND and return its output as a string."
2575 standard-output
2579 "Process files synchronously in a separate process.
2580 Similar to `call-process', but may invoke a file handler based on
2581 `default-directory'. The current working directory of the
2582 subprocess is `default-directory'.
2584 File names in INFILE and BUFFER are handled normally, but file
2585 names in ARGS should be relative to `default-directory', as they
2586 are passed to the process verbatim. \(This is a difference to
2587 `call-process' which does not support file handlers for INFILE
2588 and BUFFER.\)
2590 Some file handlers might not support all variants, for example
2591 they might behave as if DISPLAY was nil, regardless of the actual
2592 value passed."
2594 lc stderr-file)
2604 display args)
2610 "Whether a call of `process-file' changes remote files.
2612 Per default, this variable is always set to `t', meaning that a
2613 call of `process-file' could potentially change any file on a
2614 remote host. When set to `nil', a file handler could optimize
2615 its behaviour with respect to remote file attributes caching.
2617 This variable should never be changed by `setq'. Instead of, it
2621 "Start a program in a subprocess. Return the process object for it.
2623 Similar to `start-process', but may invoke a file handler based on
2624 `default-directory'. See Info node `(elisp)Magic File Names'.
2626 This handler ought to run PROGRAM, perhaps on the local host,
2627 perhaps on a remote host that corresponds to `default-directory'.
2628 In the latter case, the local part of `default-directory' becomes
2629 the working directory of the process.
2631 PROGRAM and PROGRAM-ARGS might be file names. They are not
2632 objects of file handler invocation. File handlers might not
2633 support pty association, if PROGRAM is nil."
2637 \f
2638 ;;;; Process menu
2650 "Major mode for listing the processes called by Emacs."
2662 "Recompute the list of processes for the Process List buffer."
2673 face link
2676 follow-link t
2677 process-buffer ,buf
2678 action process-menu-visit-buffer)
2687 "datagram"
2702 tabulated-list-entries)))))
2708 "Display a list of all processes.
2709 If optional argument QUERY-ONLY is non-nil, only processes with
2710 the query-on-exit flag set are listed.
2711 Any process listed as exited or signaled is actually eliminated
2712 after the listing is made.
2713 Optional argument BUFFER specifies a buffer to use, instead of
2715 The return value is always nil."
2727 nil)
2728 \f
2732 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2733 (define-key map [switch-frame] nil)
2734 (define-key map [?\C-u] 'universal-argument-more)
2735 (define-key map [?-] 'universal-argument-minus)
2736 (define-key map [?0] 'digit-argument)
2737 (define-key map [?1] 'digit-argument)
2738 (define-key map [?2] 'digit-argument)
2739 (define-key map [?3] 'digit-argument)
2740 (define-key map [?4] 'digit-argument)
2741 (define-key map [?5] 'digit-argument)
2742 (define-key map [?6] 'digit-argument)
2743 (define-key map [?7] 'digit-argument)
2744 (define-key map [?8] 'digit-argument)
2745 (define-key map [?9] 'digit-argument)
2746 (define-key map [kp-0] 'digit-argument)
2747 (define-key map [kp-1] 'digit-argument)
2748 (define-key map [kp-2] 'digit-argument)
2749 (define-key map [kp-3] 'digit-argument)
2750 (define-key map [kp-4] 'digit-argument)
2751 (define-key map [kp-5] 'digit-argument)
2752 (define-key map [kp-6] 'digit-argument)
2753 (define-key map [kp-7] 'digit-argument)
2754 (define-key map [kp-8] 'digit-argument)
2755 (define-key map [kp-9] 'digit-argument)
2756 (define-key map [kp-subtract] 'universal-argument-minus)
2757 map)
2760 (defvar universal-argument-num-events nil
2761 "Number of argument-specifying events read by `universal-argument'.
2762 `universal-argument-other-key' uses this to discard those events
2763 from (this-command-keys), and reread only the final command.")
2765 (defvar overriding-map-is-bound nil
2766 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2768 (defvar saved-overriding-map nil
2769 "The saved value of `overriding-terminal-local-map'.
2773 (defun ensure-overriding-map-is-bound ()
2774 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2775 (unless overriding-map-is-bound
2776 (setq saved-overriding-map overriding-terminal-local-map)
2777 (setq overriding-terminal-local-map universal-argument-map)
2778 (setq overriding-map-is-bound t)))
2780 (defun restore-overriding-map ()
2781 "Restore `overriding-terminal-local-map' to its saved value."
2782 (setq overriding-terminal-local-map saved-overriding-map)
2783 (setq overriding-map-is-bound nil))
2785 (defun universal-argument ()
2786 "Begin a numeric argument for the following command.
2791 multiplies the argument by 4 each time.
2793 which is different in effect from any particular numeric argument.
2795 (interactive)
2796 (setq prefix-arg (list 4))
2797 (setq universal-argument-num-events (length (this-command-keys)))
2798 (ensure-overriding-map-is-bound))
2800 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2801 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2802 (defun universal-argument-more (arg)
2803 (interactive "P")
2804 (if (consp arg)
2805 (setq prefix-arg (list (* 4 (car arg))))
2806 (if (eq arg '-)
2807 (setq prefix-arg (list -4))
2808 (setq prefix-arg arg)
2809 (restore-overriding-map)))
2810 (setq universal-argument-num-events (length (this-command-keys))))
2812 (defun negative-argument (arg)
2813 "Begin a negative numeric argument for the next command.
2815 (interactive "P")
2816 (cond ((integerp arg)
2817 (setq prefix-arg (- arg)))
2818 ((eq arg '-)
2819 (setq prefix-arg nil))
2820 (t
2821 (setq prefix-arg '-)))
2822 (setq universal-argument-num-events (length (this-command-keys)))
2823 (ensure-overriding-map-is-bound))
2825 (defun digit-argument (arg)
2826 "Part of the numeric argument for the next command.
2828 (interactive "P")
2829 (let* ((char (if (integerp last-command-event)
2830 last-command-event
2831 (get last-command-event 'ascii-character)))
2833 (cond ((integerp arg)
2834 (setq prefix-arg (+ (* arg 10)
2835 (if (< arg 0) (- digit) digit))))
2836 ((eq arg '-)
2837 ;; Treat -0 as just -, so that -01 will work.
2838 (setq prefix-arg (if (zerop digit) '- (- digit))))
2839 (t
2840 (setq prefix-arg digit))))
2841 (setq universal-argument-num-events (length (this-command-keys)))
2842 (ensure-overriding-map-is-bound))
2844 ;; For backward compatibility, minus with no modifiers is an ordinary
2845 ;; command if digits have already been entered.
2846 (defun universal-argument-minus (arg)
2847 (interactive "P")
2848 (if (integerp arg)
2849 (universal-argument-other-key arg)
2850 (negative-argument arg)))
2852 ;; Anything else terminates the argument and is left in the queue to be
2853 ;; executed as a command.
2854 (defun universal-argument-other-key (arg)
2855 (interactive "P")
2856 (setq prefix-arg arg)
2857 (let* ((key (this-command-keys))
2858 (keylist (listify-key-sequence key)))
2859 (setq unread-command-events
2860 (append (nthcdr universal-argument-num-events keylist)
2861 unread-command-events)))
2862 (reset-this-command-lengths)
2863 (restore-overriding-map))
2864 \f
2866 (defvar filter-buffer-substring-functions nil
2867 "Wrapper hook around `filter-buffer-substring'.
2868 The functions on this special hook are called with 4 arguments:
2869 NEXT-FUN BEG END DELETE
2870 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2871 that performs the default operation. The other 3 arguments are like
2872 the ones passed to `filter-buffer-substring'.")
2874 (defvar buffer-substring-filters nil
2875 "List of filter functions for `filter-buffer-substring'.
2876 Each function must accept a single argument, a string, and return
2877 a string. The buffer substring is passed to the first function
2878 in the list, and the return value of each function is passed to
2879 the next. The return value of the last function is used as the
2880 return value of `filter-buffer-substring'.
2882 If this variable is nil, no filtering is performed.")
2883 (make-obsolete-variable 'buffer-substring-filters
2884 'filter-buffer-substring-functions "24.1")
2886 (defun filter-buffer-substring (beg end &optional delete)
2887 "Return the buffer substring between BEG and END, after filtering.
2888 The filtering is performed by `filter-buffer-substring-functions'.
2890 If DELETE is non-nil, the text between BEG and END is deleted
2891 from the buffer.
2893 This function should be used instead of `buffer-substring',
2894 `buffer-substring-no-properties', or `delete-and-extract-region'
2895 when you want to allow filtering to take place. For example,
2896 major or minor modes can use `filter-buffer-substring-functions' to
2897 extract characters that are special to a buffer, and should not
2898 be copied into other buffers."
2899 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2900 (cond
2901 ((or delete buffer-substring-filters)
2902 (save-excursion
2903 (goto-char beg)
2904 (let ((string (if delete (delete-and-extract-region beg end)
2905 (buffer-substring beg end))))
2906 (dolist (filter buffer-substring-filters)
2907 (setq string (funcall filter string)))
2908 string)))
2909 (t
2910 (buffer-substring beg end)))))
2913 ;;;; Window system cut and paste hooks.
2915 (defvar interprogram-cut-function nil
2916 "Function to call to make a killed region available to other programs.
2918 Most window systems provide some sort of facility for cutting and
2919 pasting text between the windows of different programs.
2920 This variable holds a function that Emacs calls whenever text
2921 is put in the kill ring, to make the new kill available to other
2922 programs.
2924 The function takes one argument, TEXT, which is a string containing
2925 the text which should be made available.")
2927 (defvar interprogram-paste-function nil
2928 "Function to call to get text cut from other programs.
2930 Most window systems provide some sort of facility for cutting and
2931 pasting text between the windows of different programs.
2932 This variable holds a function that Emacs calls to obtain
2933 text that other programs have provided for pasting.
2935 The function should be called with no arguments. If the function
2936 returns nil, then no other program has provided such text, and the top
2937 of the Emacs kill ring should be used. If the function returns a
2938 string, then the caller of the function \(usually `current-kill')
2939 should put this string in the kill ring as the latest kill.
2941 This function may also return a list of strings if the window
2942 system supports multiple selections. The first string will be
2943 used as the pasted text, but the other will be placed in the
2944 kill ring for easy access via `yank-pop'.
2946 Note that the function should return a string only if a program other
2947 than Emacs has provided a string for pasting; if Emacs provided the
2948 most recent string, the function should return nil. If it is
2949 difficult to tell whether Emacs or some other program provided the
2950 current string, it is probably good enough to return nil if the string
2951 is equal (according to `string=') to the last text Emacs provided.")
2952 \f
2955 ;;;; The kill ring data structure.
2957 (defvar kill-ring nil
2958 "List of killed text sequences.
2959 Since the kill ring is supposed to interact nicely with cut-and-paste
2960 facilities offered by window systems, use of this variable should
2961 interact nicely with `interprogram-cut-function' and
2962 `interprogram-paste-function'. The functions `kill-new',
2963 `kill-append', and `current-kill' are supposed to implement this
2964 interaction; you may want to use them instead of manipulating the kill
2965 ring directly.")
2967 (defcustom kill-ring-max 60
2968 "Maximum length of kill ring before oldest elements are thrown away."
2969 :type 'integer
2970 :group 'killing)
2972 (defvar kill-ring-yank-pointer nil
2973 "The tail of the kill ring whose car is the last thing yanked.")
2975 (defcustom save-interprogram-paste-before-kill nil
2976 "Save clipboard strings into kill ring before replacing them.
2977 When one selects something in another program to paste it into Emacs,
2978 but kills something in Emacs before actually pasting it,
2979 this selection is gone unless this variable is non-nil,
2980 in which case the other program's selection is saved in the `kill-ring'
2982 :type 'boolean
2983 :group 'killing
2984 :version "23.2")
2986 (defcustom kill-do-not-save-duplicates nil
2987 "Do not add a new string to `kill-ring' when it is the same as the last one."
2988 :type 'boolean
2989 :group 'killing
2990 :version "23.2")
2992 (defun kill-new (string &optional replace yank-handler)
2993 "Make STRING the latest kill in the kill ring.
2994 Set `kill-ring-yank-pointer' to point to it.
2995 If `interprogram-cut-function' is non-nil, apply it to STRING.
2996 Optional second argument REPLACE non-nil means that STRING will replace
2997 the front of the kill ring, rather than being added to the list.
2999 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3000 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3001 STRING.
3003 When the yank handler has a non-nil PARAM element, the original STRING
3004 argument is not used by `insert-for-yank'. However, since Lisp code
3005 may access and use elements from the kill ring directly, the STRING
3007 (if (> (length string) 0)
3008 (if yank-handler
3009 (put-text-property 0 (length string)
3010 'yank-handler yank-handler string))
3011 (if yank-handler
3012 (signal 'args-out-of-range
3013 (list string "yank-handler specified for empty string"))))
3014 (unless (and kill-do-not-save-duplicates
3015 (equal string (car kill-ring)))
3016 (if (fboundp 'menu-bar-update-yank-menu)
3017 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3018 (when save-interprogram-paste-before-kill
3019 (let ((interprogram-paste (and interprogram-paste-function
3020 (funcall interprogram-paste-function))))
3021 (when interprogram-paste
3022 (dolist (s (if (listp interprogram-paste)
3023 (nreverse interprogram-paste)
3024 (list interprogram-paste)))
3025 (unless (and kill-do-not-save-duplicates
3026 (equal s (car kill-ring)))
3027 (push s kill-ring))))))
3028 (unless (and kill-do-not-save-duplicates
3029 (equal string (car kill-ring)))
3030 (if (and replace kill-ring)
3031 (setcar kill-ring string)
3032 (push string kill-ring)
3033 (if (> (length kill-ring) kill-ring-max)
3034 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3035 (setq kill-ring-yank-pointer kill-ring)
3036 (if interprogram-cut-function
3037 (funcall interprogram-cut-function string)))
3038 (set-advertised-calling-convention
3039 'kill-new '(string &optional replace) "23.3")
3041 (defun kill-append (string before-p &optional yank-handler)
3042 "Append STRING to the end of the latest kill in the kill ring.
3043 If BEFORE-P is non-nil, prepend STRING to the kill.
3044 If `interprogram-cut-function' is set, pass the resulting kill to it."
3045 (let* ((cur (car kill-ring)))
3046 (kill-new (if before-p (concat string cur) (concat cur string))
3047 (or (= (length cur) 0)
3048 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3049 yank-handler)))
3050 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3052 (defcustom yank-pop-change-selection nil
3053 "If non-nil, rotating the kill ring changes the window system selection."
3054 :type 'boolean
3055 :group 'killing
3056 :version "23.1")
3058 (defun current-kill (n &optional do-not-move)
3059 "Rotate the yanking point by N places, and then return that kill.
3060 If N is zero, `interprogram-paste-function' is set, and calling
3061 it returns a string or list of strings, then that string (or
3062 list) is added to the front of the kill ring and the string (or
3063 first string in the list) is returned as the latest kill.
3065 If N is not zero, and if `yank-pop-change-selection' is
3066 non-nil, use `interprogram-cut-function' to transfer the
3067 kill at the new yank point into the window system selection.
3069 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3070 move the yanking point; just return the Nth kill forward."
3072 (let ((interprogram-paste (and (= n 0)
3073 interprogram-paste-function
3074 (funcall interprogram-paste-function))))
3075 (if interprogram-paste
3076 (progn
3077 ;; Disable the interprogram cut function when we add the new
3078 ;; text to the kill ring, so Emacs doesn't try to own the
3079 ;; selection, with identical text.
3080 (let ((interprogram-cut-function nil))
3081 (if (listp interprogram-paste)
3082 (mapc 'kill-new (nreverse interprogram-paste))
3083 (kill-new interprogram-paste)))
3084 (car kill-ring))
3085 (or kill-ring (error "Kill ring is empty"))
3086 (let ((ARGth-kill-element
3087 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3088 (length kill-ring))
3089 kill-ring)))
3090 (unless do-not-move
3091 (setq kill-ring-yank-pointer ARGth-kill-element)
3092 (when (and yank-pop-change-selection
3093 (> n 0)
3094 interprogram-cut-function)
3095 (funcall interprogram-cut-function (car ARGth-kill-element))))
3096 (car ARGth-kill-element)))))
3100 ;;;; Commands for manipulating the kill ring.
3102 (defcustom kill-read-only-ok nil
3103 "Non-nil means don't signal an error for killing read-only text."
3104 :type 'boolean
3105 :group 'killing)
3107 (put 'text-read-only 'error-conditions
3108 '(text-read-only buffer-read-only error))
3109 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3111 (defun kill-region (beg end &optional yank-handler)
3113 This deletes the text from the buffer and saves it in the kill ring.
3117 If you want to append the killed region to the last killed text,
3120 If the buffer is read-only, Emacs will beep and refrain from deleting
3121 the text, but put the text in the kill ring anyway. This means that
3122 you can use the killing commands to copy text from a read-only buffer.
3124 Lisp programs should use this function for killing text.
3125 (To delete text, use `delete-region'.)
3126 Supply two arguments, character positions indicating the stretch of text
3127 to be killed.
3129 If the previous command was also a kill command,
3130 the text killed this time appends to the text killed last time
3131 to make one entry in the kill ring."
3132 ;; Pass point first, then mark, because the order matters
3133 ;; when calling kill-append.
3134 (interactive (list (point) (mark)))
3135 (unless (and beg end)
3136 (error "The mark is not set now, so there is no region"))
3137 (condition-case nil
3138 (let ((string (filter-buffer-substring beg end t)))
3139 (when string ;STRING is nil if BEG = END
3140 ;; Add that string to the kill ring, one way or another.
3141 (if (eq last-command 'kill-region)
3142 (kill-append string (< end beg) yank-handler)
3143 (kill-new string nil yank-handler)))
3144 (when (or string (eq last-command 'kill-region))
3145 (setq this-command 'kill-region))
3146 nil)
3147 ((buffer-read-only text-read-only)
3148 ;; The code above failed because the buffer, or some of the characters
3149 ;; in the region, are read-only.
3150 ;; We should beep, in case the user just isn't aware of this.
3151 ;; However, there's no harm in putting
3152 ;; the region's text in the kill ring, anyway.
3153 (copy-region-as-kill beg end)
3154 ;; Set this-command now, so it will be set even if we get an error.
3155 (setq this-command 'kill-region)
3156 ;; This should barf, if appropriate, and give us the correct error.
3157 (if kill-read-only-ok
3158 (progn (message "Read only text copied to kill ring") nil)
3159 ;; Signal an error if the buffer is read-only.
3160 (barf-if-buffer-read-only)
3161 ;; If the buffer isn't read-only, the text is.
3162 (signal 'text-read-only (list (current-buffer)))))))
3163 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3165 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3166 ;; to get two copies of the text when the user accidentally types M-w and
3167 ;; then corrects it with the intended C-w.
3168 (defun copy-region-as-kill (beg end)
3169 "Save the region as if killed, but don't kill it.
3170 In Transient Mark mode, deactivate the mark.
3171 If `interprogram-cut-function' is non-nil, also save the text for a window
3172 system cut and paste.
3174 This command's old key binding has been given to `kill-ring-save'."
3175 (interactive "r")
3176 (if (eq last-command 'kill-region)
3177 (kill-append (filter-buffer-substring beg end) (< end beg))
3178 (kill-new (filter-buffer-substring beg end)))
3179 (setq deactivate-mark t)
3180 nil)
3182 (defun kill-ring-save (beg end)
3183 "Save the region as if killed, but don't kill it.
3184 In Transient Mark mode, deactivate the mark.
3185 If `interprogram-cut-function' is non-nil, also save the text for a window
3186 system cut and paste.
3188 If you want to append the killed line to the last killed text,
3191 This command is similar to `copy-region-as-kill', except that it gives
3192 visual feedback indicating the extent of the region being copied."
3193 (interactive "r")
3194 (copy-region-as-kill beg end)
3195 ;; This use of called-interactively-p is correct
3196 ;; because the code it controls just gives the user visual feedback.
3197 (if (called-interactively-p 'interactive)
3198 (let ((other-end (if (= (point) beg) end beg))
3199 (opoint (point))
3200 ;; Inhibit quitting so we can make a quit here
3201 ;; look like a C-g typed as a command.
3202 (inhibit-quit t))
3203 (if (pos-visible-in-window-p other-end (selected-window))
3204 ;; Swap point-and-mark quickly so as to show the region that
3205 ;; was selected. Don't do it if the region is highlighted.
3206 (unless (and (region-active-p)
3207 (face-background 'region))
3208 ;; Swap point and mark.
3209 (set-marker (mark-marker) (point) (current-buffer))
3210 (goto-char other-end)
3211 (sit-for blink-matching-delay)
3212 ;; Swap back.
3213 (set-marker (mark-marker) other-end (current-buffer))
3214 (goto-char opoint)
3215 ;; If user quit, deactivate the mark
3216 ;; as C-g would as a command.
3217 (and quit-flag mark-active
3218 (deactivate-mark)))
3219 (let* ((killed-text (current-kill 0))
3220 (message-len (min (length killed-text) 40)))
3221 (if (= (point) beg)
3222 ;; Don't say "killed"; that is misleading.
3224 (substring killed-text (- message-len)))
3226 (substring killed-text 0 message-len))))))))
3228 (defun append-next-kill (&optional interactive)
3229 "Cause following command, if it kills, to append to previous kill.
3230 The argument is used for internal purposes; do not supply one."
3231 (interactive "p")
3232 ;; We don't use (interactive-p), since that breaks kbd macros.
3233 (if interactive
3234 (progn
3235 (setq this-command 'kill-region)
3236 (message "If the next command is a kill, it will append"))
3237 (setq last-command 'kill-region)))
3238 \f
3239 ;; Yanking.
3241 ;; This is actually used in subr.el but defcustom does not work there.
3242 (defcustom yank-excluded-properties
3243 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3244 yank-handler follow-link fontified)
3245 "Text properties to discard when yanking.
3246 The value should be a list of text properties to discard or t,
3247 which means to discard all text properties."
3248 :type '(choice (const :tag "All" t) (repeat symbol))
3249 :group 'killing
3250 :version "22.1")
3252 (defvar yank-window-start nil)
3253 (defvar yank-undo-function nil
3254 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3255 Function is called with two parameters, START and END corresponding to
3256 the value of the mark and point; it is guaranteed that START <= END.
3257 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3259 (defun yank-pop (&optional arg)
3260 "Replace just-yanked stretch of killed text with a different stretch.
3261 This command is allowed only immediately after a `yank' or a `yank-pop'.
3262 At such a time, the region contains a stretch of reinserted
3263 previously-killed text. `yank-pop' deletes that text and inserts in its
3264 place a different stretch of killed text.
3266 With no argument, the previous kill is inserted.
3267 With argument N, insert the Nth previous kill.
3268 If N is negative, this is a more recent kill.
3270 The sequence of kills wraps around, so that after the oldest one
3271 comes the newest one.
3273 When this command inserts killed text into the buffer, it honors
3274 `yank-excluded-properties' and `yank-handler' as described in the
3275 doc string for `insert-for-yank-1', which see."
3276 (interactive "*p")
3277 (if (not (eq last-command 'yank))
3278 (error "Previous command was not a yank"))
3279 (setq this-command 'yank)
3280 (unless arg (setq arg 1))
3281 (let ((inhibit-read-only t)
3282 (before (< (point) (mark t))))
3283 (if before
3284 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3285 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3286 (setq yank-undo-function nil)
3287 (set-marker (mark-marker) (point) (current-buffer))
3288 (insert-for-yank (current-kill arg))
3289 ;; Set the window start back where it was in the yank command,
3290 ;; if possible.
3291 (set-window-start (selected-window) yank-window-start t)
3292 (if before
3293 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3294 ;; It is cleaner to avoid activation, even though the command
3295 ;; loop would deactivate the mark because we inserted text.
3296 (goto-char (prog1 (mark t)
3297 (set-marker (mark-marker) (point) (current-buffer))))))
3298 nil)
3300 (defun yank (&optional arg)
3302 More precisely, reinsert the stretch of killed text most recently
3303 killed OR yanked. Put point at end, and set mark at beginning.
3304 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3305 With argument N, reinsert the Nth most recently killed stretch of killed
3306 text.
3308 When this command inserts killed text into the buffer, it honors
3309 `yank-excluded-properties' and `yank-handler' as described in the
3310 doc string for `insert-for-yank-1', which see.
3313 (interactive "*P")
3314 (setq yank-window-start (window-start))
3315 ;; If we don't get all the way thru, make last-command indicate that
3316 ;; for the following command.
3317 (setq this-command t)
3318 (push-mark (point))
3319 (insert-for-yank (current-kill (cond
3320 ((listp arg) 0)
3321 ((eq arg '-) -2)
3322 (t (1- arg)))))
3323 (if (consp arg)
3324 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3325 ;; It is cleaner to avoid activation, even though the command
3326 ;; loop would deactivate the mark because we inserted text.
3327 (goto-char (prog1 (mark t)
3328 (set-marker (mark-marker) (point) (current-buffer)))))
3329 ;; If we do get all the way thru, make this-command indicate that.
3330 (if (eq this-command t)
3331 (setq this-command 'yank))
3332 nil)
3334 (defun rotate-yank-pointer (arg)
3335 "Rotate the yanking point in the kill ring.
3336 With ARG, rotate that many kills forward (or backward, if negative)."
3337 (interactive "p")
3338 (current-kill arg))
3339 \f
3340 ;; Some kill commands.
3342 ;; Internal subroutine of delete-char
3343 (defun kill-forward-chars (arg)
3344 (if (listp arg) (setq arg (car arg)))
3345 (if (eq arg '-) (setq arg -1))
3346 (kill-region (point) (+ (point) arg)))
3348 ;; Internal subroutine of backward-delete-char
3349 (defun kill-backward-chars (arg)
3350 (if (listp arg) (setq arg (car arg)))
3351 (if (eq arg '-) (setq arg -1))
3352 (kill-region (point) (- (point) arg)))
3354 (defcustom backward-delete-char-untabify-method 'untabify
3355 "The method for untabifying when deleting backward.
3356 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3357 `hungry' -- delete all whitespace, both tabs and spaces;
3358 `all' -- delete all whitespace, including tabs, spaces and newlines;
3359 nil -- just delete one character."
3360 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3361 :version "20.3"
3362 :group 'killing)
3364 (defun backward-delete-char-untabify (arg &optional killp)
3365 "Delete characters backward, changing tabs into spaces.
3366 The exact behavior depends on `backward-delete-char-untabify-method'.
3367 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3368 Interactively, ARG is the prefix arg (default 1)
3369 and KILLP is t if a prefix arg was specified."
3371 (when (eq backward-delete-char-untabify-method 'untabify)
3372 (let ((count arg))
3373 (save-excursion
3374 (while (and (> count 0) (not (bobp)))
3376 (let ((col (current-column)))
3377 (forward-char -1)
3378 (setq col (- col (current-column)))
3379 (insert-char ?\s col)
3380 (delete-char 1)))
3381 (forward-char -1)
3382 (setq count (1- count))))))
3384 ((eq backward-delete-char-untabify-method 'all)
3386 (n (if skip
3387 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3388 (point)))))
3389 (+ arg (if (zerop wh) 0 (1- wh))))
3390 arg)))
3391 ;; Avoid warning about delete-backward-char
3392 (with-no-warnings (delete-backward-char n killp))))
3394 (defun zap-to-char (arg char)
3395 "Kill up to and including ARGth occurrence of CHAR.
3396 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3397 Goes backward if ARG is negative; error if CHAR not found."
3399 ;; Avoid "obsolete" warnings for translation-table-for-input.
3400 (with-no-warnings
3401 (if (char-table-p translation-table-for-input)
3402 (setq char (or (aref translation-table-for-input char) char))))
3403 (kill-region (point) (progn
3404 (search-forward (char-to-string char) nil nil arg)
3405 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3406 (point))))
3408 ;; kill-line and its subroutines.
3410 (defcustom kill-whole-line nil
3411 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3412 :type 'boolean
3413 :group 'killing)
3415 (defun kill-line (&optional arg)
3416 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3417 With prefix argument ARG, kill that many lines from point.
3418 Negative arguments kill lines backward.
3419 With zero argument, kills the text before point on the current line.
3422 a number counts as a prefix arg.
3424 To kill a whole line, when point is not at the beginning, type \
3427 If `kill-whole-line' is non-nil, then this command kills the whole line
3428 including its terminating newline, when used at the beginning of a line
3429 with no argument. As a consequence, you can always kill a whole line
3432 If you want to append the killed line to the last killed text,
3435 If the buffer is read-only, Emacs will beep and refrain from deleting
3436 the line, but put the line in the kill ring anyway. This means that
3437 you can use this command to copy text from a read-only buffer.
3438 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3439 even beep.)"
3440 (interactive "P")
3441 (kill-region (point)
3442 ;; It is better to move point to the other end of the kill
3443 ;; before killing. That way, in a read-only buffer, point
3444 ;; moves across the text that is copied to the kill ring.
3445 ;; The choice has no effect on undo now that undo records
3446 ;; the value of point from before the command was run.
3447 (progn
3448 (if arg
3449 (forward-visible-line (prefix-numeric-value arg))
3450 (if (eobp)
3451 (signal 'end-of-buffer nil))
3452 (let ((end
3453 (save-excursion
3454 (end-of-visible-line) (point))))
3455 (if (or (save-excursion
3456 ;; If trailing whitespace is visible,
3457 ;; don't treat it as nothing.
3458 (unless show-trailing-whitespace
3460 (= (point) end))
3461 (and kill-whole-line (bolp)))
3462 (forward-visible-line 1)
3463 (goto-char end))))
3464 (point))))
3466 (defun kill-whole-line (&optional arg)
3467 "Kill current line.
3468 With prefix ARG, kill that many lines starting from the current line.
3469 If ARG is negative, kill backward. Also kill the preceding newline.
3471 If ARG is zero, kill current line but exclude the trailing newline."
3472 (interactive "p")
3473 (or arg (setq arg 1))
3474 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3475 (signal 'end-of-buffer nil))
3476 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3477 (signal 'beginning-of-buffer nil))
3478 (unless (eq last-command 'kill-region)
3479 (kill-new "")
3480 (setq last-command 'kill-region))
3481 (cond ((zerop arg)
3482 ;; We need to kill in two steps, because the previous command
3483 ;; could have been a kill command, in which case the text
3484 ;; before point needs to be prepended to the current kill
3485 ;; ring entry and the text after point appended. Also, we
3486 ;; need to use save-excursion to avoid copying the same text
3487 ;; twice to the kill ring in read-only buffers.
3488 (save-excursion
3489 (kill-region (point) (progn (forward-visible-line 0) (point))))
3490 (kill-region (point) (progn (end-of-visible-line) (point))))
3491 ((< arg 0)
3492 (save-excursion
3493 (kill-region (point) (progn (end-of-visible-line) (point))))
3494 (kill-region (point)
3495 (progn (forward-visible-line (1+ arg))
3496 (unless (bobp) (backward-char))
3497 (point))))
3498 (t
3499 (save-excursion
3500 (kill-region (point) (progn (forward-visible-line 0) (point))))
3501 (kill-region (point)
3502 (progn (forward-visible-line arg) (point))))))
3504 (defun forward-visible-line (arg)
3505 "Move forward by ARG lines, ignoring currently invisible newlines only.
3506 If ARG is negative, move backward -ARG lines.
3507 If ARG is zero, move to the beginning of the current line."
3508 (condition-case nil
3509 (if (> arg 0)
3510 (progn
3511 (while (> arg 0)
3512 (or (zerop (forward-line 1))
3513 (signal 'end-of-buffer nil))
3514 ;; If the newline we just skipped is invisible,
3515 ;; don't count it.
3516 (let ((prop
3517 (get-char-property (1- (point)) 'invisible)))
3518 (if (if (eq buffer-invisibility-spec t)
3519 prop
3520 (or (memq prop buffer-invisibility-spec)
3521 (assq prop buffer-invisibility-spec)))
3522 (setq arg (1+ arg))))
3523 (setq arg (1- arg)))
3524 ;; If invisible text follows, and it is a number of complete lines,
3525 ;; skip it.
3526 (let ((opoint (point)))
3527 (while (and (not (eobp))
3528 (let ((prop
3529 (get-char-property (point) 'invisible)))
3530 (if (eq buffer-invisibility-spec t)
3531 prop
3532 (or (memq prop buffer-invisibility-spec)
3533 (assq prop buffer-invisibility-spec)))))
3534 (goto-char
3535 (if (get-text-property (point) 'invisible)
3536 (or (next-single-property-change (point) 'invisible)
3537 (point-max))
3538 (next-overlay-change (point)))))
3539 (unless (bolp)
3540 (goto-char opoint))))
3541 (let ((first t))
3542 (while (or first (<= arg 0))
3543 (if first
3544 (beginning-of-line)
3545 (or (zerop (forward-line -1))
3546 (signal 'beginning-of-buffer nil)))
3547 ;; If the newline we just moved to is invisible,
3548 ;; don't count it.
3549 (unless (bobp)
3550 (let ((prop
3551 (get-char-property (1- (point)) 'invisible)))
3552 (unless (if (eq buffer-invisibility-spec t)
3553 prop
3554 (or (memq prop buffer-invisibility-spec)
3555 (assq prop buffer-invisibility-spec)))
3556 (setq arg (1+ arg)))))
3557 (setq first nil))
3558 ;; If invisible text follows, and it is a number of complete lines,
3559 ;; skip it.
3560 (let ((opoint (point)))
3561 (while (and (not (bobp))
3562 (let ((prop
3563 (get-char-property (1- (point)) 'invisible)))
3564 (if (eq buffer-invisibility-spec t)
3565 prop
3566 (or (memq prop buffer-invisibility-spec)
3567 (assq prop buffer-invisibility-spec)))))
3568 (goto-char
3569 (if (get-text-property (1- (point)) 'invisible)
3570 (or (previous-single-property-change (point) 'invisible)
3571 (point-min))
3572 (previous-overlay-change (point)))))
3573 (unless (bolp)
3574 (goto-char opoint)))))
3575 ((beginning-of-buffer end-of-buffer)
3576 nil)))
3578 (defun end-of-visible-line ()
3579 "Move to end of current visible line."
3580 (end-of-line)
3581 ;; If the following character is currently invisible,
3582 ;; skip all characters with that same `invisible' property value,
3583 ;; then find the next newline.
3584 (while (and (not (eobp))
3585 (save-excursion
3587 (let ((prop
3588 (get-char-property (point) 'invisible)))
3589 (if (eq buffer-invisibility-spec t)
3590 prop
3591 (or (memq prop buffer-invisibility-spec)
3592 (assq prop buffer-invisibility-spec))))))
3594 (if (get-text-property (point) 'invisible)
3595 (goto-char (next-single-property-change (point) 'invisible))
3596 (goto-char (next-overlay-change (point))))
3597 (end-of-line)))
3598 \f
3599 (defun insert-buffer (buffer)
3600 "Insert after point the contents of BUFFER.
3601 Puts mark after the inserted text.
3602 BUFFER may be a buffer or a buffer name.
3604 This function is meant for the user to run interactively.
3605 Don't call it from programs: use `insert-buffer-substring' instead!"
3606 (interactive
3607 (list
3608 (progn
3609 (barf-if-buffer-read-only)
3610 (read-buffer "Insert buffer: "
3611 (if (eq (selected-window) (next-window (selected-window)))
3612 (other-buffer (current-buffer))
3613 (window-buffer (next-window (selected-window))))
3614 t))))
3615 (push-mark
3616 (save-excursion
3617 (insert-buffer-substring (get-buffer buffer))
3618 (point)))
3619 nil)
3621 (defun append-to-buffer (buffer start end)
3622 "Append to specified buffer the text of the region.
3623 It is inserted into that buffer before its point.
3625 When calling from a program, give three arguments:
3626 BUFFER (or buffer name), START and END.
3627 START and END specify the portion of the current buffer to be copied."
3628 (interactive
3629 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3630 (region-beginning) (region-end)))
3631 (let* ((oldbuf (current-buffer))
3632 (append-to (get-buffer-create buffer))
3633 (windows (get-buffer-window-list append-to t t))
3634 point)
3635 (save-excursion
3636 (with-current-buffer append-to
3637 (setq point (point))
3638 (barf-if-buffer-read-only)
3639 (insert-buffer-substring oldbuf start end)
3640 (dolist (window windows)
3641 (when (= (window-point window) point)
3642 (set-window-point window (point))))))))
3644 (defun prepend-to-buffer (buffer start end)
3645 "Prepend to specified buffer the text of the region.
3646 It is inserted into that buffer after its point.
3648 When calling from a program, give three arguments:
3649 BUFFER (or buffer name), START and END.
3650 START and END specify the portion of the current buffer to be copied."
3652 (let ((oldbuf (current-buffer)))
3653 (with-current-buffer (get-buffer-create buffer)
3654 (barf-if-buffer-read-only)
3655 (save-excursion
3656 (insert-buffer-substring oldbuf start end)))))
3658 (defun copy-to-buffer (buffer start end)
3659 "Copy to specified buffer the text of the region.
3660 It is inserted into that buffer, replacing existing text there.
3662 When calling from a program, give three arguments:
3663 BUFFER (or buffer name), START and END.
3664 START and END specify the portion of the current buffer to be copied."
3666 (let ((oldbuf (current-buffer)))
3667 (with-current-buffer (get-buffer-create buffer)
3668 (barf-if-buffer-read-only)
3669 (erase-buffer)
3670 (save-excursion
3671 (insert-buffer-substring oldbuf start end)))))
3672 \f
3673 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3674 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3676 (defvar activate-mark-hook nil
3677 "Hook run when the mark becomes active.
3678 It is also run at the end of a command, if the mark is active and
3679 it is possible that the region may have changed.")
3681 (defvar deactivate-mark-hook nil
3682 "Hook run when the mark becomes inactive.")
3684 (defun mark (&optional force)
3685 "Return this buffer's mark value as integer, or nil if never set.
3687 In Transient Mark mode, this function signals an error if
3688 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3689 or the argument FORCE is non-nil, it disregards whether the mark
3690 is active, and returns an integer or nil in the usual way.
3692 If you are using this in an editing command, you are most likely making
3693 a mistake; see the documentation of `set-mark'."
3694 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3695 (marker-position (mark-marker))
3696 (signal 'mark-inactive nil)))
3698 (defsubst deactivate-mark (&optional force)
3699 "Deactivate the mark by setting `mark-active' to nil.
3700 Unless FORCE is non-nil, this function does nothing if Transient
3701 Mark mode is disabled.
3702 This function also runs `deactivate-mark-hook'."
3703 (when (or transient-mark-mode force)
3704 (when (and (if (eq select-active-regions 'only)
3705 (eq (car-safe transient-mark-mode) 'only)
3706 select-active-regions)
3707 (region-active-p)
3708 (display-selections-p))
3709 ;; The var `saved-region-selection', if non-nil, is the text in
3710 ;; the region prior to the last command modifying the buffer.
3711 ;; Set the selection to that, or to the current region.
3712 (cond (saved-region-selection
3713 (x-set-selection 'PRIMARY saved-region-selection)
3714 (setq saved-region-selection nil))
3715 ((/= (region-beginning) (region-end))
3716 (x-set-selection 'PRIMARY
3717 (buffer-substring-no-properties
3718 (region-beginning)
3719 (region-end))))))
3720 (if (and (null force)
3721 (or (eq transient-mark-mode 'lambda)
3722 (and (eq (car-safe transient-mark-mode) 'only)
3723 (null (cdr transient-mark-mode)))))
3724 ;; When deactivating a temporary region, don't change
3725 ;; `mark-active' or run `deactivate-mark-hook'.
3726 (setq transient-mark-mode nil)
3727 (if (eq (car-safe transient-mark-mode) 'only)
3728 (setq transient-mark-mode (cdr transient-mark-mode)))
3729 (setq mark-active nil)
3730 (run-hooks 'deactivate-mark-hook))))
3732 (defun activate-mark ()
3733 "Activate the mark."
3734 (when (mark t)
3735 (setq mark-active t)
3736 (unless transient-mark-mode
3737 (setq transient-mark-mode 'lambda))))
3739 (defun set-mark (pos)
3740 "Set this buffer's mark to POS. Don't use this function!
3741 That is to say, don't use this function unless you want
3742 the user to see that the mark has moved, and you want the previous
3743 mark position to be lost.
3745 Normally, when a new mark is set, the old one should go on the stack.
3746 This is why most applications should use `push-mark', not `set-mark'.
3748 Novice Emacs Lisp programmers often try to use the mark for the wrong
3749 purposes. The mark saves a location for the user's convenience.
3750 Most editing commands should not alter the mark.
3751 To remember a location for internal use in the Lisp program,
3752 store it in a Lisp variable. Example:
3754 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3756 (if pos
3757 (progn
3758 (setq mark-active t)
3759 (run-hooks 'activate-mark-hook)
3760 (set-marker (mark-marker) pos (current-buffer)))
3761 ;; Normally we never clear mark-active except in Transient Mark mode.
3762 ;; But when we actually clear out the mark value too, we must
3763 ;; clear mark-active in any mode.
3764 (deactivate-mark t)
3765 (set-marker (mark-marker) nil)))
3767 (defcustom use-empty-active-region nil
3769 If nil, region-aware commands treat empty regions as inactive.
3770 If non-nil, region-aware commands treat the region as active as
3771 long as the mark is active, even if the region is empty.
3773 Region-aware commands are those that act on the region if it is
3774 active and Transient Mark mode is enabled, and on the text near
3775 point otherwise."
3776 :type 'boolean
3777 :version "23.1"
3778 :group 'editing-basics)
3780 (defun use-region-p ()
3781 "Return t if the region is active and it is appropriate to act on it.
3782 This is used by commands that act specially on the region under
3783 Transient Mark mode.
3785 The return value is t if Transient Mark mode is enabled and the
3786 mark is active; furthermore, if `use-empty-active-region' is nil,
3787 the region must not be empty. Otherwise, the return value is nil.
3789 For some commands, it may be appropriate to ignore the value of
3790 `use-empty-active-region'; in that case, use `region-active-p'."
3791 (and (region-active-p)
3792 (or use-empty-active-region (> (region-end) (region-beginning)))))
3794 (defun region-active-p ()
3795 "Return t if Transient Mark mode is enabled and the mark is active.
3797 Some commands act specially on the region when Transient Mark
3798 mode is enabled. Usually, such commands should use
3799 `use-region-p' instead of this function, because `use-region-p'
3800 also checks the value of `use-empty-active-region'."
3801 (and transient-mark-mode mark-active))
3803 (defvar mark-ring nil
3804 "The list of former marks of the current buffer, most recent first.")
3805 (make-variable-buffer-local 'mark-ring)
3806 (put 'mark-ring 'permanent-local t)
3808 (defcustom mark-ring-max 16
3809 "Maximum size of mark ring. Start discarding off end if gets this big."
3810 :type 'integer
3811 :group 'editing-basics)
3813 (defvar global-mark-ring nil
3814 "The list of saved global marks, most recent first.")
3816 (defcustom global-mark-ring-max 16
3817 "Maximum size of global mark ring. \
3818 Start discarding off end if gets this big."
3819 :type 'integer
3820 :group 'editing-basics)
3822 (defun pop-to-mark-command ()
3823 "Jump to mark, and pop a new position for mark off the ring.
3824 \(Does not affect global mark ring\)."
3825 (interactive)
3826 (if (null (mark t))
3827 (error "No mark set in this buffer")
3828 (if (= (point) (mark t))
3829 (message "Mark popped"))
3830 (goto-char (mark t))
3831 (pop-mark)))
3833 (defun push-mark-command (arg &optional nomsg)
3834 "Set mark at where point is.
3835 If no prefix ARG and mark is already set there, just activate it.
3836 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3837 (interactive "P")
3838 (let ((mark (marker-position (mark-marker))))
3839 (if (or arg (null mark) (/= mark (point)))
3840 (push-mark nil nomsg t)
3841 (setq mark-active t)
3842 (run-hooks 'activate-mark-hook)
3843 (unless nomsg
3844 (message "Mark activated")))))
3846 (defcustom set-mark-command-repeat-pop nil
3849 will pop the mark twice, and
3851 will pop the mark three times.
3855 :type 'boolean
3856 :group 'editing-basics)
3858 (defcustom set-mark-default-inactive nil
3859 "If non-nil, setting the mark does not activate it.
3861 behave the same whether or not `transient-mark-mode' is enabled."
3862 :type 'boolean
3863 :group 'editing-basics
3864 :version "23.1")
3866 (defun set-mark-command (arg)
3867 "Set the mark where point is, or jump to the mark.
3868 Setting the mark also alters the region, which is the text
3869 between point and mark; this is the closest equivalent in
3872 With no prefix argument, set the mark at point, and push the
3873 old mark position on local mark ring. Also push the old mark on
3874 global mark ring, if the previous mark was set in another buffer.
3876 When Transient Mark Mode is off, immediately repeating this
3877 command activates `transient-mark-mode' temporarily.
3880 jump to the mark, and set the mark from
3881 position popped off the local mark ring \(this does not affect the global
3883 mark ring \(see `pop-global-mark'\).
3885 If `set-mark-command-repeat-pop' is non-nil, repeating
3887 off the local (or global) mark ring and jumps there.
3890 argument, unconditionally set mark where point is, even if
3891 `set-mark-command-repeat-pop' is non-nil.
3893 Novice Emacs Lisp programmers often try to use the mark for the wrong
3894 purposes. See the documentation of `set-mark' for more information."
3895 (interactive "P")
3896 (cond ((eq transient-mark-mode 'lambda)
3897 (setq transient-mark-mode nil))
3898 ((eq (car-safe transient-mark-mode) 'only)
3899 (deactivate-mark)))
3900 (cond
3901 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3902 (push-mark-command nil))
3903 ((not (eq this-command 'set-mark-command))
3904 (if arg
3905 (pop-to-mark-command)
3906 (push-mark-command t)))
3907 ((and set-mark-command-repeat-pop
3908 (eq last-command 'pop-to-mark-command))
3909 (setq this-command 'pop-to-mark-command)
3910 (pop-to-mark-command))
3911 ((and set-mark-command-repeat-pop
3912 (eq last-command 'pop-global-mark)
3913 (not arg))
3914 (setq this-command 'pop-global-mark)
3915 (pop-global-mark))
3916 (arg
3917 (setq this-command 'pop-to-mark-command)
3918 (pop-to-mark-command))
3919 ((eq last-command 'set-mark-command)
3920 (if (region-active-p)
3921 (progn
3922 (deactivate-mark)
3923 (message "Mark deactivated"))
3924 (activate-mark)
3925 (message "Mark activated")))
3926 (t
3927 (push-mark-command nil)
3928 (if set-mark-default-inactive (deactivate-mark)))))
3930 (defun push-mark (&optional location nomsg activate)
3931 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3932 If the last global mark pushed was not in the current buffer,
3933 also push LOCATION on the global mark ring.
3934 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3936 Novice Emacs Lisp programmers often try to use the mark for the wrong
3937 purposes. See the documentation of `set-mark' for more information.
3939 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3940 (unless (null (mark t))
3941 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3942 (when (> (length mark-ring) mark-ring-max)
3943 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3944 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3945 (set-marker (mark-marker) (or location (point)) (current-buffer))
3946 ;; Now push the mark on the global mark ring.
3947 (if (and global-mark-ring
3948 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3949 ;; The last global mark pushed was in this same buffer.
3950 ;; Don't push another one.
3951 nil
3952 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3953 (when (> (length global-mark-ring) global-mark-ring-max)
3954 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3955 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3956 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3957 (message "Mark set"))
3958 (if (or activate (not transient-mark-mode))
3959 (set-mark (mark t)))
3960 nil)
3962 (defun pop-mark ()
3963 "Pop off mark ring into the buffer's actual mark.
3964 Does not set point. Does nothing if mark ring is empty."
3965 (when mark-ring
3966 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3967 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3968 (move-marker (car mark-ring) nil)
3969 (if (null (mark t)) (ding))
3970 (setq mark-ring (cdr mark-ring)))
3971 (deactivate-mark))
3973 (define-obsolete-function-alias
3974 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
3975 (defun exchange-point-and-mark (&optional arg)
3976 "Put the mark where point is now, and point where the mark is now.
3977 This command works even when the mark is not active,
3978 and it reactivates the mark.
3980 If Transient Mark mode is on, a prefix ARG deactivates the mark
3981 if it is active, and otherwise avoids reactivating it. If
3982 Transient Mark mode is off, a prefix ARG enables Transient Mark
3983 mode temporarily."
3984 (interactive "P")
3985 (let ((omark (mark t))
3986 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3987 (if (null omark)
3988 (error "No mark set in this buffer"))
3989 (deactivate-mark)
3990 (set-mark (point))
3991 (goto-char omark)
3992 (if set-mark-default-inactive (deactivate-mark))
3993 (cond (temp-highlight
3994 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3995 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3996 (not (or arg (region-active-p))))
3997 (deactivate-mark))
3998 (t (activate-mark)))
3999 nil))
4001 (defcustom shift-select-mode t
4002 "When non-nil, shifted motion keys activate the mark momentarily.
4004 While the mark is activated in this way, any shift-translated point
4005 motion key extends the region, and if Transient Mark mode was off, it
4006 is temporarily turned on. Furthermore, the mark will be deactivated
4007 by any subsequent point motion key that was not shift-translated, or
4008 by any action that normally deactivates the mark in Transient Mark mode.
4010 See `this-command-keys-shift-translated' for the meaning of
4011 shift-translation."
4012 :type 'boolean
4013 :group 'editing-basics)
4015 (defun handle-shift-selection ()
4016 "Activate/deactivate mark depending on invocation thru shift translation.
4017 This function is called by `call-interactively' when a command
4018 with a `^' character in its `interactive' spec is invoked, before
4019 running the command itself.
4021 If `shift-select-mode' is enabled and the command was invoked
4022 through shift translation, set the mark and activate the region
4023 temporarily, unless it was already set in this way. See
4024 `this-command-keys-shift-translated' for the meaning of shift
4025 translation.
4027 Otherwise, if the region has been activated temporarily,
4028 deactivate it, and restore the variable `transient-mark-mode' to
4029 its earlier value."
4030 (cond ((and shift-select-mode this-command-keys-shift-translated)
4031 (unless (and mark-active
4032 (eq (car-safe transient-mark-mode) 'only))
4033 (setq transient-mark-mode
4034 (cons 'only
4035 (unless (eq transient-mark-mode 'lambda)
4036 transient-mark-mode)))
4037 (push-mark nil nil t)))
4038 ((eq (car-safe transient-mark-mode) 'only)
4039 (setq transient-mark-mode (cdr transient-mark-mode))
4040 (deactivate-mark))))
4042 (define-minor-mode transient-mark-mode
4043 "Toggle Transient Mark mode.
4044 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4046 In Transient Mark mode, when the mark is active, the region is highlighted.
4048 So do certain other operations that set the mark
4049 but whose main purpose is something else--for example,
4055 Many commands change their behavior when Transient Mark mode is in effect
4056 and the mark is active, by acting on the region instead of their usual
4057 default part of the buffer's text. Examples of such commands include
4062 commands which are sensitive to the Transient Mark mode."
4063 :global t
4064 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4065 :variable transient-mark-mode)
4067 (defvar widen-automatically t
4068 "Non-nil means it is ok for commands to call `widen' when they want to.
4069 Some commands will do this in order to go to positions outside
4070 the current accessible part of the buffer.
4072 If `widen-automatically' is nil, these commands will do something else
4073 as a fallback, and won't change the buffer bounds.")
4075 (defvar non-essential nil
4076 "Whether the currently executing code is performing an essential task.
4077 This variable should be non-nil only when running code which should not
4078 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4079 user for a password when we are simply scanning a set of files in the
4080 background or displaying possible completions before the user even asked
4081 for it.")
4083 (defun pop-global-mark ()
4084 "Pop off global mark ring and jump to the top location."
4085 (interactive)
4086 ;; Pop entries which refer to non-existent buffers.
4087 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4088 (setq global-mark-ring (cdr global-mark-ring)))
4089 (or global-mark-ring
4090 (error "No global mark set"))
4091 (let* ((marker (car global-mark-ring))
4092 (buffer (marker-buffer marker))
4093 (position (marker-position marker)))
4094 (setq global-mark-ring (nconc (cdr global-mark-ring)
4095 (list (car global-mark-ring))))
4096 (set-buffer buffer)
4097 (or (and (>= position (point-min))
4098 (<= position (point-max)))
4099 (if widen-automatically
4100 (widen)
4101 (error "Global mark position is outside accessible part of buffer")))
4102 (goto-char position)
4103 (pop-to-buffer-same-window buffer)))
4104 \f
4105 (defcustom next-line-add-newlines nil
4106 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4107 :type 'boolean
4108 :version "21.1"
4109 :group 'editing-basics)
4111 (defun next-line (&optional arg try-vscroll)
4112 "Move cursor vertically down ARG lines.
4113 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4114 If there is no character in the target line exactly under the current column,
4115 the cursor is positioned after the character in that line which spans this
4116 column, or at the end of the line if it is not long enough.
4117 If there is no line in the buffer after this one, behavior depends on the
4118 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4119 to create a line, and moves the cursor to that line. Otherwise it moves the
4120 cursor to the end of the buffer.
4122 If the variable `line-move-visual' is non-nil, this command moves
4123 by display lines. Otherwise, it moves by buffer lines, without
4124 taking variable-width characters or continued lines into account.
4127 a semipermanent goal column for this command.
4128 Then instead of trying to move exactly vertically (or as close as possible),
4129 this command moves to the specified goal column (or as close as possible).
4130 The goal column is stored in the variable `goal-column', which is nil
4131 when there is no goal column.
4133 If you are thinking of using this in a Lisp program, consider
4134 using `forward-line' instead. It is usually easier to use
4135 and more reliable (no dependence on goal column, etc.)."
4137 (or arg (setq arg 1))
4138 (if (and next-line-add-newlines (= arg 1))
4139 (if (save-excursion (end-of-line) (eobp))
4140 ;; When adding a newline, don't expand an abbrev.
4141 (let ((abbrev-mode nil))
4142 (end-of-line)
4144 (line-move arg nil nil try-vscroll))
4145 (if (called-interactively-p 'interactive)
4146 (condition-case err
4147 (line-move arg nil nil try-vscroll)
4148 ((beginning-of-buffer end-of-buffer)
4149 (signal (car err) (cdr err))))
4150 (line-move arg nil nil try-vscroll)))
4151 nil)
4153 (defun previous-line (&optional arg try-vscroll)
4154 "Move cursor vertically up ARG lines.
4155 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4156 If there is no character in the target line exactly over the current column,
4157 the cursor is positioned after the character in that line which spans this
4158 column, or at the end of the line if it is not long enough.
4160 If the variable `line-move-visual' is non-nil, this command moves
4161 by display lines. Otherwise, it moves by buffer lines, without
4162 taking variable-width characters or continued lines into account.
4165 a semipermanent goal column for this command.
4166 Then instead of trying to move exactly vertically (or as close as possible),
4167 this command moves to the specified goal column (or as close as possible).
4168 The goal column is stored in the variable `goal-column', which is nil
4169 when there is no goal column.
4171 If you are thinking of using this in a Lisp program, consider using
4172 `forward-line' with a negative argument instead. It is usually easier
4173 to use and more reliable (no dependence on goal column, etc.)."
4175 (or arg (setq arg 1))
4176 (if (called-interactively-p 'interactive)
4177 (condition-case err
4178 (line-move (- arg) nil nil try-vscroll)
4179 ((beginning-of-buffer end-of-buffer)
4180 (signal (car err) (cdr err))))
4181 (line-move (- arg) nil nil try-vscroll))
4182 nil)
4184 (defcustom track-eol nil
4185 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4186 This means moving to the end of each line moved onto.
4187 The beginning of a blank line does not count as the end of a line.
4188 This has no effect when `line-move-visual' is non-nil."
4189 :type 'boolean
4190 :group 'editing-basics)
4192 (defcustom goal-column nil
4194 :type '(choice integer
4195 (const :tag "None" nil))
4196 :group 'editing-basics)
4197 (make-variable-buffer-local 'goal-column)
4199 (defvar temporary-goal-column 0
4200 "Current goal column for vertical motion.
4201 It is the column where point was at the start of the current run
4202 of vertical motion commands.
4204 When moving by visual lines via `line-move-visual', it is a cons
4205 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4206 divided by the default column width, and HSCROLL is the number of
4207 columns by which window is scrolled from left margin.
4209 When the `track-eol' feature is doing its job, the value is
4210 `most-positive-fixnum'.")
4212 (defcustom line-move-ignore-invisible t
4214 Outline mode sets this."
4215 :type 'boolean
4216 :group 'editing-basics)
4218 (defcustom line-move-visual t
4219 "When non-nil, `line-move' moves point by visual lines.
4220 This movement is based on where the cursor is displayed on the
4221 screen, instead of relying on buffer contents alone. It takes
4222 into account variable-width characters and line continuation.
4223 If nil, `line-move' moves point by logical lines."
4224 :type 'boolean
4225 :group 'editing-basics
4226 :version "23.1")
4228 ;; Returns non-nil if partial move was done.
4229 (defun line-move-partial (arg noerror to-end)
4230 (if (< arg 0)
4231 ;; Move backward (up).
4232 ;; If already vscrolled, reduce vscroll
4233 (let ((vs (window-vscroll nil t)))
4234 (when (> vs (frame-char-height))
4235 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4237 ;; Move forward (down).
4238 (let* ((lh (window-line-height -1))
4239 (vpos (nth 1 lh))
4240 (ypos (nth 2 lh))
4241 (rbot (nth 3 lh))
4242 py vs)
4243 (when (or (null lh)
4244 (>= rbot (frame-char-height))
4245 (<= ypos (- (frame-char-height))))
4246 (unless lh
4247 (let ((wend (pos-visible-in-window-p t nil t)))
4248 (setq rbot (nth 3 wend)
4249 vpos (nth 5 wend))))
4250 (cond
4251 ;; If last line of window is fully visible, move forward.
4252 ((or (null rbot) (= rbot 0))
4253 nil)
4254 ;; If cursor is not in the bottom scroll margin, move forward.
4255 ((and (> vpos 0)
4256 (< (setq py
4257 (or (nth 1 (window-line-height))
4258 (let ((ppos (posn-at-point)))
4259 (cdr (or (posn-actual-col-row ppos)
4260 (posn-col-row ppos))))))
4261 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4262 nil)
4263 ;; When already vscrolled, we vscroll some more if we can,
4264 ;; or clear vscroll and move forward at end of tall image.
4265 ((> (setq vs (window-vscroll nil t)) 0)
4266 (when (> rbot 0)
4267 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4268 ;; If cursor just entered the bottom scroll margin, move forward,
4269 ;; but also vscroll one line so redisplay wont recenter.
4270 ((and (> vpos 0)
4271 (= py (min (- (window-text-height) scroll-margin 1)
4272 (1- vpos))))
4273 (set-window-vscroll nil (frame-char-height) t)
4274 (line-move-1 arg noerror to-end)
4275 t)
4276 ;; If there are lines above the last line, scroll-up one line.
4277 ((> vpos 0)
4278 (scroll-up 1)
4279 t)
4280 ;; Finally, start vscroll.
4281 (t
4282 (set-window-vscroll nil (frame-char-height) t)))))))
4285 ;; This is like line-move-1 except that it also performs
4286 ;; vertical scrolling of tall images if appropriate.
4287 ;; That is not really a clean thing to do, since it mixes
4288 ;; scrolling with cursor motion. But so far we don't have
4289 ;; a cleaner solution to the problem of making C-n do something
4290 ;; useful given a tall image.
4291 (defun line-move (arg &optional noerror to-end try-vscroll)
4292 (unless (and auto-window-vscroll try-vscroll
4293 ;; Only vscroll for single line moves
4294 (= (abs arg) 1)
4295 ;; But don't vscroll in a keyboard macro.
4296 (not defining-kbd-macro)
4297 (not executing-kbd-macro)
4298 (line-move-partial arg noerror to-end))
4299 (set-window-vscroll nil 0 t)
4300 (if line-move-visual
4301 (line-move-visual arg noerror)
4302 (line-move-1 arg noerror to-end))))
4304 ;; Display-based alternative to line-move-1.
4305 ;; Arg says how many lines to move. The value is t if we can move the
4306 ;; specified number of lines.
4307 (defun line-move-visual (arg &optional noerror)
4308 (let ((opoint (point))
4309 (hscroll (window-hscroll))
4310 target-hscroll)
4311 ;; Check if the previous command was a line-motion command, or if
4312 ;; we were called from some other command.
4313 (if (and (consp temporary-goal-column)
4314 (memq last-command `(next-line previous-line ,this-command)))
4315 ;; If so, there's no need to reset `temporary-goal-column',
4316 ;; but we may need to hscroll.
4317 (if (or (/= (cdr temporary-goal-column) hscroll)
4318 (> (cdr temporary-goal-column) 0))
4319 (setq target-hscroll (cdr temporary-goal-column)))
4320 ;; Otherwise, we should reset `temporary-goal-column'.
4321 (let ((posn (posn-at-point)))
4322 (cond
4323 ;; Handle the `overflow-newline-into-fringe' case:
4324 ((eq (nth 1 posn) 'right-fringe)
4325 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4326 ((car (posn-x-y posn))
4327 (setq temporary-goal-column
4328 (cons (/ (float (car (posn-x-y posn)))
4329 (frame-char-width)) hscroll))))))
4330 (if target-hscroll
4331 (set-window-hscroll (selected-window) target-hscroll))
4332 (or (and (= (vertical-motion
4333 (cons (or goal-column
4334 (if (consp temporary-goal-column)
4335 (car temporary-goal-column)
4336 temporary-goal-column))
4337 arg))
4338 arg)
4339 (or (>= arg 0)
4340 (/= (point) opoint)
4341 ;; If the goal column lies on a display string,
4342 ;; `vertical-motion' advances the cursor to the end
4343 ;; of the string. For arg < 0, this can cause the
4344 ;; cursor to get stuck. (Bug#3020).
4345 (= (vertical-motion arg) arg)))
4346 (unless noerror
4347 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4348 nil)))))
4350 ;; This is the guts of next-line and previous-line.
4351 ;; Arg says how many lines to move.
4352 ;; The value is t if we can move the specified number of lines.
4353 (defun line-move-1 (arg &optional noerror _to-end)
4354 ;; Don't run any point-motion hooks, and disregard intangibility,
4355 ;; for intermediate positions.
4356 (let ((inhibit-point-motion-hooks t)
4357 (opoint (point))
4358 (orig-arg arg))
4359 (if (consp temporary-goal-column)
4360 (setq temporary-goal-column (+ (car temporary-goal-column)
4361 (cdr temporary-goal-column))))
4362 (unwind-protect
4363 (progn
4364 (if (not (memq last-command '(next-line previous-line)))
4365 (setq temporary-goal-column
4366 (if (and track-eol (eolp)
4367 ;; Don't count beg of empty line as end of line
4368 ;; unless we just did explicit end-of-line.
4369 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4370 most-positive-fixnum
4371 (current-column))))
4373 (if (not (or (integerp selective-display)
4374 line-move-ignore-invisible))
4375 ;; Use just newline characters.
4376 ;; Set ARG to 0 if we move as many lines as requested.
4377 (or (if (> arg 0)
4378 (progn (if (> arg 1) (forward-line (1- arg)))
4379 ;; This way of moving forward ARG lines
4380 ;; verifies that we have a newline after the last one.
4381 ;; It doesn't get confused by intangible text.
4382 (end-of-line)
4383 (if (zerop (forward-line 1))
4384 (setq arg 0)))
4385 (and (zerop (forward-line arg))
4386 (bolp)
4387 (setq arg 0)))
4388 (unless noerror
4389 (signal (if (< arg 0)
4390 'beginning-of-buffer
4391 'end-of-buffer)
4392 nil)))
4393 ;; Move by arg lines, but ignore invisible ones.
4394 (let (done)
4395 (while (and (> arg 0) (not done))
4396 ;; If the following character is currently invisible,
4397 ;; skip all characters with that same `invisible' property value.
4398 (while (and (not (eobp)) (invisible-p (point)))
4399 (goto-char (next-char-property-change (point))))
4400 ;; Move a line.
4401 ;; We don't use `end-of-line', since we want to escape
4402 ;; from field boundaries occurring exactly at point.
4403 (goto-char (constrain-to-field
4404 (let ((inhibit-field-text-motion t))
4405 (line-end-position))
4406 (point) t t
4407 'inhibit-line-move-field-capture))
4408 ;; If there's no invisibility here, move over the newline.
4409 (cond
4410 ((eobp)
4411 (if (not noerror)
4412 (signal 'end-of-buffer nil)
4413 (setq done t)))
4414 ((and (> arg 1) ;; Use vertical-motion for last move
4415 (not (integerp selective-display))
4416 (not (invisible-p (point))))
4417 ;; We avoid vertical-motion when possible
4418 ;; because that has to fontify.
4419 (forward-line 1))
4420 ;; Otherwise move a more sophisticated way.
4421 ((zerop (vertical-motion 1))
4422 (if (not noerror)
4423 (signal 'end-of-buffer nil)
4424 (setq done t))))
4425 (unless done
4426 (setq arg (1- arg))))
4427 ;; The logic of this is the same as the loop above,
4428 ;; it just goes in the other direction.
4429 (while (and (< arg 0) (not done))
4430 ;; For completely consistency with the forward-motion
4431 ;; case, we should call beginning-of-line here.
4432 ;; However, if point is inside a field and on a
4433 ;; continued line, the call to (vertical-motion -1)
4434 ;; below won't move us back far enough; then we return
4435 ;; to the same column in line-move-finish, and point
4436 ;; gets stuck -- cyd
4437 (forward-line 0)
4438 (cond
4439 ((bobp)
4440 (if (not noerror)
4441 (signal 'beginning-of-buffer nil)
4442 (setq done t)))
4443 ((and (< arg -1) ;; Use vertical-motion for last move
4444 (not (integerp selective-display))
4445 (not (invisible-p (1- (point)))))
4446 (forward-line -1))
4447 ((zerop (vertical-motion -1))
4448 (if (not noerror)
4449 (signal 'beginning-of-buffer nil)
4450 (setq done t))))
4451 (unless done
4452 (setq arg (1+ arg))
4453 (while (and ;; Don't move over previous invis lines
4454 ;; if our target is the middle of this line.
4455 (or (zerop (or goal-column temporary-goal-column))
4456 (< arg 0))
4457 (not (bobp)) (invisible-p (1- (point))))
4458 (goto-char (previous-char-property-change (point))))))))
4459 ;; This is the value the function returns.
4460 (= arg 0))
4462 (cond ((> arg 0)
4463 ;; If we did not move down as far as desired, at least go
4464 ;; to end of line. Be sure to call point-entered and
4465 ;; point-left-hooks.
4466 (let* ((npoint (prog1 (line-end-position)
4467 (goto-char opoint)))
4468 (inhibit-point-motion-hooks nil))
4469 (goto-char npoint)))
4470 ((< arg 0)
4471 ;; If we did not move up as far as desired,
4472 ;; at least go to beginning of line.
4473 (let* ((npoint (prog1 (line-beginning-position)
4474 (goto-char opoint)))
4475 (inhibit-point-motion-hooks nil))
4476 (goto-char npoint)))
4477 (t
4478 (line-move-finish (or goal-column temporary-goal-column)
4479 opoint (> orig-arg 0)))))))
4481 (defun line-move-finish (column opoint forward)
4482 (let ((repeat t))
4483 (while repeat
4484 ;; Set REPEAT to t to repeat the whole thing.
4485 (setq repeat nil)
4487 (let (new
4488 (old (point))
4489 (line-beg (line-beginning-position))
4490 (line-end
4491 ;; Compute the end of the line
4492 ;; ignoring effectively invisible newlines.
4493 (save-excursion
4494 ;; Like end-of-line but ignores fields.
4496 (while (and (not (eobp)) (invisible-p (point)))
4497 (goto-char (next-char-property-change (point)))
4499 (point))))
4501 ;; Move to the desired column.
4502 (line-move-to-column (truncate column))
4504 ;; Corner case: suppose we start out in a field boundary in
4505 ;; the middle of a continued line. When we get to
4506 ;; line-move-finish, point is at the start of a new *screen*
4507 ;; line but the same text line; then line-move-to-column would
4508 ;; move us backwards. Test using C-n with point on the "x" in
4509 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4510 (and forward
4511 (< (point) old)
4512 (goto-char old))
4514 (setq new (point))
4516 ;; Process intangibility within a line.
4517 ;; With inhibit-point-motion-hooks bound to nil, a call to
4518 ;; goto-char moves point past intangible text.
4520 ;; However, inhibit-point-motion-hooks controls both the
4521 ;; intangibility and the point-entered/point-left hooks. The
4522 ;; following hack avoids calling the point-* hooks
4523 ;; unnecessarily. Note that we move *forward* past intangible
4524 ;; text when the initial and final points are the same.
4525 (goto-char new)
4526 (let ((inhibit-point-motion-hooks nil))
4527 (goto-char new)
4529 ;; If intangibility moves us to a different (later) place
4530 ;; in the same line, use that as the destination.
4531 (if (<= (point) line-end)
4532 (setq new (point))
4533 ;; If that position is "too late",
4534 ;; try the previous allowable position.
4535 ;; See if it is ok.
4536 (backward-char)
4537 (if (if forward
4538 ;; If going forward, don't accept the previous
4539 ;; allowable position if it is before the target line.
4540 (< line-beg (point))
4541 ;; If going backward, don't accept the previous
4542 ;; allowable position if it is still after the target line.
4543 (<= (point) line-end))
4544 (setq new (point))
4545 ;; As a last resort, use the end of the line.
4546 (setq new line-end))))
4548 ;; Now move to the updated destination, processing fields
4549 ;; as well as intangibility.
4550 (goto-char opoint)
4551 (let ((inhibit-point-motion-hooks nil))
4552 (goto-char
4553 ;; Ignore field boundaries if the initial and final
4554 ;; positions have the same `field' property, even if the
4555 ;; fields are non-contiguous. This seems to be "nicer"
4556 ;; behavior in many situations.
4557 (if (eq (get-char-property new 'field)
4558 (get-char-property opoint 'field))
4559 new
4560 (constrain-to-field new opoint t t
4561 'inhibit-line-move-field-capture))))
4563 ;; If all this moved us to a different line,
4564 ;; retry everything within that new line.
4565 (when (or (< (point) line-beg) (> (point) line-end))
4566 ;; Repeat the intangibility and field processing.
4567 (setq repeat t))))))
4569 (defun line-move-to-column (col)
4570 "Try to find column COL, considering invisibility.
4571 This function works only in certain cases,
4572 because what we really need is for `move-to-column'
4573 and `current-column' to be able to ignore invisible text."
4574 (if (zerop col)
4575 (beginning-of-line)
4576 (move-to-column col))
4578 (when (and line-move-ignore-invisible
4579 (not (bolp)) (invisible-p (1- (point))))
4580 (let ((normal-location (point))
4581 (normal-column (current-column)))
4582 ;; If the following character is currently invisible,
4583 ;; skip all characters with that same `invisible' property value.
4584 (while (and (not (eobp))
4585 (invisible-p (point)))
4586 (goto-char (next-char-property-change (point))))
4587 ;; Have we advanced to a larger column position?
4588 (if (> (current-column) normal-column)
4589 ;; We have made some progress towards the desired column.
4590 ;; See if we can make any further progress.
4591 (line-move-to-column (+ (current-column) (- col normal-column)))
4592 ;; Otherwise, go to the place we originally found
4593 ;; and move back over invisible text.
4594 ;; that will get us to the same place on the screen
4595 ;; but with a more reasonable buffer position.
4596 (goto-char normal-location)
4597 (let ((line-beg (line-beginning-position)))
4598 (while (and (not (bolp)) (invisible-p (1- (point))))
4599 (goto-char (previous-char-property-change (point) line-beg))))))))
4601 (defun move-end-of-line (arg)
4602 "Move point to end of current line as displayed.
4603 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4604 If point reaches the beginning or end of buffer, it stops there.
4606 To ignore the effects of the `intangible' text or overlay
4607 property, bind `inhibit-point-motion-hooks' to t.
4608 If there is an image in the current line, this function
4609 disregards newlines that are part of the text on which the image
4610 rests."
4611 (interactive "^p")
4612 (or arg (setq arg 1))
4613 (let (done)
4614 (while (not done)
4615 (let ((newpos
4616 (save-excursion
4617 (let ((goal-column 0)
4618 (line-move-visual nil))
4619 (and (line-move arg t)
4620 ;; With bidi reordering, we may not be at bol,
4621 ;; so make sure we are.
4623 (not (bobp))
4624 (progn
4625 (while (and (not (bobp)) (invisible-p (1- (point))))
4626 (goto-char (previous-single-char-property-change
4627 (point) 'invisible)))
4628 (backward-char 1)))
4629 (point)))))
4630 (goto-char newpos)
4631 (if (and (> (point) newpos)
4633 (backward-char 1)
4634 (if (and (> (point) newpos) (not (eobp))
4636 ;; If we skipped something intangible and now we're not
4637 ;; really at eol, keep going.
4638 (setq arg 1)
4639 (setq done t)))))))
4641 (defun move-beginning-of-line (arg)
4642 "Move point to beginning of current line as displayed.
4643 \(If there's an image in the line, this disregards newlines
4644 which are part of the text that the image rests on.)
4646 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4647 If point reaches the beginning or end of buffer, it stops there.
4648 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4649 (interactive "^p")
4650 (or arg (setq arg 1))
4652 (let ((orig (point))
4653 first-vis first-vis-field-value)
4655 ;; Move by lines, if ARG is not 1 (the default).
4656 (if (/= arg 1)
4657 (let ((line-move-visual nil))
4658 (line-move (1- arg) t)))
4660 ;; Move to beginning-of-line, ignoring fields and invisibles.
4662 (while (and (not (bobp)) (invisible-p (1- (point))))
4663 (goto-char (previous-char-property-change (point)))
4666 ;; Now find first visible char in the line
4667 (while (and (not (eobp)) (invisible-p (point)))
4668 (goto-char (next-char-property-change (point))))
4669 (setq first-vis (point))
4671 ;; See if fields would stop us from reaching FIRST-VIS.
4672 (setq first-vis-field-value
4673 (constrain-to-field first-vis orig (/= arg 1) t nil))
4675 (goto-char (if (/= first-vis-field-value first-vis)
4676 ;; If yes, obey them.
4677 first-vis-field-value
4678 ;; Otherwise, move to START with attention to fields.
4679 ;; (It is possible that fields never matter in this case.)
4680 (constrain-to-field (point) orig
4681 (/= arg 1) t nil)))))
4684 ;; Many people have said they rarely use this feature, and often type
4685 ;; it by accident. Maybe it shouldn't even be on a key.
4686 (put 'set-goal-column 'disabled t)
4688 (defun set-goal-column (arg)
4690 Those commands will move to this position in the line moved to
4691 rather than trying to keep the same horizontal position.
4692 With a non-nil argument ARG, clears out the goal column
4694 The goal column is stored in the variable `goal-column'."
4695 (interactive "P")
4696 (if arg
4697 (progn
4698 (setq goal-column nil)
4699 (message "No goal column"))
4700 (setq goal-column (current-column))
4701 ;; The older method below can be erroneous if `set-goal-column' is bound
4702 ;; to a sequence containing %
4703 ;;(message (substitute-command-keys
4705 ;;goal-column)
4706 (message "%s"
4707 (concat
4708 (format "Goal column %d " goal-column)
4709 (substitute-command-keys
4712 )
4713 nil)
4714 \f
4715 ;;; Editing based on visual lines, as opposed to logical lines.
4717 (defun end-of-visual-line (&optional n)
4718 "Move point to end of current visual line.
4719 With argument N not nil or 1, move forward N - 1 visual lines first.
4720 If point reaches the beginning or end of buffer, it stops there.
4721 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4722 (interactive "^p")
4723 (or n (setq n 1))
4724 (if (/= n 1)
4725 (let ((line-move-visual t))
4726 (line-move (1- n) t)))
4727 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4728 ;; constrain to field boundaries, so we don't either.
4729 (vertical-motion (cons (window-width) 0)))
4731 (defun beginning-of-visual-line (&optional n)
4732 "Move point to beginning of current visual line.
4733 With argument N not nil or 1, move forward N - 1 visual lines first.
4734 If point reaches the beginning or end of buffer, it stops there.
4735 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4736 (interactive "^p")
4737 (or n (setq n 1))
4738 (let ((opoint (point)))
4739 (if (/= n 1)
4740 (let ((line-move-visual t))
4741 (line-move (1- n) t)))
4742 (vertical-motion 0)
4743 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4744 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4746 (defun kill-visual-line (&optional arg)
4747 "Kill the rest of the visual line.
4748 With prefix argument ARG, kill that many visual lines from point.
4749 If ARG is negative, kill visual lines backward.
4750 If ARG is zero, kill the text before point on the current visual
4751 line.
4753 If you want to append the killed line to the last killed text,
4756 If the buffer is read-only, Emacs will beep and refrain from deleting
4757 the line, but put the line in the kill ring anyway. This means that
4758 you can use this command to copy text from a read-only buffer.
4759 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4760 even beep.)"
4761 (interactive "P")
4762 ;; Like in `kill-line', it's better to move point to the other end
4763 ;; of the kill before killing.
4764 (let ((opoint (point))
4765 (kill-whole-line (and kill-whole-line (bolp))))
4766 (if arg
4767 (vertical-motion (prefix-numeric-value arg))
4768 (end-of-visual-line 1)
4769 (if (= (point) opoint)
4770 (vertical-motion 1)
4771 ;; Skip any trailing whitespace at the end of the visual line.
4772 ;; We used to do this only if `show-trailing-whitespace' is
4773 ;; nil, but that's wrong; the correct thing would be to check
4774 ;; whether the trailing whitespace is highlighted. But, it's
4775 ;; OK to just do this unconditionally.
4778 (1+ (point))
4779 (point)))))
4781 (defun next-logical-line (&optional arg try-vscroll)
4782 "Move cursor vertically down ARG lines.
4783 This is identical to `next-line', except that it always moves
4784 by logical lines instead of visual lines, ignoring the value of
4785 the variable `line-move-visual'."
4787 (let ((line-move-visual nil))
4788 (with-no-warnings
4789 (next-line arg try-vscroll))))
4791 (defun previous-logical-line (&optional arg try-vscroll)
4792 "Move cursor vertically up ARG lines.
4793 This is identical to `previous-line', except that it always moves
4794 by logical lines instead of visual lines, ignoring the value of
4795 the variable `line-move-visual'."
4797 (let ((line-move-visual nil))
4798 (with-no-warnings
4799 (previous-line arg try-vscroll))))
4801 (defgroup visual-line nil
4802 "Editing based on visual lines."
4803 :group 'convenience
4804 :version "23.1")
4806 (defvar visual-line-mode-map
4807 (let ((map (make-sparse-keymap)))
4808 (define-key map [remap kill-line] 'kill-visual-line)
4809 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4810 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4811 ;; These keybindings interfere with xterm function keys. Are
4812 ;; there any other suitable bindings?
4813 ;; (define-key map "\M-[" 'previous-logical-line)
4814 ;; (define-key map "\M-]" 'next-logical-line)
4815 map))
4817 (defcustom visual-line-fringe-indicators '(nil nil)
4818 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4819 The value should be a list of the form (LEFT RIGHT), where LEFT
4820 and RIGHT are symbols representing the bitmaps to display, to
4821 indicate wrapped lines, in the left and right fringes respectively.
4822 See also `fringe-indicator-alist'.
4823 The default is not to display fringe indicators for wrapped lines.
4824 This variable does not affect fringe indicators displayed for
4825 other purposes."
4826 :type '(list (choice (const :tag "Hide left indicator" nil)
4827 (const :tag "Left curly arrow" left-curly-arrow)
4828 (symbol :tag "Other bitmap"))
4829 (choice (const :tag "Hide right indicator" nil)
4830 (const :tag "Right curly arrow" right-curly-arrow)
4831 (symbol :tag "Other bitmap")))
4832 :set (lambda (symbol value)
4833 (dolist (buf (buffer-list))
4834 (with-current-buffer buf
4835 (when (and (boundp 'visual-line-mode)
4836 (symbol-value 'visual-line-mode))
4837 (setq fringe-indicator-alist
4838 (cons (cons 'continuation value)
4839 (assq-delete-all
4840 'continuation
4841 (copy-tree fringe-indicator-alist)))))))
4842 (set-default symbol value)))
4844 (defvar visual-line--saved-state nil)
4846 (define-minor-mode visual-line-mode
4847 "Redefine simple editing commands to act on visual lines, not logical lines.
4848 This also turns on `word-wrap' in the buffer."
4849 :keymap visual-line-mode-map
4850 :group 'visual-line
4851 :lighter " Wrap"
4852 (if visual-line-mode
4853 (progn
4854 (set (make-local-variable 'visual-line--saved-state) nil)
4855 ;; Save the local values of some variables, to be restored if
4856 ;; visual-line-mode is turned off.
4857 (dolist (var '(line-move-visual truncate-lines
4858 truncate-partial-width-windows
4859 word-wrap fringe-indicator-alist))
4860 (if (local-variable-p var)
4861 (push (cons var (symbol-value var))
4862 visual-line--saved-state)))
4863 (set (make-local-variable 'line-move-visual) t)
4864 (set (make-local-variable 'truncate-partial-width-windows) nil)
4865 (setq truncate-lines nil
4866 word-wrap t
4867 fringe-indicator-alist
4868 (cons (cons 'continuation visual-line-fringe-indicators)
4869 fringe-indicator-alist)))
4870 (kill-local-variable 'line-move-visual)
4871 (kill-local-variable 'word-wrap)
4872 (kill-local-variable 'truncate-lines)
4873 (kill-local-variable 'truncate-partial-width-windows)
4874 (kill-local-variable 'fringe-indicator-alist)
4875 (dolist (saved visual-line--saved-state)
4876 (set (make-local-variable (car saved)) (cdr saved)))
4877 (kill-local-variable 'visual-line--saved-state)))
4879 (defun turn-on-visual-line-mode ()
4880 (visual-line-mode 1))
4882 (define-globalized-minor-mode global-visual-line-mode
4883 visual-line-mode turn-on-visual-line-mode
4884 :lighter " vl")
4886 \f
4887 (defun transpose-chars (arg)
4888 "Interchange characters around point, moving forward one character.
4889 With prefix arg ARG, effect is to take character before point
4890 and drag it forward past ARG other characters (backward if ARG negative).
4891 If no argument and at end of line, the previous two chars are exchanged."
4892 (interactive "*P")
4893 (and (null arg) (eolp) (forward-char -1))
4894 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4896 (defun transpose-words (arg)
4897 "Interchange words around point, leaving point at end of them.
4898 With prefix arg ARG, effect is to take word before or around point
4899 and drag it forward past ARG other words (backward if ARG negative).
4900 If ARG is zero, the words around or after point and around or after mark
4901 are interchanged."
4902 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4903 (interactive "*p")
4904 (transpose-subr 'forward-word arg))
4906 (defun transpose-sexps (arg)
4908 Does not work on a sexp that point is in the middle of
4909 if it is a list or string."
4910 (interactive "*p")
4911 (transpose-subr
4912 (lambda (arg)
4913 ;; Here we should try to simulate the behavior of
4914 ;; (cons (progn (forward-sexp x) (point))
4915 ;; (progn (forward-sexp (- x)) (point)))
4916 ;; Except that we don't want to rely on the second forward-sexp
4917 ;; putting us back to where we want to be, since forward-sexp-function
4918 ;; might do funny things like infix-precedence.
4919 (if (if (> arg 0)
4921 (and (not (bobp))
4923 ;; Jumping over a symbol. We might be inside it, mind you.
4924 (progn (funcall (if (> arg 0)
4925 'skip-syntax-backward 'skip-syntax-forward)
4926 "w_")
4927 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4928 ;; Otherwise, we're between sexps. Take a step back before jumping
4929 ;; to make sure we'll obey the same precedence no matter which direction
4930 ;; we're going.
4931 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4932 (cons (save-excursion (forward-sexp arg) (point))
4933 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4934 (not (zerop (funcall (if (> arg 0)
4935 'skip-syntax-forward
4936 'skip-syntax-backward)
4937 ".")))))
4938 (point)))))
4939 arg 'special))
4941 (defun transpose-lines (arg)
4942 "Exchange current line and previous line, leaving point after both.
4943 With argument ARG, takes previous line and moves it past ARG lines.
4944 With argument 0, interchanges line point is in with line mark is in."
4945 (interactive "*p")
4946 (transpose-subr (function
4947 (lambda (arg)
4948 (if (> arg 0)
4949 (progn
4950 ;; Move forward over ARG lines,
4951 ;; but create newlines if necessary.
4952 (setq arg (forward-line arg))
4954 (setq arg (1+ arg)))
4955 (if (> arg 0)
4956 (newline arg)))
4957 (forward-line arg))))
4958 arg))
4960 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4961 ;; which seems inconsistent with the ARG /= 0 case.
4962 ;; FIXME document SPECIAL.
4963 (defun transpose-subr (mover arg &optional special)
4964 "Subroutine to do the work of transposing objects.
4965 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4966 moves forward by units of the given object (e.g. forward-sentence,
4967 forward-paragraph). If ARG is zero, exchanges the current object
4968 with the one containing mark. If ARG is an integer, moves the
4969 current object past ARG following (if ARG is positive) or
4970 preceding (if ARG is negative) objects, leaving point after the
4971 current object."
4972 (let ((aux (if special mover
4973 (lambda (x)
4974 (cons (progn (funcall mover x) (point))
4975 (progn (funcall mover (- x)) (point))))))
4976 pos1 pos2)
4977 (cond
4978 ((= arg 0)
4979 (save-excursion
4980 (setq pos1 (funcall aux 1))
4981 (goto-char (or (mark) (error "No mark set in this buffer")))
4982 (setq pos2 (funcall aux 1))
4983 (transpose-subr-1 pos1 pos2))
4984 (exchange-point-and-mark))
4985 ((> arg 0)
4986 (setq pos1 (funcall aux -1))
4987 (setq pos2 (funcall aux arg))
4988 (transpose-subr-1 pos1 pos2)
4989 (goto-char (car pos2)))
4990 (t
4991 (setq pos1 (funcall aux -1))
4992 (goto-char (car pos1))
4993 (setq pos2 (funcall aux arg))
4994 (transpose-subr-1 pos1 pos2)))))
4996 (defun transpose-subr-1 (pos1 pos2)
4997 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4998 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4999 (when (> (car pos1) (car pos2))
5000 (let ((swap pos1))
5001 (setq pos1 pos2 pos2 swap)))
5002 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5003 (atomic-change-group
5004 (let (word2)
5005 ;; FIXME: We first delete the two pieces of text, so markers that
5006 ;; used to point to after the text end up pointing to before it :-(
5007 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5008 (goto-char (car pos2))
5009 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5010 (goto-char (car pos1))
5011 (insert word2))))
5012 \f
5013 (defun backward-word (&optional arg)
5014 "Move backward until encountering the beginning of a word.
5015 With argument ARG, do this that many times."
5016 (interactive "^p")
5017 (forward-word (- (or arg 1))))
5019 (defun mark-word (&optional arg allow-extend)
5020 "Set mark ARG words away from point.
5022 move to with the same argument.
5023 Interactively, if this command is repeated
5024 or (in Transient Mark mode) if the mark is active,
5025 it marks the next ARG words after the ones already marked."
5027 (cond ((and allow-extend
5028 (or (and (eq last-command this-command) (mark t))
5029 (region-active-p)))
5030 (setq arg (if arg (prefix-numeric-value arg)
5031 (if (< (mark) (point)) -1 1)))
5032 (set-mark
5033 (save-excursion
5034 (goto-char (mark))
5035 (forward-word arg)
5036 (point))))
5037 (t
5038 (push-mark
5039 (save-excursion
5040 (forward-word (prefix-numeric-value arg))
5041 (point))
5042 nil t))))
5044 (defun kill-word (arg)
5045 "Kill characters forward until encountering the end of a word.
5046 With argument ARG, do this that many times."
5047 (interactive "p")
5048 (kill-region (point) (progn (forward-word arg) (point))))
5050 (defun backward-kill-word (arg)
5051 "Kill characters backward until encountering the beginning of a word.
5052 With argument ARG, do this that many times."
5053 (interactive "p")
5054 (kill-word (- arg)))
5056 (defun current-word (&optional strict really-word)
5057 "Return the symbol or word that point is on (or a nearby one) as a string.
5058 The return value includes no text properties.
5059 If optional arg STRICT is non-nil, return nil unless point is within
5060 or adjacent to a symbol or word. In all cases the value can be nil
5061 if there is no word nearby.
5062 The function, belying its name, normally finds a symbol.
5063 If optional arg REALLY-WORD is non-nil, it finds just a word."
5064 (save-excursion
5065 (let* ((oldpoint (point)) (start (point)) (end (point))
5066 (syntaxes (if really-word "w" "w_"))
5067 (not-syntaxes (concat "^" syntaxes)))
5068 (skip-syntax-backward syntaxes) (setq start (point))
5069 (goto-char oldpoint)
5070 (skip-syntax-forward syntaxes) (setq end (point))
5071 (when (and (eq start oldpoint) (eq end oldpoint)
5072 ;; Point is neither within nor adjacent to a word.
5073 (not strict))
5074 ;; Look for preceding word in same line.
5075 (skip-syntax-backward not-syntaxes (line-beginning-position))
5076 (if (bolp)
5077 ;; No preceding word in same line.
5078 ;; Look for following word in same line.
5079 (progn
5080 (skip-syntax-forward not-syntaxes (line-end-position))
5081 (setq start (point))
5082 (skip-syntax-forward syntaxes)
5083 (setq end (point)))
5084 (setq end (point))
5085 (skip-syntax-backward syntaxes)
5086 (setq start (point))))
5087 ;; If we found something nonempty, return it as a string.
5088 (unless (= start end)
5089 (buffer-substring-no-properties start end)))))
5090 \f
5091 (defcustom fill-prefix nil
5092 "String for filling to insert at front of new line, or nil for none."
5093 :type '(choice (const :tag "None" nil)
5094 string)
5095 :group 'fill)
5096 (make-variable-buffer-local 'fill-prefix)
5097 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5099 (defcustom auto-fill-inhibit-regexp nil
5100 "Regexp to match lines which should not be auto-filled."
5101 :type '(choice (const :tag "None" nil)
5102 regexp)
5103 :group 'fill)
5105 (defun do-auto-fill ()
5106 "The default value for `normal-auto-fill-function'.
5107 This is the default auto-fill function, some major modes use a different one.
5108 Returns t if it really did any work."
5109 (let (fc justify give-up
5110 (fill-prefix fill-prefix))
5111 (if (or (not (setq justify (current-justification)))
5112 (null (setq fc (current-fill-column)))
5113 (and (eq justify 'left)
5114 (<= (current-column) fc))
5115 (and auto-fill-inhibit-regexp
5116 (save-excursion (beginning-of-line)
5117 (looking-at auto-fill-inhibit-regexp))))
5118 nil ;; Auto-filling not required
5119 (if (memq justify '(full center right))
5120 (save-excursion (unjustify-current-line)))
5122 ;; Choose a fill-prefix automatically.
5123 (when (and adaptive-fill-mode
5124 (or (null fill-prefix) (string= fill-prefix "")))
5125 (let ((prefix
5126 (fill-context-prefix
5127 (save-excursion (backward-paragraph 1) (point))
5128 (save-excursion (forward-paragraph 1) (point)))))
5129 (and prefix (not (equal prefix ""))
5130 ;; Use auto-indentation rather than a guessed empty prefix.
5131 (not (and fill-indent-according-to-mode
5133 (setq fill-prefix prefix))))
5135 (while (and (not give-up) (> (current-column) fc))
5136 ;; Determine where to split the line.
5137 (let* (after-prefix
5138 (fill-point
5139 (save-excursion
5140 (beginning-of-line)
5141 (setq after-prefix (point))
5142 (and fill-prefix
5143 (looking-at (regexp-quote fill-prefix))
5144 (setq after-prefix (match-end 0)))
5145 (move-to-column (1+ fc))
5146 (fill-move-to-break-point after-prefix)
5147 (point))))
5149 ;; See whether the place we found is any good.
5150 (if (save-excursion
5151 (goto-char fill-point)
5152 (or (bolp)
5153 ;; There is no use breaking at end of line.
5154 (save-excursion (skip-chars-forward " ") (eolp))
5155 ;; It is futile to split at the end of the prefix
5156 ;; since we would just insert the prefix again.
5157 (and after-prefix (<= (point) after-prefix))
5158 ;; Don't split right after a comment starter
5159 ;; since we would just make another comment starter.
5160 (and comment-start-skip
5161 (let ((limit (point)))
5162 (beginning-of-line)
5163 (and (re-search-forward comment-start-skip
5164 limit t)
5165 (eq (point) limit))))))
5166 ;; No good place to break => stop trying.
5167 (setq give-up t)
5168 ;; Ok, we have a useful place to break the line. Do it.
5169 (let ((prev-column (current-column)))
5170 ;; If point is at the fill-point, do not `save-excursion'.
5171 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5172 ;; point will end up before it rather than after it.
5173 (if (save-excursion
5175 (= (point) fill-point))
5176 (default-indent-new-line t)
5177 (save-excursion
5178 (goto-char fill-point)
5179 (default-indent-new-line t)))
5180 ;; Now do justification, if required
5181 (if (not (eq justify 'left))
5182 (save-excursion
5183 (end-of-line 0)
5184 (justify-current-line justify nil t)))
5185 ;; If making the new line didn't reduce the hpos of
5186 ;; the end of the line, then give up now;
5187 ;; trying again will not help.
5188 (if (>= (current-column) prev-column)
5189 (setq give-up t))))))
5190 ;; Justify last line.
5191 (justify-current-line justify t t)
5192 t)))
5194 (defvar comment-line-break-function 'comment-indent-new-line
5195 "*Mode-specific function which line breaks and continues a comment.
5196 This function is called during auto-filling when a comment syntax
5197 is defined.
5198 The function should take a single optional argument, which is a flag
5199 indicating whether it should use soft newlines.")
5201 (defun default-indent-new-line (&optional soft)
5202 "Break line at point and indent.
5203 If a comment syntax is defined, call `comment-indent-new-line'.
5205 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5206 unless optional argument SOFT is non-nil."
5207 (interactive)
5208 (if comment-start
5209 (funcall comment-line-break-function soft)
5210 ;; Insert the newline before removing empty space so that markers
5211 ;; get preserved better.
5213 (save-excursion (forward-char -1) (delete-horizontal-space))
5214 (delete-horizontal-space)
5216 (if (and fill-prefix (not adaptive-fill-mode))
5217 ;; Blindly trust a non-adaptive fill-prefix.
5218 (progn
5219 (indent-to-left-margin)
5220 (insert-before-markers-and-inherit fill-prefix))
5222 (cond
5223 ;; If there's an adaptive prefix, use it unless we're inside
5224 ;; a comment and the prefix is not a comment starter.
5225 (fill-prefix
5226 (indent-to-left-margin)
5227 (insert-and-inherit fill-prefix))
5228 ;; If we're not inside a comment, just try to indent.
5229 (t (indent-according-to-mode))))))
5231 (defvar normal-auto-fill-function 'do-auto-fill
5232 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5233 Some major modes set this.")
5235 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5236 ;; `functions' and `hooks' are usually unsafe to set, but setting
5237 ;; auto-fill-function to nil in a file-local setting is safe and
5238 ;; can be useful to prevent auto-filling.
5239 (put 'auto-fill-function 'safe-local-variable 'null)
5240 ;; FIXME: turn into a proper minor mode.
5241 ;; Add a global minor mode version of it.
5242 (define-minor-mode auto-fill-mode
5243 "Toggle Auto Fill mode.
5244 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5245 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5246 automatically breaks the line at a previous space.
5248 The value of `normal-auto-fill-function' specifies the function to use
5249 for `auto-fill-function' when turning Auto Fill mode on."
5250 :variable (eq auto-fill-function normal-auto-fill-function))
5252 ;; This holds a document string used to document auto-fill-mode.
5253 (defun auto-fill-function ()
5254 "Automatically break line at a previous space, in insertion of text."
5255 nil)
5257 (defun turn-on-auto-fill ()
5258 "Unconditionally turn on Auto Fill mode."
5259 (auto-fill-mode 1))
5261 (defun turn-off-auto-fill ()
5262 "Unconditionally turn off Auto Fill mode."
5263 (auto-fill-mode -1))
5265 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5267 (defun set-fill-column (arg)
5268 "Set `fill-column' to specified argument.
5271 (interactive
5272 (list (or current-prefix-arg
5273 ;; We used to use current-column silently, but C-x f is too easily
5274 ;; typed as a typo for C-x C-f, so we turned it into an error and
5275 ;; now an interactive prompt.
5276 (read-number "Set fill-column to: " (current-column)))))
5277 (if (consp arg)
5278 (setq arg (current-column)))
5279 (if (not (integerp arg))
5280 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5281 (error "set-fill-column requires an explicit argument")
5282 (message "Fill column set to %d (was %d)" arg fill-column)
5283 (setq fill-column arg)))
5284 \f
5285 (defun set-selective-display (arg)
5286 "Set `selective-display' to ARG; clear it if no arg.
5287 When the value of `selective-display' is a number > 0,
5288 lines whose indentation is >= that value are not displayed.
5289 The variable `selective-display' has a separate value for each buffer."
5290 (interactive "P")
5291 (if (eq selective-display t)
5292 (error "selective-display already in use for marked lines"))
5293 (let ((current-vpos
5294 (save-restriction
5295 (narrow-to-region (point-min) (point))
5296 (goto-char (window-start))
5297 (vertical-motion (window-height)))))
5298 (setq selective-display
5299 (and arg (prefix-numeric-value arg)))
5300 (recenter current-vpos))
5301 (set-window-start (selected-window) (window-start (selected-window)))
5302 (princ "selective-display set to " t)
5303 (prin1 selective-display t)
5304 (princ "." t))
5306 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5308 (defun toggle-truncate-lines (&optional arg)
5309 "Toggle whether to fold or truncate long lines for the current buffer.
5310 With prefix argument ARG, truncate long lines if ARG is positive,
5311 otherwise don't truncate them. Note that in side-by-side windows,
5312 this command has no effect if `truncate-partial-width-windows'
5313 is non-nil."
5314 (interactive "P")
5315 (setq truncate-lines
5316 (if (null arg)
5317 (not truncate-lines)
5318 (> (prefix-numeric-value arg) 0)))
5319 (force-mode-line-update)
5320 (unless truncate-lines
5321 (let ((buffer (current-buffer)))
5322 (walk-windows (lambda (window)
5323 (if (eq buffer (window-buffer window))
5324 (set-window-hscroll window 0)))
5325 nil t)))
5326 (message "Truncate long lines %s"
5327 (if truncate-lines "enabled" "disabled")))
5329 (defun toggle-word-wrap (&optional arg)
5330 "Toggle whether to use word-wrapping for continuation lines.
5331 With prefix argument ARG, wrap continuation lines at word boundaries
5332 if ARG is positive, otherwise wrap them at the right screen edge.
5333 This command toggles the value of `word-wrap'. It has no effect
5334 if long lines are truncated."
5335 (interactive "P")
5336 (setq word-wrap
5337 (if (null arg)
5338 (not word-wrap)
5339 (> (prefix-numeric-value arg) 0)))
5340 (force-mode-line-update)
5341 (message "Word wrapping %s"
5342 (if word-wrap "enabled" "disabled")))
5344 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5345 "The string displayed in the mode line when in overwrite mode.")
5346 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5347 "The string displayed in the mode line when in binary overwrite mode.")
5349 (define-minor-mode overwrite-mode
5350 "Toggle overwrite mode.
5351 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5352 otherwise turn it off. In overwrite mode, printing characters typed
5353 in replace existing text on a one-for-one basis, rather than pushing
5354 it to the right. At the end of a line, such characters extend the line.
5355 Before a tab, such characters insert until the tab is filled in.
5357 is supposed to make it easier to insert characters when necessary."
5358 :variable (eq overwrite-mode 'overwrite-mode-textual))
5360 (define-minor-mode binary-overwrite-mode
5361 "Toggle binary overwrite mode.
5362 With prefix argument ARG, turn binary overwrite mode on if ARG is
5363 positive, otherwise turn it off. In binary overwrite mode, printing
5364 characters typed in replace existing text. Newlines are not treated
5365 specially, so typing at the end of a line joins the line to the next,
5366 with the typed character between them. Typing before a tab character
5368 replaces the text at the cursor, just as ordinary typing characters do.
5370 Note that binary overwrite mode is not its own minor mode; it is a
5371 specialization of overwrite mode, entered by setting the
5372 `overwrite-mode' variable to `overwrite-mode-binary'."
5373 :variable (eq overwrite-mode 'overwrite-mode-binary))
5375 (define-minor-mode line-number-mode
5376 "Toggle Line Number mode.
5377 With ARG, turn Line Number mode on if ARG is positive, otherwise
5378 turn it off. When Line Number mode is enabled, the line number
5379 appears in the mode line.
5381 Line numbers do not appear for very large buffers and buffers
5382 with very long lines; see variables `line-number-display-limit'
5383 and `line-number-display-limit-width'."
5384 :init-value t :global t :group 'mode-line)
5386 (define-minor-mode column-number-mode
5387 "Toggle Column Number mode.
5388 With ARG, turn Column Number mode on if ARG is positive,
5389 otherwise turn it off. When Column Number mode is enabled, the
5390 column number appears in the mode line."
5391 :global t :group 'mode-line)
5393 (define-minor-mode size-indication-mode
5394 "Toggle Size Indication mode.
5395 With ARG, turn Size Indication mode on if ARG is positive,
5396 otherwise turn it off. When Size Indication mode is enabled, the
5397 size of the accessible part of the buffer appears in the mode line."
5398 :global t :group 'mode-line)
5400 (define-minor-mode auto-save-mode
5401 "Toggle auto-saving of contents of current buffer.
5402 With prefix argument ARG, turn auto-saving on if positive, else off."
5403 :variable ((and buffer-auto-save-file-name
5404 ;; If auto-save is off because buffer has shrunk,
5405 ;; then toggling should turn it on.
5406 (>= buffer-saved-size 0))
5407 . (lambda (val)
5408 (setq buffer-auto-save-file-name
5409 (cond
5410 ((null val) nil)
5411 ((and buffer-file-name auto-save-visited-file-name
5412 (not buffer-read-only))
5413 buffer-file-name)
5414 (t (make-auto-save-file-name))))))
5415 ;; If -1 was stored here, to temporarily turn off saving,
5416 ;; turn it back on.
5417 (and (< buffer-saved-size 0)
5418 (setq buffer-saved-size 0)))
5419 \f
5420 (defgroup paren-blinking nil
5421 "Blinking matching of parens and expressions."
5422 :prefix "blink-matching-"
5423 :group 'paren-matching)
5425 (defcustom blink-matching-paren t
5426 "Non-nil means show matching open-paren when close-paren is inserted."
5427 :type 'boolean
5428 :group 'paren-blinking)
5430 (defcustom blink-matching-paren-on-screen t
5431 "Non-nil means show matching open-paren when it is on screen.
5432 If nil, don't show it (but the open-paren can still be shown
5433 when it is off screen).
5435 This variable has no effect if `blink-matching-paren' is nil.
5436 \(In that case, the open-paren is never shown.)
5437 It is also ignored if `show-paren-mode' is enabled."
5438 :type 'boolean
5439 :group 'paren-blinking)
5441 (defcustom blink-matching-paren-distance (* 100 1024)
5442 "If non-nil, maximum distance to search backwards for matching open-paren.
5443 If nil, search stops at the beginning of the accessible portion of the buffer."
5444 :version "23.2" ; 25->100k
5445 :type '(choice (const nil) integer)
5446 :group 'paren-blinking)
5448 (defcustom blink-matching-delay 1
5449 "Time in seconds to delay after showing a matching paren."
5450 :type 'number
5451 :group 'paren-blinking)
5453 (defcustom blink-matching-paren-dont-ignore-comments nil
5454 "If nil, `blink-matching-paren' ignores comments.
5455 More precisely, when looking for the matching parenthesis,
5456 it skips the contents of comments that end before point."
5457 :type 'boolean
5458 :group 'paren-blinking)
5460 (defun blink-matching-check-mismatch (start end)
5461 "Return whether or not START...END are matching parens.
5462 END is the current point and START is the blink position.
5463 START might be nil if no matching starter was found.
5464 Returns non-nil if we find there is a mismatch."
5465 (let* ((end-syntax (syntax-after (1- end)))
5466 (matching-paren (and (consp end-syntax)
5467 (eq (syntax-class end-syntax) 5)
5468 (cdr end-syntax))))
5469 ;; For self-matched chars like " and $, we can't know when they're
5470 ;; mismatched or unmatched, so we can only do it for parens.
5471 (when matching-paren
5472 (not (and start
5473 (or
5474 (eq (char-after start) matching-paren)
5475 ;; The cdr might hold a new paren-class info rather than
5476 ;; a matching-char info, in which case the two CDRs
5477 ;; should match.
5478 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5480 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5481 "Function to check parentheses mismatches.
5482 The function takes two arguments (START and END) where START is the
5483 position just before the opening token and END is the position right after.
5484 START can be nil, if it was not found.
5485 The function should return non-nil if the two tokens do not match.")
5487 (defun blink-matching-open ()
5488 "Move cursor momentarily to the beginning of the sexp before point."
5489 (interactive)
5490 (when (and (not (bobp))
5491 blink-matching-paren)
5492 (let* ((oldpos (point))
5493 (message-log-max nil) ; Don't log messages about paren matching.
5494 (blinkpos
5495 (save-excursion
5496 (save-restriction
5497 (if blink-matching-paren-distance
5498 (narrow-to-region
5499 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5500 (- (point) blink-matching-paren-distance))
5501 oldpos))
5502 (let ((parse-sexp-ignore-comments
5503 (and parse-sexp-ignore-comments
5504 (not blink-matching-paren-dont-ignore-comments))))
5505 (condition-case ()
5506 (progn
5507 (forward-sexp -1)
5508 ;; backward-sexp skips backward over prefix chars,
5509 ;; so move back to the matching paren.
5510 (while (and (< (point) (1- oldpos))
5511 (let ((code (syntax-after (point))))
5512 (or (eq (syntax-class code) 6)
5513 (eq (logand 1048576 (car code))
5514 1048576))))
5515 (forward-char 1))
5516 (point))
5517 (error nil))))))
5518 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5519 (cond
5520 (mismatch
5521 (if blinkpos
5522 (if (minibufferp)
5523 (minibuffer-message "Mismatched parentheses")
5524 (message "Mismatched parentheses"))
5525 (if (minibufferp)
5526 (minibuffer-message "Unmatched parenthesis")
5527 (message "Unmatched parenthesis"))))
5528 ((not blinkpos) nil)
5529 ((pos-visible-in-window-p blinkpos)
5530 ;; Matching open within window, temporarily move to blinkpos but only
5531 ;; if `blink-matching-paren-on-screen' is non-nil.
5532 (and blink-matching-paren-on-screen
5533 (not show-paren-mode)
5534 (save-excursion
5535 (goto-char blinkpos)
5536 (sit-for blink-matching-delay))))
5537 (t
5538 (save-excursion
5539 (goto-char blinkpos)
5540 (let ((open-paren-line-string
5541 ;; Show what precedes the open in its line, if anything.
5542 (cond
5544 (buffer-substring (line-beginning-position)
5545 (1+ blinkpos)))
5546 ;; Show what follows the open in its line, if anything.
5547 ((save-excursion
5548 (forward-char 1)
5550 (not (eolp)))
5551 (buffer-substring blinkpos
5552 (line-end-position)))
5553 ;; Otherwise show the previous nonblank line,
5554 ;; if there is one.
5556 (concat
5557 (buffer-substring (progn
5559 (line-beginning-position))
5560 (progn (end-of-line)
5562 (point)))
5563 ;; Replace the newline and other whitespace with `...'.
5564 "..."
5565 (buffer-substring blinkpos (1+ blinkpos))))
5566 ;; There is nothing to show except the char itself.
5567 (t (buffer-substring blinkpos (1+ blinkpos))))))
5568 (message "Matches %s"
5569 (substring-no-properties open-paren-line-string)))))))))
5571 (defvar blink-paren-function 'blink-matching-open
5572 "Function called, if non-nil, whenever a close parenthesis is inserted.
5573 More precisely, a char with closeparen syntax is self-inserted.")
5575 (defun blink-paren-post-self-insert-function ()
5576 (when (and (eq (char-before) last-command-event) ; Sanity check.
5577 (memq (char-syntax last-command-event) '(?\) ?\$))
5578 blink-paren-function
5579 (not executing-kbd-macro)
5580 (not noninteractive)
5581 ;; Verify an even number of quoting characters precede the close.
5582 (= 1 (logand 1 (- (point)
5583 (save-excursion
5584 (forward-char -1)
5586 (point))))))
5587 (funcall blink-paren-function)))
5589 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5590 ;; Most likely, this hook is nil, so this arg doesn't matter,
5591 ;; but I use it as a reminder that this function usually
5592 ;; likes to be run after others since it does `sit-for'.
5593 'append)
5594 \f
5595 ;; This executes C-g typed while Emacs is waiting for a command.
5596 ;; Quitting out of a program does not go through here;
5597 ;; that happens in the QUIT macro at the C code level.
5598 (defun keyboard-quit ()
5599 "Signal a `quit' condition.
5600 During execution of Lisp code, this character causes a quit directly.
5601 At top-level, as an editor command, this simply beeps."
5602 (interactive)
5603 ;; Avoid adding the region to the window selection.
5604 (setq saved-region-selection nil)
5605 (let (select-active-regions)
5606 (deactivate-mark))
5607 (if (fboundp 'kmacro-keyboard-quit)
5608 (kmacro-keyboard-quit))
5609 (setq defining-kbd-macro nil)
5610 (signal 'quit nil))
5612 (defvar buffer-quit-function nil
5615 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5617 (defun keyboard-escape-quit ()
5619 This command can exit an interactive command such as `query-replace',
5620 can clear out a prefix argument or a region,
5621 can get out of the minibuffer or other recursive edit,
5622 cancel the use of the current buffer (for special-purpose buffers),
5623 or go back to just one window (by deleting all but the selected window)."
5624 (interactive)
5625 (cond ((eq last-command 'mode-exited) nil)
5626 ((region-active-p)
5627 (deactivate-mark))
5628 ((> (minibuffer-depth) 0)
5629 (abort-recursive-edit))
5630 (current-prefix-arg
5631 nil)
5632 ((> (recursion-depth) 0)
5633 (exit-recursive-edit))
5634 (buffer-quit-function
5635 (funcall buffer-quit-function))
5636 ((not (one-window-p t))
5637 (delete-other-windows))
5639 (bury-buffer))))
5641 (defun play-sound-file (file &optional volume device)
5642 "Play sound stored in FILE.
5643 VOLUME and DEVICE correspond to the keywords of the sound
5644 specification for `play-sound'."
5645 (interactive "fPlay sound file: ")
5646 (let ((sound (list :file file)))
5647 (if volume
5648 (plist-put sound :volume volume))
5649 (if device
5650 (plist-put sound :device device))
5651 (push 'sound sound)
5652 (play-sound sound)))
5654 \f
5655 (defcustom read-mail-command 'rmail
5656 "Your preference for a mail reading package.
5657 This is used by some keybindings which support reading mail.
5658 See also `mail-user-agent' concerning sending mail."
5661 (function-item :tag "Emacs interface to MH"
5663 (function :tag "Other"))
5664 :version "21.1"
5665 :group 'mail)
5667 (defcustom mail-user-agent 'message-user-agent
5668 "Your preference for a mail composition package.
5669 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5670 outgoing email message. This variable lets you specify which
5671 mail-sending package you prefer.
5673 Valid values include:
5675 `message-user-agent' -- use the Message package.
5676 See Info node `(message)'.
5677 `sendmail-user-agent' -- use the Mail package.
5678 See Info node `(emacs)Sending Mail'.
5679 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5680 See Info node `(mh-e)'.
5681 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5682 paraphernalia, particularly the Gcc: header for
5683 archiving.
5685 Additional valid symbols may be available; check with the author of
5686 your package for details. The function should return non-nil if it
5687 succeeds.
5689 See also `read-mail-command' concerning reading mail."
5690 :type '(radio (function-item :tag "Message package"
5692 message-user-agent)
5693 (function-item :tag "Mail package"
5695 sendmail-user-agent)
5696 (function-item :tag "Emacs interface to MH"
5698 mh-e-user-agent)
5699 (function-item :tag "Message with full Gnus features"
5701 gnus-user-agent)
5702 (function :tag "Other"))
5703 :version "23.2" ; sendmail->message
5704 :group 'mail)
5706 (defcustom compose-mail-user-agent-warnings t
5707 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5708 If the value of `mail-user-agent' is the default, and the user
5709 appears to have customizations applying to the old default,
5710 `compose-mail' issues a warning."
5711 :type 'boolean
5712 :version "23.2"
5713 :group 'mail)
5715 (defun rfc822-goto-eoh ()
5716 "If the buffer starts with a mail header, move point to the header's end.
5717 Otherwise, moves to `point-min'.
5718 The end of the header is the start of the next line, if there is one,
5719 else the end of the last line. This function obeys RFC822."
5720 (goto-char (point-min))
5721 (when (re-search-forward
5723 (goto-char (match-beginning 0))))
5725 (defun compose-mail (&optional to subject other-headers continue
5726 switch-function yank-action send-actions
5727 return-action)
5728 "Start composing a mail message to send.
5729 This uses the user's chosen mail composition package
5730 as selected with the variable `mail-user-agent'.
5731 The optional arguments TO and SUBJECT specify recipients
5732 and the initial Subject field, respectively.
5734 OTHER-HEADERS is an alist specifying additional
5735 header fields. Elements look like (HEADER . VALUE) where both
5736 HEADER and VALUE are strings.
5738 CONTINUE, if non-nil, says to continue editing a message already
5739 being composed. Interactively, CONTINUE is the prefix argument.
5741 SWITCH-FUNCTION, if non-nil, is a function to use to
5742 switch to and display the buffer used for mail composition.
5744 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5745 to insert the raw text of the message being replied to.
5746 It has the form (FUNCTION . ARGS). The user agent will apply
5747 FUNCTION to ARGS, to insert the raw text of the original message.
5748 \(The user agent will also run `mail-citation-hook', *after* the
5749 original text has been inserted in this way.)
5751 SEND-ACTIONS is a list of actions to call when the message is sent.
5752 Each action has the form (FUNCTION . ARGS).
5754 RETURN-ACTION, if non-nil, is an action for returning to the
5755 caller. It has the form (FUNCTION . ARGS). The function is
5756 called after the mail has been sent or put aside, and the mail
5757 buffer buried."
5758 (interactive
5759 (list nil nil nil current-prefix-arg))
5761 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5762 ;; from sendmail-user-agent to message-user-agent. Some users may
5763 ;; encounter incompatibilities. This hack tries to detect problems
5764 ;; and warn about them.
5765 (and compose-mail-user-agent-warnings
5766 (eq mail-user-agent 'message-user-agent)
5767 (let (warn-vars)
5768 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5769 mail-yank-hooks mail-archive-file-name
5770 mail-default-reply-to mail-mailing-lists
5771 mail-self-blind))
5772 (and (boundp var)
5773 (symbol-value var)
5774 (push var warn-vars)))
5775 (when warn-vars
5776 (display-warning 'mail
5777 (format "\
5778 The default mail mode is now Message mode.
5779 You have the following Mail mode variable%s customized:
5781 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5782 (if (> (length warn-vars) 1) "s" "")
5783 (mapconcat 'symbol-name
5784 warn-vars " "))))))
5786 (let ((function (get mail-user-agent 'composefunc)))
5787 (funcall function to subject other-headers continue switch-function
5788 yank-action send-actions return-action)))
5790 (defun compose-mail-other-window (&optional to subject other-headers continue
5791 yank-action send-actions
5792 return-action)
5794 (interactive (list nil nil nil current-prefix-arg))
5795 (compose-mail to subject other-headers continue
5796 'pop-to-buffer-other-window yank-action send-actions
5797 return-action))
5799 (defun compose-mail-other-frame (&optional to subject other-headers continue
5800 yank-action send-actions
5801 return-action)
5803 (interactive (list nil nil nil current-prefix-arg))
5804 (compose-mail to subject other-headers continue
5805 'pop-to-buffer-other-frame yank-action send-actions
5806 return-action))
5807 \f
5808 (defvar set-variable-value-history nil
5809 "History of values entered with `set-variable'.
5811 Maximum length of the history list is determined by the value
5812 of `history-length', which see.")
5814 (defun set-variable (variable value &optional make-local)
5815 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5816 VARIABLE should be a user option variable name, a Lisp variable
5817 meant to be customized by users. You should enter VALUE in Lisp syntax,
5818 so if you want VALUE to be a string, you must surround it with doublequotes.
5819 VALUE is used literally, not evaluated.
5821 If VARIABLE has a `variable-interactive' property, that is used as if
5822 it were the arg to `interactive' (which see) to interactively read VALUE.
5824 If VARIABLE has been defined with `defcustom', then the type information
5825 in the definition is used to check that VALUE is valid.
5827 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5828 (interactive
5829 (let* ((default-var (variable-at-point))
5830 (var (if (user-variable-p default-var)
5831 (read-variable (format "Set variable (default %s): " default-var)
5832 default-var)
5833 (read-variable "Set variable: ")))
5834 (minibuffer-help-form '(describe-variable var))
5835 (prop (get var 'variable-interactive))
5836 (obsolete (car (get var 'byte-obsolete-variable)))
5837 (prompt (format "Set %s %s to value: " var
5838 (cond ((local-variable-p var)
5839 "(buffer-local)")
5840 ((or current-prefix-arg
5841 (local-variable-if-set-p var))
5842 "buffer-locally")
5843 (t "globally"))))
5844 (val (progn
5845 (when obsolete
5846 (message (concat "`%S' is obsolete; "
5847 (if (symbolp obsolete) "use `%S' instead" "%s"))
5848 var obsolete)
5849 (sit-for 3))
5850 (if prop
5851 ;; Use VAR's `variable-interactive' property
5852 ;; as an interactive spec for prompting.
5853 (call-interactively `(lambda (arg)
5854 (interactive ,prop)
5855 arg))
5856 (read
5857 (read-string prompt nil
5858 'set-variable-value-history
5859 (format "%S" (symbol-value var))))))))
5860 (list var val current-prefix-arg)))
5862 (and (custom-variable-p variable)
5863 (not (get variable 'custom-type))
5864 (custom-load-symbol variable))
5865 (let ((type (get variable 'custom-type)))
5866 (when type
5867 ;; Match with custom type.
5868 (require 'cus-edit)
5869 (setq type (widget-convert type))
5870 (unless (widget-apply type :match value)
5871 (error "Value `%S' does not match type %S of %S"
5872 value (car type) variable))))
5874 (if make-local
5875 (make-local-variable variable))
5877 (set variable value)
5879 ;; Force a thorough redisplay for the case that the variable
5880 ;; has an effect on the display, like `tab-width' has.
5881 (force-mode-line-update))
5882 \f
5883 ;; Define the major mode for lists of completions.
5885 (defvar completion-list-mode-map
5886 (let ((map (make-sparse-keymap)))
5887 (define-key map [mouse-2] 'mouse-choose-completion)
5888 (define-key map [follow-link] 'mouse-face)
5889 (define-key map [down-mouse-2] nil)
5890 (define-key map "\C-m" 'choose-completion)
5891 (define-key map "\e\e\e" 'delete-completion-window)
5892 (define-key map [left] 'previous-completion)
5893 (define-key map [right] 'next-completion)
5894 (define-key map "q" 'quit-window)
5895 (define-key map "z" 'kill-this-buffer)
5896 map)
5897 "Local map for completion list buffers.")
5899 ;; Completion mode is suitable only for specially formatted data.
5900 (put 'completion-list-mode 'mode-class 'special)
5902 (defvar completion-reference-buffer nil
5903 "Record the buffer that was current when the completion list was requested.
5904 This is a local variable in the completion list buffer.
5905 Initial value is nil to avoid some compiler warnings.")
5907 (defvar completion-no-auto-exit nil
5908 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5909 This also applies to other functions such as `choose-completion'.")
5911 (defvar completion-base-position nil
5912 "Position of the base of the text corresponding to the shown completions.
5913 This variable is used in the *Completions* buffers.
5914 Its value is a list of the form (START END) where START is the place
5915 where the completion should be inserted and END (if non-nil) is the end
5916 of the text to replace. If END is nil, point is used instead.")
5918 (defvar completion-list-insert-choice-function #'completion--replace
5919 "Function to use to insert the text chosen in *Completions*.
5920 Called with 3 arguments (BEG END TEXT), it should replace the text
5921 between BEG and END with TEXT. Expected to be set buffer-locally
5922 in the *Completions* buffer.")
5924 (defvar completion-base-size nil
5925 "Number of chars before point not involved in completion.
5926 This is a local variable in the completion list buffer.
5927 It refers to the chars in the minibuffer if completing in the
5928 minibuffer, or in `completion-reference-buffer' otherwise.
5929 Only characters in the field at point are included.
5931 If nil, Emacs determines which part of the tail end of the
5932 buffer's text is involved in completion by comparing the text
5933 directly.")
5934 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5936 (defun delete-completion-window ()
5937 "Delete the completion list window.
5938 Go to the window from which completion was requested."
5939 (interactive)
5940 (let ((buf completion-reference-buffer))
5941 (if (one-window-p t)
5942 (if (window-dedicated-p (selected-window))
5943 (delete-frame (selected-frame)))
5944 (delete-window (selected-window))
5945 (if (get-buffer-window buf)
5946 (select-window (get-buffer-window buf))))))
5948 (defun previous-completion (n)
5949 "Move to the previous item in the completion list."
5950 (interactive "p")
5951 (next-completion (- n)))
5953 (defun next-completion (n)
5954 "Move to the next item in the completion list.
5955 With prefix argument N, move N items (negative N means move backward)."
5956 (interactive "p")
5957 (let ((beg (point-min)) (end (point-max)))
5958 (while (and (> n 0) (not (eobp)))
5959 ;; If in a completion, move to the end of it.
5960 (when (get-text-property (point) 'mouse-face)
5961 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5962 ;; Move to start of next one.
5963 (unless (get-text-property (point) 'mouse-face)
5964 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5965 (setq n (1- n)))
5966 (while (and (< n 0) (not (bobp)))
5967 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5968 ;; If in a completion, move to the start of it.
5969 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5970 (goto-char (previous-single-property-change
5971 (point) 'mouse-face nil beg)))
5972 ;; Move to end of the previous completion.
5973 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5974 (goto-char (previous-single-property-change
5975 (point) 'mouse-face nil beg)))
5976 ;; Move to the start of that one.
5977 (goto-char (previous-single-property-change
5978 (point) 'mouse-face nil beg))
5979 (setq n (1+ n))))))
5981 (defun choose-completion (&optional event)
5982 "Choose the completion at point."
5983 (interactive (list last-nonmenu-event))
5984 ;; In case this is run via the mouse, give temporary modes such as
5985 ;; isearch a chance to turn off.
5986 (run-hooks 'mouse-leave-buffer-hook)
5987 (with-current-buffer (window-buffer (posn-window (event-start event)))
5988 (let ((buffer completion-reference-buffer)
5989 (base-size completion-base-size)
5990 (base-position completion-base-position)
5991 (insert-function completion-list-insert-choice-function)
5992 (choice
5993 (save-excursion
5994 (goto-char (posn-point (event-start event)))
5995 (let (beg end)
5996 (cond
5997 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
5998 (setq end (point) beg (1+ (point))))
5999 ((and (not (bobp))
6000 (get-text-property (1- (point)) 'mouse-face))
6001 (setq end (1- (point)) beg (point)))
6002 (t (error "No completion here")))
6003 (setq beg (previous-single-property-change beg 'mouse-face))
6004 (setq end (or (next-single-property-change end 'mouse-face)
6005 (point-max)))
6006 (buffer-substring-no-properties beg end))))
6007 (owindow (selected-window)))
6009 (unless (buffer-live-p buffer)
6010 (error "Destination buffer is dead"))
6011 (select-window (posn-window (event-start event)))
6012 (if (and (one-window-p t 'selected-frame)
6013 (window-dedicated-p (selected-window)))
6014 ;; This is a special buffer's frame
6015 (iconify-frame (selected-frame))
6016 (or (window-dedicated-p (selected-window))
6017 (bury-buffer)))
6018 (select-window
6019 (or (get-buffer-window buffer 0)
6020 owindow))
6022 (with-current-buffer buffer
6023 (choose-completion-string
6024 choice buffer
6025 (or base-position
6026 (when base-size
6027 ;; Someone's using old completion code that doesn't know
6028 ;; about base-position yet.
6029 (list (+ base-size (field-beginning))))
6030 ;; If all else fails, just guess.
6031 (list (choose-completion-guess-base-position choice)))
6032 insert-function)))))
6034 ;; Delete the longest partial match for STRING
6035 ;; that can be found before POINT.
6036 (defun choose-completion-guess-base-position (string)
6037 (save-excursion
6038 (let ((opoint (point))
6039 len)
6040 ;; Try moving back by the length of the string.
6041 (goto-char (max (- (point) (length string))
6042 (minibuffer-prompt-end)))
6043 ;; See how far back we were actually able to move. That is the
6044 ;; upper bound on how much we can match and delete.
6045 (setq len (- opoint (point)))
6046 (if completion-ignore-case
6047 (setq string (downcase string)))
6048 (while (and (> len 0)
6049 (let ((tail (buffer-substring (point) opoint)))
6050 (if completion-ignore-case
6051 (setq tail (downcase tail)))
6052 (not (string= tail (substring string 0 len)))))
6053 (setq len (1- len))
6054 (forward-char 1))
6055 (point))))
6057 (defun choose-completion-delete-max-match (string)
6058 (delete-region (choose-completion-guess-base-position string) (point)))
6059 (make-obsolete 'choose-completion-delete-max-match
6060 'choose-completion-guess-base-position "23.2")
6062 (defvar choose-completion-string-functions nil
6063 "Functions that may override the normal insertion of a completion choice.
6064 These functions are called in order with four arguments:
6065 CHOICE - the string to insert in the buffer,
6066 BUFFER - the buffer in which the choice should be inserted,
6067 MINI-P - non-nil if BUFFER is a minibuffer, and
6068 BASE-SIZE - the number of characters in BUFFER before
6069 the string being completed.
6071 If a function in the list returns non-nil, that function is supposed
6072 to have inserted the CHOICE in the BUFFER, and possibly exited
6073 the minibuffer; no further functions will be called.
6075 If all functions in the list return nil, that means to use
6076 the default method of inserting the completion in BUFFER.")
6078 (defun choose-completion-string (choice &optional
6079 buffer base-position insert-function)
6080 "Switch to BUFFER and insert the completion choice CHOICE.
6081 BASE-POSITION, says where to insert the completion."
6083 ;; If BUFFER is the minibuffer, exit the minibuffer
6084 ;; unless it is reading a file name and CHOICE is a directory,
6085 ;; or completion-no-auto-exit is non-nil.
6087 ;; Some older code may call us passing `base-size' instead of
6088 ;; `base-position'. It's difficult to make any use of `base-size',
6089 ;; so we just ignore it.
6090 (unless (consp base-position)
6091 (message "Obsolete `base-size' passed to choose-completion-string")
6092 (setq base-position nil))
6094 (let* ((buffer (or buffer completion-reference-buffer))
6095 (mini-p (minibufferp buffer)))
6096 ;; If BUFFER is a minibuffer, barf unless it's the currently
6097 ;; active minibuffer.
6098 (if (and mini-p
6099 (not (and (active-minibuffer-window)
6100 (equal buffer
6101 (window-buffer (active-minibuffer-window))))))
6102 (error "Minibuffer is not active for completion")
6103 ;; Set buffer so buffer-local choose-completion-string-functions works.
6104 (set-buffer buffer)
6105 (unless (run-hook-with-args-until-success
6106 'choose-completion-string-functions
6107 ;; The fourth arg used to be `mini-p' but was useless
6108 ;; (since minibufferp can be used on the `buffer' arg)
6109 ;; and indeed unused. The last used to be `base-size', so we
6110 ;; keep it to try and avoid breaking old code.
6111 choice buffer base-position nil)
6112 ;; This remove-text-properties should be unnecessary since `choice'
6113 ;; comes from buffer-substring-no-properties.
6114 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6115 ;; Insert the completion into the buffer where it was requested.
6116 (funcall (or insert-function completion-list-insert-choice-function)
6117 (or (car base-position) (point))
6118 (or (cadr base-position) (point))
6119 choice)
6120 ;; Update point in the window that BUFFER is showing in.
6121 (let ((window (get-buffer-window buffer t)))
6122 (set-window-point window (point)))
6123 ;; If completing for the minibuffer, exit it with this choice.
6124 (and (not completion-no-auto-exit)
6125 (minibufferp buffer)
6126 minibuffer-completion-table
6127 ;; If this is reading a file name, and the file name chosen
6128 ;; is a directory, don't exit the minibuffer.
6129 (let* ((result (buffer-substring (field-beginning) (point)))
6130 (bounds
6131 (completion-boundaries result minibuffer-completion-table
6132 minibuffer-completion-predicate
6133 "")))
6134 (if (eq (car bounds) (length result))
6135 ;; The completion chosen leads to a new set of completions
6136 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6137 (let ((mini (active-minibuffer-window)))
6138 (select-window mini)
6139 (when minibuffer-auto-raise
6140 (raise-frame (window-frame mini))))
6141 (exit-minibuffer))))))))
6143 (define-derived-mode completion-list-mode nil "Completion List"
6144 "Major mode for buffers showing lists of possible completions.
6146 to select the completion near point.
6148 with the mouse.
6151 (set (make-local-variable 'completion-base-size) nil))
6153 (defun completion-list-mode-finish ()
6154 "Finish setup of the completions buffer.
6155 Called from `temp-buffer-show-hook'."
6156 (when (eq major-mode 'completion-list-mode)
6157 (toggle-read-only 1)))
6159 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6162 ;; Variables and faces used in `completion-setup-function'.
6164 (defcustom completion-show-help t
6165 "Non-nil means show help message in *Completions* buffer."
6166 :type 'boolean
6167 :version "22.1"
6168 :group 'completion)
6170 ;; This function goes in completion-setup-hook, so that it is called
6171 ;; after the text of the completion list buffer is written.
6172 (defun completion-setup-function ()
6173 (let* ((mainbuf (current-buffer))
6174 (base-dir
6175 ;; When reading a file name in the minibuffer,
6176 ;; try and find the right default-directory to set in the
6177 ;; completion list buffer.
6178 ;; FIXME: Why do we do that, actually? --Stef
6179 (if minibuffer-completing-file-name
6180 (file-name-as-directory
6181 (expand-file-name
6182 (substring (minibuffer-completion-contents)
6183 0 (or completion-base-size 0)))))))
6184 (with-current-buffer standard-output
6185 (let ((base-size completion-base-size) ;Read before killing localvars.
6186 (base-position completion-base-position)
6187 (insert-fun completion-list-insert-choice-function))
6188 (completion-list-mode)
6189 (set (make-local-variable 'completion-base-size) base-size)
6190 (set (make-local-variable 'completion-base-position) base-position)
6191 (set (make-local-variable 'completion-list-insert-choice-function)
6192 insert-fun))
6193 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6194 (if base-dir (setq default-directory base-dir))
6195 ;; Maybe insert help string.
6196 (when completion-show-help
6197 (goto-char (point-min))
6198 (if (display-mouse-p)
6199 (insert (substitute-command-keys
6201 (insert (substitute-command-keys
6205 (add-hook 'completion-setup-hook 'completion-setup-function)
6207 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6208 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6210 (defun switch-to-completions ()
6211 "Select the completion list window."
6212 (interactive)
6213 (let ((window (or (get-buffer-window "*Completions*" 0)
6214 ;; Make sure we have a completions window.
6215 (progn (minibuffer-completion-help)
6216 (get-buffer-window "*Completions*" 0)))))
6217 (when window
6218 (select-window window)
6219 ;; In the new buffer, go to the first completion.
6220 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6221 (when (bobp)
6222 (next-completion 1)))))
6223 \f
6224 ;;; Support keyboard commands to turn on various modifiers.
6226 ;; These functions -- which are not commands -- each add one modifier
6227 ;; to the following event.
6229 (defun event-apply-alt-modifier (_ignore-prompt)
6232 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6233 (defun event-apply-super-modifier (_ignore-prompt)
6236 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6237 (defun event-apply-hyper-modifier (_ignore-prompt)
6240 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6241 (defun event-apply-shift-modifier (_ignore-prompt)
6244 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6245 (defun event-apply-control-modifier (_ignore-prompt)
6248 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6249 (defun event-apply-meta-modifier (_ignore-prompt)
6252 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6254 (defun event-apply-modifier (event symbol lshiftby prefix)
6255 "Apply a modifier flag to event EVENT.
6256 SYMBOL is the name of this modifier, as a symbol.
6257 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6258 PREFIX is the string that represents this modifier in an event type symbol."
6259 (if (numberp event)
6260 (cond ((eq symbol 'control)
6261 (if (and (<= (downcase event) ?z)
6262 (>= (downcase event) ?a))
6263 (- (downcase event) ?a -1)
6264 (if (and (<= (downcase event) ?Z)
6265 (>= (downcase event) ?A))
6266 (- (downcase event) ?A -1)
6267 (logior (lsh 1 lshiftby) event))))
6268 ((eq symbol 'shift)
6269 (if (and (<= (downcase event) ?z)
6270 (>= (downcase event) ?a))
6271 (upcase event)
6272 (logior (lsh 1 lshiftby) event)))
6273 (t
6274 (logior (lsh 1 lshiftby) event)))
6275 (if (memq symbol (event-modifiers event))
6276 event
6277 (let ((event-type (if (symbolp event) event (car event))))
6278 (setq event-type (intern (concat prefix (symbol-name event-type))))
6279 (if (symbolp event)
6280 event-type
6281 (cons event-type (cdr event)))))))
6283 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6284 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6285 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6286 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6287 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6288 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6289 \f
6290 ;;;; Keypad support.
6292 ;; Make the keypad keys act like ordinary typing keys. If people add
6293 ;; bindings for the function key symbols, then those bindings will
6294 ;; override these, so this shouldn't interfere with any existing
6295 ;; bindings.
6297 ;; Also tell read-char how to handle these keys.
6298 (mapc
6299 (lambda (keypad-normal)
6300 (let ((keypad (nth 0 keypad-normal))
6301 (normal (nth 1 keypad-normal)))
6302 (put keypad 'ascii-character normal)
6303 (define-key function-key-map (vector keypad) (vector normal))))
6304 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6305 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6306 (kp-space ?\s)
6309 (kp-multiply ?*)
6310 (kp-add ?+)
6311 (kp-separator ?,)
6312 (kp-subtract ?-)
6313 (kp-decimal ?.)
6314 (kp-divide ?/)
6315 (kp-equal ?=)
6316 ;; Do the same for various keys that are represented as symbols under
6317 ;; GUIs but naturally correspond to characters.
6318 (backspace 127)
6319 (delete 127)
6322 (clear ?\C-l)
6323 (return ?\C-m)
6324 (escape ?\e)
6325 ))
6326 \f
6327 ;;;;
6328 ;;;; forking a twin copy of a buffer.
6329 ;;;;
6331 (defvar clone-buffer-hook nil
6332 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6334 (defvar clone-indirect-buffer-hook nil
6335 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6337 (defun clone-process (process &optional newname)
6338 "Create a twin copy of PROCESS.
6339 If NEWNAME is nil, it defaults to PROCESS' name;
6340 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6341 If PROCESS is associated with a buffer, the new process will be associated
6342 with the current buffer instead.
6343 Returns nil if PROCESS has already terminated."
6344 (setq newname (or newname (process-name process)))
6346 (setq newname (substring newname 0 (match-beginning 0))))
6347 (when (memq (process-status process) '(run stop open))
6348 (let* ((process-connection-type (process-tty-name process))
6349 (new-process
6350 (if (memq (process-status process) '(open))
6351 (let ((args (process-contact process t)))
6352 (setq args (plist-put args :name newname))
6353 (setq args (plist-put args :buffer
6354 (if (process-buffer process)
6355 (current-buffer))))
6356 (apply 'make-network-process args))
6357 (apply 'start-process newname
6358 (if (process-buffer process) (current-buffer))
6359 (process-command process)))))
6360 (set-process-query-on-exit-flag
6361 new-process (process-query-on-exit-flag process))
6362 (set-process-inherit-coding-system-flag
6363 new-process (process-inherit-coding-system-flag process))
6364 (set-process-filter new-process (process-filter process))
6365 (set-process-sentinel new-process (process-sentinel process))
6366 (set-process-plist new-process (copy-sequence (process-plist process)))
6367 new-process)))
6369 ;; things to maybe add (currently partly covered by `funcall mode'):
6370 ;; - syntax-table
6371 ;; - overlays
6372 (defun clone-buffer (&optional newname display-flag)
6373 "Create and return a twin copy of the current buffer.
6374 Unlike an indirect buffer, the new buffer can be edited
6375 independently of the old one (if it is not read-only).
6376 NEWNAME is the name of the new buffer. It may be modified by
6377 adding or incrementing <N> at the end as necessary to create a
6378 unique buffer name. If nil, it defaults to the name of the
6379 current buffer, with the proper suffix. If DISPLAY-FLAG is
6380 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6381 clone a file-visiting buffer, or a buffer whose major mode symbol
6382 has a non-nil `no-clone' property, results in an error.
6384 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6385 current buffer with appropriate suffix. However, if a prefix
6386 argument is given, then the command prompts for NEWNAME in the
6387 minibuffer.
6389 This runs the normal hook `clone-buffer-hook' in the new buffer
6390 after it has been set up properly in other respects."
6391 (interactive
6392 (progn
6393 (if buffer-file-name
6394 (error "Cannot clone a file-visiting buffer"))
6395 (if (get major-mode 'no-clone)
6396 (error "Cannot clone a buffer in %s mode" mode-name))
6397 (list (if current-prefix-arg
6398 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6399 t)))
6400 (if buffer-file-name
6401 (error "Cannot clone a file-visiting buffer"))
6402 (if (get major-mode 'no-clone)
6403 (error "Cannot clone a buffer in %s mode" mode-name))
6404 (setq newname (or newname (buffer-name)))
6406 (setq newname (substring newname 0 (match-beginning 0))))
6407 (let ((buf (current-buffer))
6408 (ptmin (point-min))
6409 (ptmax (point-max))
6410 (pt (point))
6411 (mk (if mark-active (mark t)))
6412 (modified (buffer-modified-p))
6413 (mode major-mode)
6414 (lvars (buffer-local-variables))
6415 (process (get-buffer-process (current-buffer)))
6416 (new (generate-new-buffer (or newname (buffer-name)))))
6417 (save-restriction
6418 (widen)
6419 (with-current-buffer new
6420 (insert-buffer-substring buf)))
6421 (with-current-buffer new
6422 (narrow-to-region ptmin ptmax)
6423 (goto-char pt)
6424 (if mk (set-mark mk))
6425 (set-buffer-modified-p modified)
6427 ;; Clone the old buffer's process, if any.
6428 (when process (clone-process process))
6430 ;; Now set up the major mode.
6431 (funcall mode)
6433 ;; Set up other local variables.
6434 (mapc (lambda (v)
6435 (condition-case () ;in case var is read-only
6436 (if (symbolp v)
6437 (makunbound v)
6438 (set (make-local-variable (car v)) (cdr v)))
6439 (error nil)))
6440 lvars)
6442 ;; Run any hooks (typically set up by the major mode
6443 ;; for cloning to work properly).
6444 (run-hooks 'clone-buffer-hook))
6445 (if display-flag
6446 ;; Presumably the current buffer is shown in the selected frame, so
6447 ;; we want to display the clone elsewhere.
6448 (pop-to-buffer-other-window new))
6449 new))
6452 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6453 "Create an indirect buffer that is a twin copy of the current buffer.
6455 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6456 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6457 or if not called with a prefix arg, NEWNAME defaults to the current
6458 buffer's name. The name is modified by adding a `<N>' suffix to it
6459 or by incrementing the N in an existing suffix. Trying to clone a
6460 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6461 property results in an error.
6463 DISPLAY-FLAG non-nil means show the new buffer with
6464 `pop-to-buffer'. This is always done when called interactively.
6465 Non-interactively, if DISPLAY-FLAG equals 'other-window, display
6466 the buffer in another window.
6468 Optional third arg NORECORD non-nil means do not put this buffer
6469 at the front of the list of recently selected ones."
6470 (interactive
6471 (progn
6472 (if (get major-mode 'no-clone-indirect)
6473 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6474 (list (if current-prefix-arg
6475 (read-buffer "Name of indirect buffer: " (current-buffer)))
6476 t)))
6477 (if (get major-mode 'no-clone-indirect)
6478 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6479 (setq newname (or newname (buffer-name)))
6481 (setq newname (substring newname 0 (match-beginning 0))))
6482 (let* ((name (generate-new-buffer-name newname))
6483 (buffer (make-indirect-buffer (current-buffer) name t)))
6484 (with-current-buffer buffer
6485 (run-hooks 'clone-indirect-buffer-hook))
6486 (when display-flag
6487 (pop-to-buffer buffer (eq display-flag 'other-window) norecord))
6488 buffer))
6490 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6491 "Like `clone-indirect-buffer' but display in another window."
6492 (interactive
6493 (progn
6494 (if (get major-mode 'no-clone-indirect)
6495 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6496 (list (if current-prefix-arg
6497 (read-buffer "Name of indirect buffer: " (current-buffer)))
6498 'other-window)))
6499 (clone-indirect-buffer newname display-flag norecord))
6501 \f
6502 ;;; Handling of Backspace and Delete keys.
6504 (defcustom normal-erase-is-backspace 'maybe
6505 "Set the default behavior of the Delete and Backspace keys.
6507 If set to t, Delete key deletes forward and Backspace key deletes
6508 backward.
6510 If set to nil, both Delete and Backspace keys delete backward.
6512 If set to 'maybe (which is the default), Emacs automatically
6513 selects a behavior. On window systems, the behavior depends on
6514 the keyboard used. If the keyboard has both a Backspace key and
6515 a Delete key, and both are mapped to their usual meanings, the
6516 option's default value is set to t, so that Backspace can be used
6517 to delete backward, and Delete can be used to delete forward.
6519 If not running under a window system, customizing this option
6520 accomplishes a similar effect by mapping C-h, which is usually
6521 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6522 via `keyboard-translate'. The former functionality of C-h is
6523 available on the F1 key. You should probably not use this
6524 setting if you don't have both Backspace, Delete and F1 keys.
6526 Setting this variable with setq doesn't take effect. Programmatically,
6527 call `normal-erase-is-backspace-mode' (which see) instead."
6528 :type '(choice (const :tag "Off" nil)
6529 (const :tag "Maybe" maybe)
6530 (other :tag "On" t))
6531 :group 'editing-basics
6532 :version "21.1"
6533 :set (lambda (symbol value)
6534 ;; The fboundp is because of a problem with :set when
6535 ;; dumping Emacs. It doesn't really matter.
6536 (if (fboundp 'normal-erase-is-backspace-mode)
6537 (normal-erase-is-backspace-mode (or value 0))
6538 (set-default symbol value))))
6540 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6541 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6542 (unless frame (setq frame (selected-frame)))
6543 (with-selected-frame frame
6544 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6545 (normal-erase-is-backspace-mode
6546 (if (if (eq normal-erase-is-backspace 'maybe)
6547 (and (not noninteractive)
6548 (or (memq system-type '(ms-dos windows-nt))
6549 (memq window-system '(ns))
6550 (and (memq window-system '(x))
6551 (fboundp 'x-backspace-delete-keys-p)
6552 (x-backspace-delete-keys-p))
6553 ;; If the terminal Emacs is running on has erase char
6554 ;; set to ^H, use the Backspace key for deleting
6555 ;; backward, and the Delete key for deleting forward.
6556 (and (null window-system)
6557 (eq tty-erase-char ?\^H))))
6558 normal-erase-is-backspace)
6559 1 0)))))
6561 (define-minor-mode normal-erase-is-backspace-mode
6562 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6564 With numeric ARG, turn the mode on if and only if ARG is positive.
6566 On window systems, when this mode is on, Delete is mapped to C-d
6567 and Backspace is mapped to DEL; when this mode is off, both
6568 Delete and Backspace are mapped to DEL. (The remapping goes via
6569 `local-function-key-map', so binding Delete or Backspace in the
6570 global or local keymap will override that.)
6572 In addition, on window systems, the bindings of C-Delete, M-Delete,
6573 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6574 the global keymap in accordance with the functionality of Delete and
6575 Backspace. For example, if Delete is remapped to C-d, which deletes
6576 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6577 to DEL, which deletes backward, C-Delete is bound to
6578 `backward-kill-word'.
6580 If not running on a window system, a similar effect is accomplished by
6581 remapping C-h (normally produced by the Backspace key) and DEL via
6582 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6583 to C-d; if it's off, the keys are not remapped.
6585 When not running on a window system, and this mode is turned on, the
6586 former functionality of C-h is available on the F1 key. You should
6587 probably not turn on this mode on a text-only terminal if you don't
6588 have both Backspace, Delete and F1 keys.
6590 See also `normal-erase-is-backspace'."
6591 :variable (eq (terminal-parameter
6592 nil 'normal-erase-is-backspace) 1)
6593 (let ((enabled (eq 1 (terminal-parameter
6594 nil 'normal-erase-is-backspace))))
6596 (cond ((or (memq window-system '(x w32 ns pc))
6597 (memq system-type '(ms-dos windows-nt)))
6598 (let ((bindings
6599 `(([M-delete] [M-backspace])
6600 ([C-M-delete] [C-M-backspace])
6601 ([?\e C-delete] [?\e C-backspace]))))
6603 (if enabled
6604 (progn
6605 (define-key local-function-key-map [delete] [deletechar])
6606 (define-key local-function-key-map [kp-delete] [?\C-d])
6607 (define-key local-function-key-map [backspace] [?\C-?])
6608 (dolist (b bindings)
6609 ;; Not sure if input-decode-map is really right, but
6610 ;; keyboard-translate-table (used below) only works
6611 ;; for integer events, and key-translation-table is
6612 ;; global (like the global-map, used earlier).
6613 (define-key input-decode-map (car b) nil)
6614 (define-key input-decode-map (cadr b) nil)))
6615 (define-key local-function-key-map [delete] [?\C-?])
6616 (define-key local-function-key-map [kp-delete] [?\C-?])
6617 (define-key local-function-key-map [backspace] [?\C-?])
6618 (dolist (b bindings)
6619 (define-key input-decode-map (car b) (cadr b))
6620 (define-key input-decode-map (cadr b) (car b))))))
6621 (t
6622 (if enabled
6623 (progn
6624 (keyboard-translate ?\C-h ?\C-?)
6625 (keyboard-translate ?\C-? ?\C-d))
6626 (keyboard-translate ?\C-h ?\C-h)
6627 (keyboard-translate ?\C-? ?\C-?))))
6629 (if (called-interactively-p 'interactive)
6630 (message "Delete key deletes %s"
6631 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6632 "forward" "backward")))))
6633 \f
6634 (defvar vis-mode-saved-buffer-invisibility-spec nil
6635 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6637 (define-minor-mode visible-mode
6638 "Toggle Visible mode.
6639 With argument ARG turn Visible mode on if ARG is positive, otherwise
6640 turn it off.
6642 Enabling Visible mode makes all invisible text temporarily visible.
6643 Disabling Visible mode turns off that effect. Visible mode works by
6644 saving the value of `buffer-invisibility-spec' and setting it to nil."
6645 :lighter " Vis"
6646 :group 'editing-basics
6647 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6648 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6649 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6650 (when visible-mode
6651 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6652 buffer-invisibility-spec)
6653 (setq buffer-invisibility-spec nil)))
6654 \f
6655 ;; Minibuffer prompt stuff.
6657 ;;(defun minibuffer-prompt-modification (start end)
6658 ;; (error "You cannot modify the prompt"))
6659 ;;
6660 ;;
6661 ;;(defun minibuffer-prompt-insertion (start end)
6662 ;; (let ((inhibit-modification-hooks t))
6663 ;; (delete-region start end)
6664 ;; ;; Discard undo information for the text insertion itself
6665 ;; ;; and for the text deletion.above.
6666 ;; (when (consp buffer-undo-list)
6667 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6668 ;; (message "You cannot modify the prompt")))
6669 ;;
6670 ;;
6671 ;;(setq minibuffer-prompt-properties
6672 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6673 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6675 \f
6676 ;;;; Problematic external packages.
6678 ;; rms says this should be done by specifying symbols that define
6679 ;; versions together with bad values. This is therefore not as
6680 ;; flexible as it could be. See the thread:
6681 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6682 (defconst bad-packages-alist
6683 ;; Not sure exactly which semantic versions have problems.
6684 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6686 "The version of `semantic' loaded does not work in Emacs 22.
6687 It can cause constant high CPU load.
6688 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6689 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6690 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6691 ;; provided the `CUA-mode' feature. Since this is no longer true,
6692 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6693 (CUA-mode t nil
6694 "CUA-mode is now part of the standard GNU Emacs distribution,
6695 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6697 You have loaded an older version of CUA-mode which does not work
6698 correctly with this version of Emacs. You should remove the old
6699 version and use the one distributed with Emacs."))
6700 "Alist of packages known to cause problems in this version of Emacs.
6701 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6702 PACKAGE is either a regular expression to match file names, or a
6703 symbol (a feature name); see the documentation of
6704 `after-load-alist', to which this variable adds functions.
6705 SYMBOL is either the name of a string variable, or `t'. Upon
6706 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6707 warning using STRING as the message.")
6709 (defun bad-package-check (package)
6710 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6711 (condition-case nil
6712 (let* ((list (assoc package bad-packages-alist))
6713 (symbol (nth 1 list)))
6714 (and list
6715 (boundp symbol)
6716 (or (eq symbol t)
6717 (and (stringp (setq symbol (eval symbol)))
6718 (string-match-p (nth 2 list) symbol)))
6719 (display-warning package (nth 3 list) :warning)))
6720 (error nil)))
6722 (mapc (lambda (elem)
6723 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6724 bad-packages-alist)
6727 (provide 'simple)
6729 ;;; simple.el ends here