| blob | 76269c9ef9a31776b95671e9cdcc938aa6691a78 |
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."
57 "Search LIST for a valid buffer to display in FRAME.
58 Return nil when all buffers in LIST are undesirable for display,
59 otherwise return the first suitable buffer in LIST.
61 Buffers not visible in windows are preferred to visible buffers,
62 unless VISIBLE-OK is non-nil.
63 If the optional argument FRAME is nil, it defaults to the selected frame.
64 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
65 ;; This logic is more or less copied from other-buffer.
68 found buf)
81 "Return the last buffer in FRAME's buffer list.
82 If BUFFER is the last buffer, return the preceding buffer instead.
83 Buffers not visible in windows are preferred to visible buffers,
84 unless optional argument VISIBLE-OK is non-nil.
85 Optional third argument FRAME nil or omitted means use the
86 selected frame's buffer list.
87 If no such buffer exists, return the buffer `*scratch*', creating
88 it if necessary."
91 buffer visible-ok frame)
95 scratch)))
98 "Switch to the next buffer in cyclic order."
105 "Switch to the previous buffer in cyclic order."
109 \f
110 ;;; next-error support framework
113 "`next-error' support framework."
119 "Face used to highlight next error locus."
124 "Highlighting of locations in selected source buffers.
125 If a number, highlight the locus in `next-error' face for the given time
126 in seconds, or until the next command is executed.
127 If t, highlight the locus until the next command is executed, or until
128 some other locus replaces it.
129 If nil, don't highlight the locus in the source buffer.
130 If `fringe-arrow', indicate the locus by the fringe arrow."
139 "Highlighting of locations in `next-error-no-select'.
140 If number, highlight the locus in `next-error' face for given time in seconds.
141 If t, highlight the locus indefinitely until some other locus replaces it.
142 If nil, don't highlight the locus in the source buffer.
143 If `fringe-arrow', indicate the locus by the fringe arrow."
152 "Display the line in the visited source file recentered as specified.
153 If non-nil, the value is passed directly to `recenter'."
161 "List of hook functions run by `next-error' after visiting source file."
172 "The most recent `next-error' buffer.
173 A buffer becomes most recent when its compilation, grep, or
178 "Function to use to find the next error in the current buffer.
179 The function is called with 2 parameters:
180 ARG is an integer specifying by how many errors to move.
181 RESET is a boolean which, if non-nil, says to go back to the beginning
182 of the errors before moving.
183 Major modes providing compile-like functionality should set this variable
184 to indicate to `next-error' that this is a candidate buffer and how
189 "Function to use to move to an error locus.
190 It takes two arguments, a buffer position in the error buffer
191 and a buffer position in the error locus buffer.
192 The buffer for the error locus should already be current.
197 &optional avoid-current
198 extra-test-inclusive
199 extra-test-exclusive)
200 "Test if BUFFER is a `next-error' capable buffer.
202 If AVOID-CURRENT is non-nil, treat the current buffer
203 as an absolute last resort only.
205 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
206 that normally would not qualify. If it returns t, the buffer
207 in question is treated as usable.
209 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
210 that would normally be considered usable. If it returns nil,
211 that buffer is rejected."
216 ;; Optionally reject some buffers.
219 t)
220 ;; Optionally accept some other buffers.
225 extra-test-inclusive
226 extra-test-exclusive)
227 "Return a `next-error' capable buffer.
229 If AVOID-CURRENT is non-nil, treat the current buffer
230 as an absolute last resort only.
232 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
233 that normally would not qualify. If it returns t, the buffer
234 in question is treated as usable.
236 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
237 that would normally be considered usable. If it returns nil,
238 that buffer is rejected."
240 ;; 1. If one window on the selected frame displays such buffer, return it.
246 avoid-current
247 extra-test-inclusive extra-test-exclusive)
252 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
255 extra-test-inclusive extra-test-exclusive))
256 next-error-last-buffer)
257 ;; 3. If the current buffer is acceptable, choose it.
259 extra-test-inclusive extra-test-exclusive)
261 ;; 4. Look for any acceptable buffer.
266 extra-test-inclusive extra-test-exclusive)))
269 ;; 5. Use the current buffer as a last resort if it qualifies,
270 ;; even despite AVOID-CURRENT.
273 extra-test-inclusive extra-test-exclusive)
277 ;; 6. Give up.
281 "Visit next `next-error' message and corresponding source code.
283 If all the error messages parsed so far have been processed already,
284 the message buffer is checked for new ones.
286 A prefix ARG specifies how many error messages to move;
287 negative means move back to previous error messages.
289 and start at the first error.
291 The RESET argument specifies that we should restart from the beginning.
294 compilation, grep, or occur buffer. It can also operate on any
296 more generally, on any buffer in Compilation mode or with
297 Compilation Minor mode enabled, or any buffer in which
298 `next-error-function' is bound to an appropriate function.
299 To specify use of a particular buffer for error messages, type
301 in the current frame.
304 runs `next-error-hook' with `run-hooks', and stays with that buffer
305 until you use it in some other buffer which uses Compilation mode
306 or Compilation Minor mode.
308 To control which errors are matched, customize the variable
309 `compilation-error-regexp-alist'."
313 ;; we know here that next-error-function is a valid symbol we can funcall
321 "Visit the source code corresponding to the `next-error' message at point."
323 ;; we know here that next-error-function is a valid symbol we can funcall
334 "Visit previous `next-error' message and corresponding source code.
336 Prefix arg N says how many error messages to move backwards (or
337 forwards, if negative).
344 "Restart at the first error.
345 Visit corresponding source code.
346 With prefix arg N, visit the source code of the Nth error.
352 "Move point to the next error in the `next-error' buffer and highlight match.
353 Prefix arg N says how many error messages to move forwards (or
354 backwards, if negative).
356 select the source buffer."
363 "Move point to the previous error in the `next-error' buffer and highlight match.
364 Prefix arg N says how many error messages to move backwards (or
365 forwards, if negative).
367 select the source buffer."
371 ;; Internal variable for `next-error-follow-mode-post-command-hook'.
375 "Minor mode for compilation, occur and diff modes.
376 When turned on, cursor motion in the compilation, grep, occur or diff
377 buffer causes automatic display of the corresponding source code
378 location."
385 ;; Used as a `post-command-hook' by `next-error-follow-mode'
386 ;; for the *Compilation* *grep* and *Occur* buffers.
396 \f
397 ;;;
400 "Major mode not specialized for anything in particular.
401 Other major modes are defined by comparison with this one."
406 ;; Special major modes to view specially formatted data rather than files.
420 map))
424 "Parent major mode from which special major modes should inherit."
427 ;; Major mode meant to be the parent of programming modes.
432 map)
436 "Indent the expression after point."
443 "Major mode for editing programming language source code."
446 ;; Any programming language is always written left to right.
449 ;; Making and deleting lines.
455 "Insert a newline, and move to left margin of the new line if it's blank.
456 If `use-hard-newlines' is non-nil, the newline is marked with the
457 text-property `hard'.
458 With ARG, insert that many newlines.
459 Call `auto-fill-function' if the current column number is greater
460 than the value of `fill-column' and ARG is nil."
463 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
464 ;; Set last-command-event to tell self-insert what to insert.
468 ;; Don't auto-fill if we have a numeric argument.
471 ;; Do the rest in post-self-insert-hook, because we want to do it
472 ;; *before* other functions on that hook.
474 ;; Mark the newline(s) `hard'.
478 ;; If the newline leaves the previous line blank, and we
479 ;; have a left margin, delete that from the blank line.
487 ;; Indent the line after the newline, except in one case:
488 ;; when we added the newline at the beginning of a line which
489 ;; starts a page.
496 ;; We first used let-binding to protect the hook, but that was naive
497 ;; since add-hook affects the symbol-default value of the variable,
498 ;; whereas the let-binding might only protect the buffer-local value.
500 nil)
505 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
511 "Insert a newline and leave point before it.
512 If there is a fill prefix and/or a `left-margin', insert them
513 on the new line if the line would have been blank.
514 With arg N, insert N newlines."
519 ;; Don't expand an abbrev before point.
533 "Split current line, moving portion beyond point vertically down.
534 If the current line starts with `fill-prefix', insert it on the new
535 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
537 When called from Lisp code, ARG may be a prefix string to copy."
542 ;; What prefix should we check for (nil means don't).
546 ;; Does this line start with it?
557 "Join this line to previous and fix up whitespace at join.
558 If there is a fill prefix, delete it from the beginning of this line.
559 With argument, join this line to following line."
566 ;; If the second line started with the fill prefix,
567 ;; delete the prefix.
579 "On blank line, delete all surrounding blank lines, leaving just one.
580 On isolated blank line, delete that one.
581 On nonblank line, delete any immediately following blank lines."
587 ;; Set singleblank if there is just one blank line here.
594 ;; Delete preceding blank lines, and this one too if it's the only one.
603 ;; Delete following blank lines, unless the current line is blank
604 ;; and there are no following blank lines.
613 ;; Handle the special case where point is followed by newline and eob.
614 ;; Delete the line, leaving point at eob.
619 "Delete all the trailing whitespace across the current buffer.
620 All whitespace after the last non-whitespace character in a line is deleted.
622 A formfeed is not considered whitespace by this function.
623 If the region is active, only delete whitespace within the region."
636 ;; Don't delete formfeeds, even if they are considered whitespace.
642 ;; Return nil for the benefit of `write-file-functions'.
643 nil)
646 "Insert a newline, then indent according to major mode.
647 Indentation is done using the value of `indent-line-function'.
648 In programming language modes, this is the same as TAB.
649 In some text modes, where TAB inserts a tab, this command indents to the
650 column specified by the function `current-left-margin'."
657 "Reindent current line, insert newline, then indent the new line.
658 Indentation of both lines is done according to the current major mode,
659 which means calling the current value of `indent-line-function'.
660 In programming language modes, this is the same as TAB.
661 In some text modes, where TAB inserts a tab, this indents to the
662 column specified by the function `current-left-margin'."
665 ;; Be careful to insert the newline before indenting the line.
666 ;; Otherwise, the indentation might be wrong.
670 ;; We are at EOL before the call to indent-according-to-mode, and
671 ;; after it we usually are as well, but not always. We tried to
672 ;; address it with `save-excursion' but that uses a normal marker
673 ;; whereas we need `move after insertion', so we do the save/restore
674 ;; by hand.
678 ;; Remove the trailing white-space after indentation because
679 ;; indentation may introduce the whitespace.
684 "Read next input character and insert it.
685 This is useful for inserting control characters.
686 With argument, insert ARG copies of the character.
688 If the first character you type after this command is an octal digit,
689 you should type a sequence of octal digits which specify a character code.
690 Any nondigit terminates the sequence. If the terminator is a RET,
691 it is discarded; any other terminator is used itself as input.
692 The variable `read-quoted-char-radix' specifies the radix for this feature;
693 set it to 10 or 16 to use decimal or hex instead of octal.
695 In overwrite mode, this function inserts the character anyway, and
696 does not handle octal digits specially. This means that if you use
697 overwrite as your normal editing mode, you can use this function to
698 insert characters when necessary.
700 In binary overwrite mode, this function does overwrite, and octal
701 digits are interpreted as a character code. This is intended to be
702 useful for editing binary files."
705 ;; Avoid "obsolete" warnings for translation-table-for-input.
712 ;; This used to assume character codes 0240 - 0377 stand for
713 ;; characters in some single-byte character set, and converted them
714 ;; to Emacs characters. But in 23.1 this feature is deprecated
715 ;; in favor of inserting the corresponding Unicode characters.
716 ;; (if (and enable-multibyte-characters
717 ;; (>= char ?\240)
718 ;; (<= char ?\377))
719 ;; (setq char (unibyte-char-to-multibyte char)))
728 "Move forward ARG lines and position at first nonblank character."
734 "Move backward ARG lines and position at first nonblank character."
740 "Move point to the first non-whitespace character on this line."
744 ;; Move back over chars that have whitespace syntax but have the p flag.
748 "Fixup white space between objects around point.
749 Leave one space or none, according to the context."
756 nil
760 "Delete all spaces and tabs around point.
761 If BACKWARD-ONLY is non-nil, only delete them before point."
766 orig-pos
775 "Delete all spaces and tabs around point, leaving one space (or N spaces).
776 If N is negative, delete newlines as well."
793 \f
795 "Move point to the beginning of the buffer.
796 With numeric arg N, put point N/10 of the way from the beginning.
797 If the buffer is narrowed, this command uses the beginning of the
798 accessible part of the buffer.
800 If Transient Mark mode is disabled, leave mark at previous
803 Don't use this command in Lisp programs!
804 \(goto-char (point-min)) is faster."
813 ;; Avoid overflow for large buffer sizes!
821 "Move point to the end of the buffer.
822 With numeric arg N, put point N/10 of the way from the end.
823 If the buffer is narrowed, this command uses the end of the
824 accessible part of the buffer.
826 If Transient Mark mode is disabled, leave mark at previous
829 Don't use this command in Lisp programs!
830 \(goto-char (point-max)) is faster."
837 ;; Avoid overflow for large buffer sizes!
842 ;; If we went to a place in the middle of the buffer,
843 ;; adjust it to the beginning of a line.
846 ;; If the end of the buffer is not already on the screen,
847 ;; then scroll specially to put it near, but not at, the bottom.
852 "Whether single-char deletion commands delete an active region.
853 This has an effect only if Transient Mark mode is enabled, and
854 affects `delete-forward-char' and `delete-backward-char', though
855 not `delete-char'.
857 If the value is the symbol `kill', the active region is killed
858 instead of deleted."
866 "Delete the previous N characters (following if N is negative).
867 If Transient Mark mode is enabled, the mark is active, and N is 1,
868 delete the text in the region and deactivate the mark instead.
869 To disable this, set `delete-active-region' to nil.
871 Optional second arg KILLFLAG, if non-nil, means to kill (save in
872 kill ring) instead of delete. Interactively, N is the prefix
873 arg, and KILLFLAG is set if N is explicitly specified.
875 In Overwrite mode, single character backward deletion may replace
876 tabs with spaces so as to back over columns, unless point is at
877 the end of the line."
882 delete-active-region
884 ;; If a region is active, kill or delete it.
888 ;; In Overwrite mode, maybe untabify while deleting
898 ;; Otherwise, do simple deletion.
902 "Delete the following N characters (previous if N is negative).
903 If Transient Mark mode is enabled, the mark is active, and N is 1,
904 delete the text in the region and deactivate the mark instead.
905 To disable this, set `delete-active-region' to nil.
907 Optional second arg KILLFLAG non-nil means to kill (save in kill
908 ring) instead of delete. Interactively, N is the prefix arg, and
909 KILLFLAG is set if N was explicitly specified."
914 delete-active-region
916 ;; If a region is active, kill or delete it.
920 ;; Otherwise, do simple deletion.
924 "Put point at beginning and mark at end of buffer.
925 You probably should not use this function in Lisp programs;
926 it is usually a mistake for a Lisp function to use any subroutine
927 that uses or sets the mark."
932 \f
934 ;; Counting lines, one way or another.
937 "Goto LINE, counting from line 1 at beginning of buffer.
938 Normally, move point in the current buffer, and leave mark at the
940 move point in the most recently selected other buffer, and switch to it.
942 If there's a number in the buffer at point, it is the default for LINE.
944 This function is usually the wrong thing to use in a Lisp program.
945 What you probably want instead is something like:
946 (goto-char (point-min)) (forward-line (1- N))
947 If at all possible, an even better solution is to use char counts
948 rather than line counts."
952 ;; Look for a default, a number in the buffer at point.
961 ;; Decide if we're switching buffers.
969 ;; Read the argument, offering that number (if any) as default.
972 buffer-prompt
973 default)
974 default)
975 buffer))))
976 ;; Switch to the desired buffer, one way or another.
981 ;; Leave mark at previous position
983 ;; Move to the specified line number in that buffer.
992 "Print the number of words in the region.
993 When called interactively, the word count is printed in echo area."
1004 count))
1007 "Print number of lines and characters in the region."
1013 "Print the current buffer line number and narrowed line number of point."
1026 "Return number of lines between START and END.
1027 This is usually the number of newlines between them,
1028 but can be one more if START is not equal to END
1029 and the greater of them is not at the start of a line."
1045 done)))
1049 "Return (narrowed) buffer line number at position POS.
1050 If POS is nil, use current buffer location.
1051 Counting starts at (point-min), so the value refers
1052 to the contents of the accessible portion of the buffer."
1062 "Print info on cursor position (on screen and within buffer).
1063 Also describe the character after point, and give its character code
1064 in octal, decimal and hex.
1066 For a non-ASCII multibyte character, also give its encoding in the
1067 buffer's selected coding system if the coding system encodes the
1068 character safely. If the character is encoded into one byte, that
1069 code is shown in hex. If the character is encoded into more than one
1072 In addition, with prefix argument, show details about that character
1073 in *Help* buffer. See also the command `describe-char'."
1081 ;; Avoid overflow from multiplying by 100!
1085 ""
1091 pos total percent beg end col hscroll)
1093 pos total col hscroll))
1095 encoded encoding-msg display-prop under-display)
1102 ;; Check if the character is displayed with some `display'
1103 ;; text property. In that case, set under-display to the
1104 ;; buffer substring covered by that property.
1115 under-display)))
1121 char char char under-display)
1123 char char char under-display display-prop))
1126 char char char
1128 "..."
1132 ;; We show the detailed information about CHAR.
1139 encoding-msg pos total percent beg end col hscroll)
1146 encoding-msg pos total percent col hscroll))))))
1147 \f
1148 ;; Initialize read-expression-map. It is defined at C level.
1151 ;; Might as well bind TAB to completion, since inserting a TAB char is much
1152 ;; too rarely useful.
1162 "The current default value or list of default values in the minibuffer.
1163 The functions `read-from-minibuffer' and `completing-read' bind
1167 "Value for `print-level' while printing value in `eval-expression'.
1168 A value of nil means no limit."
1174 "Value for `print-length' while printing value in `eval-expression'.
1175 A value of nil means no limit."
1181 "If non-nil set `debug-on-error' to t in `eval-expression'.
1182 If nil, don't change the value of `debug-on-error'."
1188 "Format VALUE as a result of evaluated expression.
1189 Return a formatted string which is displayed in the echo area
1190 in addition to the value printed by prin1 in functions which
1191 display the result of expression evaluation."
1204 ;; We define this, rather than making `eval' interactive,
1205 ;; for the sake of completion of names like eval-region, eval-buffer.
1208 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1209 Value is also consed on to front of the variable `values'.
1210 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1211 with prefix argument) means insert the result into the current buffer
1212 instead of printing it in the echo area. Truncates long output
1213 according to the value of the variables `eval-expression-print-length'
1214 and `eval-expression-print-level'.
1216 If `eval-expression-debug-on-error' is non-nil, which is the default,
1217 this command arranges for all errors to enter the debugger."
1221 nil read-expression-map t
1223 current-prefix-arg))
1228 ;; Bind debug-on-error to something unique so that we can
1229 ;; detect when evaled code changes it.
1233 ;; If evaled code has changed the value of debug-on-error,
1234 ;; propagate that change to the global binding.
1250 "Prompting with PROMPT, let user edit COMMAND and eval result.
1251 COMMAND is a Lisp expression. Let user edit that expression in
1252 the minibuffer, then read and evaluate the result."
1259 read-expression-map t
1261 ;; If command was added to command-history as a string,
1262 ;; get rid of that. We want only evaluable expressions there.
1266 ;; If command to be redone does not match front of history,
1267 ;; add it to the history.
1273 "Edit and re-evaluate last complex command, or ARGth from last.
1274 A complex command is one which used the minibuffer.
1275 The command is placed in the minibuffer as a Lisp form for editing.
1276 The result is executed, repeating the command as changed.
1277 If the command has been changed or is not the most recent previous
1278 command it is added to the front of the command history.
1279 You can use the minibuffer history commands \
1281 to get different commands to edit and resubmit."
1284 newcmd)
1296 ;; If command was added to command-history as a
1297 ;; string, get rid of that. We want only
1298 ;; evaluable expressions there.
1302 ;; If command to be redone does not match front of history,
1303 ;; add it to the history.
1312 "Read command name to invoke in `execute-extended-command'."
1317 ;; Get a command name at point in the original buffer
1318 ;; to propose it after M-n.
1322 ;; Read a string, completing from and restricting to the set of
1323 ;; all defined commands. Don't provide any initial input.
1324 ;; Save the command read on the extended-command history list.
1335 ;; This isn't strictly correct if `execute-extended-command'
1336 ;; is bound to anything else (e.g. [menu]).
1337 ;; It could use (key-description (this-single-command-keys)),
1338 ;; but actually a prompt other than "M-x" would be confusing,
1339 ;; because "M-x" is a well-known prompt to read a command
1340 ;; and it serves as a shorthand for "Extended command: ".
1344 \f
1346 "Default minibuffer history list.
1347 This is used for all minibuffer input
1348 except when an alternate history list is specified.
1350 Maximum length of the history list is determined by the value
1353 "Control whether history list elements are expressions or strings.
1354 If the value of this variable equals current minibuffer depth,
1355 they are expressions; otherwise they are strings.
1356 \(That convention is designed to do the right thing for
1363 "Text that was in this minibuffer before any history commands.
1364 This is nil if there have not yet been any history commands
1373 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1377 "Minibuffer history variables for which matching should ignore case.
1378 If a history variable is a member of this list, then the
1380 commands ignore case when searching it, regardless of `case-fold-search'."
1385 "Find the previous history element that matches REGEXP.
1386 \(Previous history elements refer to earlier actions.)
1387 With prefix argument N, search for Nth previous match.
1388 If N is negative, find the next or Nth next match.
1389 Normally, history elements are matched case-insensitively if
1390 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1391 makes the search case-sensitive.
1392 See also `minibuffer-history-case-insensitive-variables'."
1396 nil
1397 minibuffer-local-map
1398 nil
1399 'minibuffer-history-search-history
1401 ;; Use the last regexp specified, by default, if input is empty.
1406 regexp)
1416 ;; On some systems, ignore case for file names.
1418 minibuffer-history-case-insensitive-variables)
1419 t
1420 ;; Respect the user's setting for case-fold-search:
1421 case-fold-search)
1422 nil))
1423 prevpos
1424 match-string
1425 match-offset
1432 "No later matching history item"
1453 next-matching-history-element))
1457 "Find the next history element that matches REGEXP.
1458 \(The next history element refers to a more recent action.)
1459 With prefix argument N, search for Nth next match.
1460 If N is negative, find the previous or Nth previous match.
1461 Normally, history elements are matched case-insensitively if
1462 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1463 makes the search case-sensitive."
1467 nil
1468 minibuffer-local-map
1469 nil
1470 'minibuffer-history-search-history
1472 ;; Use the last regexp specified, by default, if input is empty.
1477 regexp)
1484 "Function run by `goto-history-element' before consuming default values.
1485 This is useful to dynamically add more elements to the list of default values
1486 when `goto-history-element' reaches the end of this list.
1487 Before calling this function `goto-history-element' sets the variable
1488 `minibuffer-default-add-done' to t, so it will call this function only
1489 once. In special cases, when this function needs to be called more
1490 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1494 "When nil, add more elements to the end of the list of default values.
1495 The value nil causes `goto-history-element' to add more elements to
1496 the list of defaults when it reaches the end of this list. It does
1502 "Return a list of all completions without the default value.
1503 This function is used to add all elements of the completion table to
1504 the end of the list of defaults just after the default value."
1507 minibuffer-completion-table
1508 minibuffer-completion-predicate)))
1514 "Puts element of the minibuffer history in the minibuffer.
1515 The argument NABS specifies the absolute history position."
1529 elt minibuffer-returned-to-present)
1541 previous-history-element))
1553 minibuffer-default)))
1565 elt))
1569 "Puts next element of the minibuffer history in the minibuffer.
1570 With argument N, it uses the Nth following element."
1576 "Puts previous element of the minibuffer history in the minibuffer.
1577 With argument N, it uses the Nth previous element."
1583 "Get next history element which completes the minibuffer before the point.
1584 The contents of the minibuffer after the point are deleted, and replaced
1585 by the new completion."
1591 n)
1592 ;; next-matching-history-element always puts us at (point-min).
1593 ;; Move to the position we were at before changing the buffer contents.
1594 ;; This is still sensical, because the text before point has not changed.
1598 "\
1599 Get previous history element which completes the minibuffer before the point.
1600 The contents of the minibuffer after the point are deleted, and replaced
1601 by the new completion."
1605 ;; For compatibility with the old subr of the same name.
1607 "Return the display width of the minibuffer prompt.
1608 Return 0 if current buffer is not a minibuffer."
1609 ;; Return the width of everything before the field at the end of
1610 ;; the buffer; this should be 0 for normal buffers.
1612 \f
1613 ;; isearch minibuffer history
1620 "Set up a minibuffer for using isearch to search the minibuffer history.
1621 Intended to be added to `minibuffer-setup-hook'."
1633 "Clean up the minibuffer after terminating isearch in the minibuffer."
1638 "Return the proper search function, for isearch in minibuffer history."
1645 ;; Use standard functions to search within minibuffer text
1651 found)
1652 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1653 ;; searching forward. Lazy-highlight calls this lambda with the
1654 ;; bound arg, so skip the minibuffer prompt.
1658 ;; 1. First try searching in the initial minibuffer text
1661 noerror)
1662 ;; 2. If the above search fails, start putting next/prev history
1663 ;; elements in the minibuffer successively, and search the string
1664 ;; in them. Do this only when bound is nil (i.e. not while
1665 ;; lazy-highlighting search strings in the current minibuffer text).
1677 ;; After putting the next/prev history element, search
1678 ;; the string in them again, until next-history-element
1679 ;; or previous-history-element raises an error at the
1680 ;; beginning/end of history.
1683 ;; For backward search, don't search
1684 ;; in the minibuffer prompt
1686 noerror)))
1687 ;; Return point of the new search result
1689 ;; Return nil when next(prev)-history-element fails
1693 "Display the minibuffer history search prompt.
1694 If there are no search errors, this function displays an overlay with
1695 the isearch prompt which replaces the original minibuffer prompt.
1696 Otherwise, it displays the standard isearch message returned from
1697 `isearch-message'."
1699 ;; Use standard function `isearch-message' when not in the minibuffer,
1700 ;; or search fails, or has an error (like incomplete regexp).
1701 ;; This function overwrites minibuffer text with isearch message,
1702 ;; so it's possible to see what is wrong in the search string.
1704 ;; Otherwise, put the overlay with the standard isearch prompt over
1705 ;; the initial minibuffer prompt.
1714 ;; And clear any previous isearch message.
1718 "Wrap the minibuffer history search when search fails.
1719 Move point to the first history element for a forward search,
1720 or to the last history element for a backward search."
1722 ;; When `minibuffer-history-isearch-search' fails on reaching the
1723 ;; beginning/end of the history, wrap the search to the first/last
1724 ;; minibuffer history element.
1732 "Save a function restoring the state of minibuffer history search.
1733 Save `minibuffer-history-position' to the additional state parameter
1734 in the search status stack."
1739 "Restore the minibuffer history search state.
1740 Go to the history element by the absolute history position HIST-POS."
1743 \f
1744 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1748 "Table mapping redo records to the corresponding undo one.
1749 A redo record for undo-in-region maps to t.
1759 "Within a run of consecutive undo commands, list remaining to be undone.
1763 "Undo some previous changes.
1764 Repeat this command to undo more changes.
1765 A numeric ARG serves as a repeat count.
1767 In Transient Mark mode when the mark is active, only undo changes within
1769 as an argument limits undo to changes within the current region."
1771 ;; Make last-command indicate for the next command that this was an undo.
1772 ;; That way, another undo will undo more.
1773 ;; If we get to the end of the undo history and get an error,
1774 ;; another undo command will find the undo history empty
1775 ;; and will get another error. To begin undoing the undos,
1776 ;; you must type some other command.
1779 message)
1780 ;; If we get an error in undo-start,
1781 ;; the next command should not be a "consecutive undo".
1782 ;; So set `this-command' to something other than `undo'.
1787 ;; If something (a timer or filter?) changed the buffer
1788 ;; since the previous command, don't continue the undo seq.
1792 ;; If the last undo record made was made by undo
1793 ;; it shows nothing else happened in between.
1800 ;; get rid of initial undo boundary
1802 ;; If we got this far, the next command should be a consecutive undo.
1804 ;; Check to see whether we're hitting a redo record, and if
1805 ;; so, ask the user whether she wants to skip the redo/undo pair.
1812 ;; The equiv entry might point to another redo record if we have done
1813 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1821 ;; Record the fact that the just-generated undo records come from an
1822 ;; undo operation--that is, they are redo records.
1823 ;; In the ordinary case (not within a region), map the redo
1824 ;; record to the following undos.
1825 ;; I don't know how to do that in the undo-in-region case.
1827 ;; Strip any leading undo boundaries there might be, like we do
1828 ;; above when checking.
1832 undo-equiv-table))
1833 ;; Don't specify a position in the undo record for the undo command.
1834 ;; Instead, undoing this should move point to where the change is.
1853 ;; Record what the current undo list says,
1854 ;; so the next command can tell if the buffer was modified in between.
1857 ;; Display a message announcing success.
1862 "Make BUFFER stop keeping undo information.
1863 No argument or nil as argument means do this for the current buffer."
1869 "Undo some previous changes.
1870 Repeat this command to undo more changes.
1871 A numeric ARG serves as a repeat count.
1872 Contrary to `undo', this will not redo a previous undo."
1877 "Non-nil while performing an undo.
1881 "Undo back N undo-boundaries beyond what was already undone recently.
1882 Call `undo-start' to get ready to undo recent changes,
1883 then call `undo-more' one or more times to undo them."
1888 ;; Note: The following, while pulling elements off
1889 ;; `pending-undo-list' will call primitive change functions which
1890 ;; will push more elements onto `buffer-undo-list'.
1895 ;; Deep copy of a list
1897 "Make a copy of undo list LIST."
1903 elt))
1906 "Set `pending-undo-list' to the front of the undo list.
1907 The next call to `undo-more' will undo the most recently made change.
1908 If BEG and END are specified, then only undo elements
1909 that apply to text between BEG and END are used; other undo elements
1910 are ignored. If BEG and END are nil, all undo elements are used."
1916 buffer-undo-list)))
1921 "Return a list of undo elements for the region START to END.
1922 The elements come from `buffer-undo-list', but we keep only
1923 the elements inside this region, and discard those outside this region.
1924 If we find an element that crosses an edge of this region,
1925 we stop and ignore all further elements."
1928 undo-adjusted-markers
1929 some-rejected
1930 undo-elt temp-undo-list delta)
1935 ;; This is a "was unmodified" element.
1936 ;; Keep it if we have kept everything thus far.
1943 ;; Don't put two nils together in the list
1957 ;; Loop down the earlier events adjusting their buffer
1958 ;; positions to reflect the fact that a change to the buffer
1959 ;; isn't being undone. We only need to process those element
1960 ;; types which undo-elt-in-region will return as being in
1961 ;; the region since only those types can ever get into the
1962 ;; output
1971 ;; (TEXT . POSITION)
1978 ;; (BEGIN . END)
1983 ;; (nil PROPERTY VALUE BEG . END)
1993 "Determine whether UNDO-ELT falls inside the region START ... END.
1994 If it crosses the edge, we return nil."
1999 t)
2001 nil)
2003 ;; (TEXT . POSITION)
2007 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
2008 ;; See if MARKER is inside the region.
2019 ;; (nil PROPERTY VALUE BEG . END)
2024 ;; (BEGIN . END)
2029 "Test whether UNDO-ELT crosses one edge of that region START ... END.
2030 This assumes we have already decided that UNDO-ELT
2031 is not *inside* the region START...END."
2034 ;; (nil PROPERTY VALUE BEG . END)
2039 ;; (BEGIN . END)
2043 ;; Return the first affected buffer position and the delta for an undo element
2044 ;; delta is defined as the change in subsequent buffer positions if we *did*
2045 ;; the undo.
2049 ;; (TEXT . POSITION)
2052 ;; (BEGIN . END)
2059 "If non-nil ask about discarding undo info for the current command.
2060 Normally, Emacs discards the undo info for the current command if
2061 it exceeds `undo-outer-limit'. But if you set this option
2062 non-nil, it asks in the echo area whether to discard the info.
2063 If you answer no, there is a slight risk that Emacs might crash, so
2064 only do it if you really want to undo the command.
2066 This option is mainly intended for debugging. You have to be
2067 careful if you use it for other purposes. Garbage collection is
2068 inhibited while the question is asked, meaning that Emacs might
2069 leak memory. So you should make sure that you do not wait
2070 excessively long before answering the question."
2076 "If non-nil, an extra level of size that's ok in an undo item.
2077 We don't ask the user about truncating the undo list until the
2078 current item gets bigger than this amount.
2083 ;; When the first undo batch in an undo list is longer than
2084 ;; undo-outer-limit, this function gets called to warn the user that
2085 ;; the undo info for the current command was discarded. Garbage
2086 ;; collection is inhibited around the call, so it had better not do a
2087 ;; lot of consing.
2093 ;; Don't ask the question again unless it gets even bigger.
2094 ;; This applies, in particular, if the user quits from the question.
2095 ;; Such a quit quits out of GC, but something else will call GC
2096 ;; again momentarily. It will call this function again,
2097 ;; but we don't want to ask the question again.
2104 t)
2105 nil))
2110 "The undo info was discarded because it exceeded \
2111 `undo-outer-limit'.
2113 This is normal if you executed a command that made a huge change
2114 to the buffer. In that case, to prevent similar problems in the
2115 future, set `undo-outer-limit' to a value that is large enough to
2116 cover the maximum size of normal changes you expect a single
2117 command to make, but not so large that it might exceed the
2118 maximum memory allotted to Emacs.
2120 If you did not execute any such command, the situation is
2121 probably due to a bug and you should report it.
2123 You can disable the popping up of this buffer by adding the entry
2124 \(undo discard-info) to the user option `warning-suppress-types',
2128 t))
2129 \f
2131 "History list for some commands that read shell commands.
2133 Maximum length of the history list is determined by the value
2140 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2141 This buffer is used when `shell-command' or `shell-command-on-region'
2142 is run interactively. A value of nil means that output to stderr and
2149 "Return a list of all commands associated with the current file.
2150 This function is used to add all related commands retrieved by `mailcap'
2151 to the end of the list of defaults just after the default value."
2155 minibuffer-default))
2160 commands))
2171 map)
2175 "Read a shell command from the minibuffer.
2176 The arguments are the same as the ones of `read-from-minibuffer',
2177 except READ and KEYMAP are missing and HIST defaults
2178 to `shell-command-history'."
2186 minibuffer-local-shell-command-map
2187 nil
2189 args)))
2192 "Execute string COMMAND asynchronously in background.
2194 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2195 surrounded by whitespace and executes the command asynchronously.
2196 The output appears in the buffer `*Async Shell Command*'.
2198 In Elisp, you will often be better served by calling `start-process'
2199 directly, since it offers more control and does not impose the use of a
2200 shell (with its need to quote arguments)."
2206 current-prefix-arg
2207 shell-command-default-error-buffer))
2213 "Execute string COMMAND in inferior shell; display output, if any.
2214 With prefix argument, insert the COMMAND's output at point.
2216 If COMMAND ends in ampersand, execute it asynchronously.
2217 The output appears in the buffer `*Async Shell Command*'.
2218 That buffer is in shell mode.
2220 Otherwise, COMMAND is executed synchronously. The output appears in
2221 the buffer `*Shell Command Output*'. If the output is short enough to
2222 display in the echo area (which is determined by the variables
2223 `resize-mini-windows' and `max-mini-window-height'), it is shown
2224 there, but it is nonetheless available in buffer `*Shell Command
2225 Output*' even though that buffer is not automatically displayed.
2227 To specify a coding system for converting non-ASCII characters
2229 before this command.
2231 Noninteractive callers can specify coding systems by binding
2232 `coding-system-for-read' and `coding-system-for-write'.
2234 The optional second argument OUTPUT-BUFFER, if non-nil,
2235 says to put the output in some other buffer.
2236 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2237 If OUTPUT-BUFFER is not a buffer and not nil,
2238 insert output in current buffer. (This cannot be done asynchronously.)
2239 In either case, the buffer is first erased, and the output is
2240 inserted after point (leaving mark after it).
2242 If the command terminates without error, but generates output,
2244 the output can be displayed in the echo area or in its buffer.
2245 If the output is short enough to display in the echo area
2246 \(determined by the variable `max-mini-window-height' if
2247 `resize-mini-windows' is non-nil), it is shown there.
2248 Otherwise,the buffer containing the output is displayed.
2252 of the output.
2254 If there is no output, or if output is inserted in the current buffer,
2255 then `*Shell Command Output*' is deleted.
2257 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2258 or buffer name to which to direct the command's standard error output.
2259 If it is nil, error output is mingled with regular output.
2260 In an interactive call, the variable `shell-command-default-error-buffer'
2261 specifies the value of ERROR-BUFFER.
2263 In Elisp, you will often be better served by calling `call-process' or
2264 `start-process' directly, since it offers more control and does not impose
2265 the use of a shell (with its need to quote arguments)."
2276 current-prefix-arg
2277 shell-command-default-error-buffer))
2278 ;; Look for a handler in case default-directory is a remote file name.
2286 ;; Output goes in current buffer.
2292 temporary-file-directory)))
2293 nil)))
2296 ;; We do not use -f for csh; we will not support broken use of
2297 ;; .cshrcs. Even the BSD csh manual says to use
2298 ;; "if ($?prompt) exit" before things which are not useful
2299 ;; non-interactively. Besides, if someone wants their other
2300 ;; aliases for shell commands then they can still have them.
2304 t)
2305 nil shell-command-switch command)
2312 ;; Do no formatting while reading error file,
2313 ;; because that can run a shell command, and we
2314 ;; don't want that to cause an infinite recursion.
2316 ;; Put point after the inserted errors.
2320 ;; This is like exchange-point-and-mark, but doesn't
2321 ;; activate the mark. It is cleaner to avoid activation,
2322 ;; even though the command loop would deactivate the mark
2323 ;; because we inserted text.
2327 ;; Output goes in a separate buffer.
2328 ;; Preserve the match data in case called from a program.
2331 ;; Command ending with ampersand means asynchronous.
2335 proc)
2336 ;; Remove the ampersand.
2338 ;; If will kill a process, query first.
2346 ;; Setting buffer-read-only to nil doesn't suffice
2347 ;; if some text has a non-nil read-only property,
2348 ;; which comint sometimes adds for prompts.
2354 shell-command-switch command))
2358 ;; Use the comint filter for proper handling of carriage motion
2359 ;; (see `comint-inhibit-carriage-motion'),.
2361 ))
2362 ;; Otherwise, command is executed synchronously.
2364 output-buffer nil error-buffer)))))))
2368 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2369 MESSAGE may be either a string or a buffer.
2371 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2372 the maximum height of the echo area, as defined by `max-mini-window-height'
2373 if `resize-mini-windows' is non-nil.
2375 Returns either the string shown in the echo area, or when a pop-up
2376 buffer is used, the window used to display it.
2378 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2379 name of the buffer used to display it in the case where a pop-up buffer
2380 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2381 string and it is displayed in the echo area, it is not specified whether
2382 the contents are inserted into the buffer anyway.
2384 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2385 and only used if a buffer is displayed."
2387 ;; Trivial case where we can use the echo area
2391 ;; Trivial case where we can just remove single trailing newline
2394 ;; General case
2397 message
2406 0
2410 (<= lines
2414 max-mini-window-height))
2416 max-mini-window-height)
2420 ;; Don't use the echo area if the output buffer is
2421 ;; already dispayed in the selected frame.
2423 ;; Echo area
2429 ;; Buffer
2432 not-this-window frame))))))))
2435 ;; We have a sentinel to prevent insertion of a termination message
2436 ;; in the buffer itself.
2444 &optional output-buffer replace
2445 error-buffer display-error-buffer)
2446 "Execute string COMMAND in inferior shell with region as input.
2447 Normally display output (if any) in temp buffer `*Shell Command Output*';
2448 Prefix arg means replace the region with it. Return the exit code of
2449 COMMAND.
2451 To specify a coding system for converting non-ASCII characters
2453 before this command. By default, the input (from the current buffer)
2454 is encoded in the same coding system that will be used to save the file,
2455 `buffer-file-coding-system'. If the output is going to replace the region,
2456 then it is decoded from that same coding system.
2458 The noninteractive arguments are START, END, COMMAND,
2459 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2460 Noninteractive callers can specify coding systems by binding
2461 `coding-system-for-read' and `coding-system-for-write'.
2463 If the command generates output, the output may be displayed
2464 in the echo area or in a buffer.
2465 If the output is short enough to display in the echo area
2466 \(determined by the variable `max-mini-window-height' if
2467 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2468 it is displayed in the buffer `*Shell Command Output*'. The output
2469 is available in that buffer in both cases.
2471 If there is output and an error, a message about the error
2472 appears at the end of the output.
2474 If there is no output, or if output is inserted in the current buffer,
2475 then `*Shell Command Output*' is deleted.
2477 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2478 that says to put the output in some other buffer.
2479 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2480 If OUTPUT-BUFFER is not a buffer and not nil,
2481 insert output in the current buffer.
2482 In either case, the output is inserted after point (leaving mark after it).
2484 If REPLACE, the optional fifth argument, is non-nil, that means insert
2485 the output in place of text from START to END, putting point and mark
2486 around it.
2488 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2489 or buffer name to which to direct the command's standard error output.
2490 If it is nil, error output is mingled with regular output.
2491 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2492 were any errors. (This is always t, interactively.)
2493 In an interactive call, the variable `shell-command-default-error-buffer'
2494 specifies the value of ERROR-BUFFER."
2498 ;; Do this before calling region-beginning
2499 ;; and region-end, in case subprocess output
2500 ;; relocates them while we are in the minibuffer.
2502 ;; call-interactively recognizes region-beginning and
2503 ;; region-end specially, leaving them in the history.
2505 string
2506 current-prefix-arg
2507 current-prefix-arg
2508 shell-command-default-error-buffer
2509 t)))
2515 temporary-file-directory)))
2516 nil))
2517 exit-status)
2521 ;; Replace specified region with output from command.
2523 ;; Don't muck with mark unless REPLACE says we should.
2530 t)
2531 nil shell-command-switch command))
2532 ;; It is rude to delete a buffer which the command is not using.
2533 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2534 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2535 ;; (kill-buffer shell-buffer)))
2536 ;; Don't muck with mark unless REPLACE says we should.
2538 ;; No prefix argument: put the output in a temp buffer,
2539 ;; replacing its entire contents.
2544 ;; If the input is the same buffer as the output,
2545 ;; delete everything but the specified region,
2546 ;; then replace that region with the output.
2552 shell-file-name t
2555 t)
2556 nil shell-command-switch
2557 command)))
2558 ;; Clear the output buffer, then run the command with
2559 ;; output there.
2570 buffer)
2571 nil shell-command-switch command)))
2572 ;; Report the output.
2582 ;; There's some output, display it
2584 ;; No output; error?
2588 "some error output"
2594 output))
2597 exit-status))
2600 exit-status output))))
2601 ;; Don't kill: there might be useful info in the undo-log.
2602 ;; (kill-buffer buffer)
2603 ))))
2611 ;; Do no formatting while reading error file,
2612 ;; because that can run a shell command, and we
2613 ;; don't want that to cause an infinite recursion.
2615 ;; Put point after the inserted errors.
2620 exit-status))
2623 "Execute shell command COMMAND and return its output as a string."
2626 standard-output
2630 "Process files synchronously in a separate process.
2631 Similar to `call-process', but may invoke a file handler based on
2632 `default-directory'. The current working directory of the
2633 subprocess is `default-directory'.
2635 File names in INFILE and BUFFER are handled normally, but file
2636 names in ARGS should be relative to `default-directory', as they
2637 are passed to the process verbatim. \(This is a difference to
2638 `call-process' which does not support file handlers for INFILE
2639 and BUFFER.\)
2641 Some file handlers might not support all variants, for example
2642 they might behave as if DISPLAY was nil, regardless of the actual
2643 value passed."
2645 lc stderr-file)
2655 display args)
2661 "Whether a call of `process-file' changes remote files.
2663 Per default, this variable is always set to `t', meaning that a
2664 call of `process-file' could potentially change any file on a
2665 remote host. When set to `nil', a file handler could optimize
2666 its behaviour with respect to remote file attributes caching.
2668 This variable should never be changed by `setq'. Instead of, it
2672 "Start a program in a subprocess. Return the process object for it.
2674 Similar to `start-process', but may invoke a file handler based on
2675 `default-directory'. See Info node `(elisp)Magic File Names'.
2677 This handler ought to run PROGRAM, perhaps on the local host,
2678 perhaps on a remote host that corresponds to `default-directory'.
2679 In the latter case, the local part of `default-directory' becomes
2680 the working directory of the process.
2682 PROGRAM and PROGRAM-ARGS might be file names. They are not
2683 objects of file handler invocation. File handlers might not
2684 support pty association, if PROGRAM is nil."
2688 \f
2689 ;;;; Process menu
2701 "Major mode for listing the processes called by Emacs."
2713 "Recompute the list of processes for the Process List buffer."
2724 face link
2727 follow-link t
2728 process-buffer ,buf
2729 action process-menu-visit-buffer)
2738 "datagram"
2753 tabulated-list-entries)))))
2759 "Display a list of all processes.
2760 If optional argument QUERY-ONLY is non-nil, only processes with
2761 the query-on-exit flag set are listed.
2762 Any process listed as exited or signaled is actually eliminated
2763 after the listing is made.
2764 Optional argument BUFFER specifies a buffer to use, instead of
2766 The return value is always nil."
2778 nil)
2779 \f
2783 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2784 (define-key map [switch-frame] nil)
2785 (define-key map [?\C-u] 'universal-argument-more)
2786 (define-key map [?-] 'universal-argument-minus)
2787 (define-key map [?0] 'digit-argument)
2788 (define-key map [?1] 'digit-argument)
2789 (define-key map [?2] 'digit-argument)
2790 (define-key map [?3] 'digit-argument)
2791 (define-key map [?4] 'digit-argument)
2792 (define-key map [?5] 'digit-argument)
2793 (define-key map [?6] 'digit-argument)
2794 (define-key map [?7] 'digit-argument)
2795 (define-key map [?8] 'digit-argument)
2796 (define-key map [?9] 'digit-argument)
2797 (define-key map [kp-0] 'digit-argument)
2798 (define-key map [kp-1] 'digit-argument)
2799 (define-key map [kp-2] 'digit-argument)
2800 (define-key map [kp-3] 'digit-argument)
2801 (define-key map [kp-4] 'digit-argument)
2802 (define-key map [kp-5] 'digit-argument)
2803 (define-key map [kp-6] 'digit-argument)
2804 (define-key map [kp-7] 'digit-argument)
2805 (define-key map [kp-8] 'digit-argument)
2806 (define-key map [kp-9] 'digit-argument)
2807 (define-key map [kp-subtract] 'universal-argument-minus)
2808 map)
2811 (defvar universal-argument-num-events nil
2812 "Number of argument-specifying events read by `universal-argument'.
2813 `universal-argument-other-key' uses this to discard those events
2814 from (this-command-keys), and reread only the final command.")
2816 (defvar saved-overriding-map t
2817 "The saved value of `overriding-terminal-local-map'.
2821 (defun save&set-overriding-map (map)
2822 "Set `overriding-terminal-local-map' to MAP."
2823 (when (eq saved-overriding-map t)
2824 (setq saved-overriding-map overriding-terminal-local-map)
2825 (setq overriding-terminal-local-map map)))
2827 (defun restore-overriding-map ()
2828 "Restore `overriding-terminal-local-map' to its saved value."
2829 (setq overriding-terminal-local-map saved-overriding-map)
2830 (setq saved-overriding-map t))
2832 (defun universal-argument ()
2833 "Begin a numeric argument for the following command.
2838 multiplies the argument by 4 each time.
2840 which is different in effect from any particular numeric argument.
2842 (interactive)
2843 (setq prefix-arg (list 4))
2844 (setq universal-argument-num-events (length (this-command-keys)))
2845 (save&set-overriding-map universal-argument-map))
2847 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2848 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2849 (defun universal-argument-more (arg)
2850 (interactive "P")
2851 (if (consp arg)
2852 (setq prefix-arg (list (* 4 (car arg))))
2853 (if (eq arg '-)
2854 (setq prefix-arg (list -4))
2855 (setq prefix-arg arg)
2856 (restore-overriding-map)))
2857 (setq universal-argument-num-events (length (this-command-keys))))
2859 (defun negative-argument (arg)
2860 "Begin a negative numeric argument for the next command.
2862 (interactive "P")
2863 (cond ((integerp arg)
2864 (setq prefix-arg (- arg)))
2865 ((eq arg '-)
2866 (setq prefix-arg nil))
2867 (t
2868 (setq prefix-arg '-)))
2869 (setq universal-argument-num-events (length (this-command-keys)))
2870 (save&set-overriding-map universal-argument-map))
2872 (defun digit-argument (arg)
2873 "Part of the numeric argument for the next command.
2875 (interactive "P")
2876 (let* ((char (if (integerp last-command-event)
2877 last-command-event
2878 (get last-command-event 'ascii-character)))
2880 (cond ((integerp arg)
2881 (setq prefix-arg (+ (* arg 10)
2882 (if (< arg 0) (- digit) digit))))
2883 ((eq arg '-)
2884 ;; Treat -0 as just -, so that -01 will work.
2885 (setq prefix-arg (if (zerop digit) '- (- digit))))
2886 (t
2887 (setq prefix-arg digit))))
2888 (setq universal-argument-num-events (length (this-command-keys)))
2889 (save&set-overriding-map universal-argument-map))
2891 ;; For backward compatibility, minus with no modifiers is an ordinary
2892 ;; command if digits have already been entered.
2893 (defun universal-argument-minus (arg)
2894 (interactive "P")
2895 (if (integerp arg)
2896 (universal-argument-other-key arg)
2897 (negative-argument arg)))
2899 ;; Anything else terminates the argument and is left in the queue to be
2900 ;; executed as a command.
2901 (defun universal-argument-other-key (arg)
2902 (interactive "P")
2903 (setq prefix-arg arg)
2904 (let* ((key (this-command-keys))
2905 (keylist (listify-key-sequence key)))
2906 (setq unread-command-events
2907 (append (nthcdr universal-argument-num-events keylist)
2908 unread-command-events)))
2909 (reset-this-command-lengths)
2910 (restore-overriding-map))
2911 \f
2913 (defvar filter-buffer-substring-functions nil
2914 "Wrapper hook around `filter-buffer-substring'.
2915 The functions on this special hook are called with 4 arguments:
2916 NEXT-FUN BEG END DELETE
2917 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2918 that performs the default operation. The other 3 arguments are like
2919 the ones passed to `filter-buffer-substring'.")
2921 (defvar buffer-substring-filters nil
2922 "List of filter functions for `filter-buffer-substring'.
2923 Each function must accept a single argument, a string, and return
2924 a string. The buffer substring is passed to the first function
2925 in the list, and the return value of each function is passed to
2926 the next. The return value of the last function is used as the
2927 return value of `filter-buffer-substring'.
2929 If this variable is nil, no filtering is performed.")
2930 (make-obsolete-variable 'buffer-substring-filters
2931 'filter-buffer-substring-functions "24.1")
2933 (defun filter-buffer-substring (beg end &optional delete)
2934 "Return the buffer substring between BEG and END, after filtering.
2935 The filtering is performed by `filter-buffer-substring-functions'.
2937 If DELETE is non-nil, the text between BEG and END is deleted
2938 from the buffer.
2940 This function should be used instead of `buffer-substring',
2941 `buffer-substring-no-properties', or `delete-and-extract-region'
2942 when you want to allow filtering to take place. For example,
2943 major or minor modes can use `filter-buffer-substring-functions' to
2944 extract characters that are special to a buffer, and should not
2945 be copied into other buffers."
2946 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2947 (cond
2948 ((or delete buffer-substring-filters)
2949 (save-excursion
2950 (goto-char beg)
2951 (let ((string (if delete (delete-and-extract-region beg end)
2952 (buffer-substring beg end))))
2953 (dolist (filter buffer-substring-filters)
2954 (setq string (funcall filter string)))
2955 string)))
2956 (t
2957 (buffer-substring beg end)))))
2960 ;;;; Window system cut and paste hooks.
2962 (defvar interprogram-cut-function nil
2963 "Function to call to make a killed region available to other programs.
2965 Most window systems provide some sort of facility for cutting and
2966 pasting text between the windows of different programs.
2967 This variable holds a function that Emacs calls whenever text
2968 is put in the kill ring, to make the new kill available to other
2969 programs.
2971 The function takes one argument, TEXT, which is a string containing
2972 the text which should be made available.")
2974 (defvar interprogram-paste-function nil
2975 "Function to call to get text cut from other programs.
2977 Most window systems provide some sort of facility for cutting and
2978 pasting text between the windows of different programs.
2979 This variable holds a function that Emacs calls to obtain
2980 text that other programs have provided for pasting.
2982 The function should be called with no arguments. If the function
2983 returns nil, then no other program has provided such text, and the top
2984 of the Emacs kill ring should be used. If the function returns a
2985 string, then the caller of the function \(usually `current-kill')
2986 should put this string in the kill ring as the latest kill.
2988 This function may also return a list of strings if the window
2989 system supports multiple selections. The first string will be
2990 used as the pasted text, but the other will be placed in the
2991 kill ring for easy access via `yank-pop'.
2993 Note that the function should return a string only if a program other
2994 than Emacs has provided a string for pasting; if Emacs provided the
2995 most recent string, the function should return nil. If it is
2996 difficult to tell whether Emacs or some other program provided the
2997 current string, it is probably good enough to return nil if the string
2998 is equal (according to `string=') to the last text Emacs provided.")
2999 \f
3002 ;;;; The kill ring data structure.
3004 (defvar kill-ring nil
3005 "List of killed text sequences.
3006 Since the kill ring is supposed to interact nicely with cut-and-paste
3007 facilities offered by window systems, use of this variable should
3008 interact nicely with `interprogram-cut-function' and
3009 `interprogram-paste-function'. The functions `kill-new',
3010 `kill-append', and `current-kill' are supposed to implement this
3011 interaction; you may want to use them instead of manipulating the kill
3012 ring directly.")
3014 (defcustom kill-ring-max 60
3015 "Maximum length of kill ring before oldest elements are thrown away."
3016 :type 'integer
3017 :group 'killing)
3019 (defvar kill-ring-yank-pointer nil
3020 "The tail of the kill ring whose car is the last thing yanked.")
3022 (defcustom save-interprogram-paste-before-kill nil
3023 "Save clipboard strings into kill ring before replacing them.
3024 When one selects something in another program to paste it into Emacs,
3025 but kills something in Emacs before actually pasting it,
3026 this selection is gone unless this variable is non-nil,
3027 in which case the other program's selection is saved in the `kill-ring'
3029 :type 'boolean
3030 :group 'killing
3031 :version "23.2")
3033 (defcustom kill-do-not-save-duplicates nil
3034 "Do not add a new string to `kill-ring' when it is the same as the last one."
3035 :type 'boolean
3036 :group 'killing
3037 :version "23.2")
3039 (defun kill-new (string &optional replace yank-handler)
3040 "Make STRING the latest kill in the kill ring.
3041 Set `kill-ring-yank-pointer' to point to it.
3042 If `interprogram-cut-function' is non-nil, apply it to STRING.
3043 Optional second argument REPLACE non-nil means that STRING will replace
3044 the front of the kill ring, rather than being added to the list.
3046 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
3047 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
3048 STRING.
3050 When the yank handler has a non-nil PARAM element, the original STRING
3051 argument is not used by `insert-for-yank'. However, since Lisp code
3052 may access and use elements from the kill ring directly, the STRING
3054 (if (> (length string) 0)
3055 (if yank-handler
3056 (put-text-property 0 (length string)
3057 'yank-handler yank-handler string))
3058 (if yank-handler
3059 (signal 'args-out-of-range
3060 (list string "yank-handler specified for empty string"))))
3061 (unless (and kill-do-not-save-duplicates
3062 (equal string (car kill-ring)))
3063 (if (fboundp 'menu-bar-update-yank-menu)
3064 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
3065 (when save-interprogram-paste-before-kill
3066 (let ((interprogram-paste (and interprogram-paste-function
3067 (funcall interprogram-paste-function))))
3068 (when interprogram-paste
3069 (dolist (s (if (listp interprogram-paste)
3070 (nreverse interprogram-paste)
3071 (list interprogram-paste)))
3072 (unless (and kill-do-not-save-duplicates
3073 (equal s (car kill-ring)))
3074 (push s kill-ring))))))
3075 (unless (and kill-do-not-save-duplicates
3076 (equal string (car kill-ring)))
3077 (if (and replace kill-ring)
3078 (setcar kill-ring string)
3079 (push string kill-ring)
3080 (if (> (length kill-ring) kill-ring-max)
3081 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
3082 (setq kill-ring-yank-pointer kill-ring)
3083 (if interprogram-cut-function
3084 (funcall interprogram-cut-function string)))
3085 (set-advertised-calling-convention
3086 'kill-new '(string &optional replace) "23.3")
3088 (defun kill-append (string before-p &optional yank-handler)
3089 "Append STRING to the end of the latest kill in the kill ring.
3090 If BEFORE-P is non-nil, prepend STRING to the kill.
3091 If `interprogram-cut-function' is set, pass the resulting kill to it."
3092 (let* ((cur (car kill-ring)))
3093 (kill-new (if before-p (concat string cur) (concat cur string))
3094 (or (= (length cur) 0)
3095 (equal yank-handler (get-text-property 0 'yank-handler cur)))
3096 yank-handler)))
3097 (set-advertised-calling-convention 'kill-append '(string before-p) "23.3")
3099 (defcustom yank-pop-change-selection nil
3100 "If non-nil, rotating the kill ring changes the window system selection."
3101 :type 'boolean
3102 :group 'killing
3103 :version "23.1")
3105 (defun current-kill (n &optional do-not-move)
3106 "Rotate the yanking point by N places, and then return that kill.
3107 If N is zero, `interprogram-paste-function' is set, and calling
3108 it returns a string or list of strings, then that string (or
3109 list) is added to the front of the kill ring and the string (or
3110 first string in the list) is returned as the latest kill.
3112 If N is not zero, and if `yank-pop-change-selection' is
3113 non-nil, use `interprogram-cut-function' to transfer the
3114 kill at the new yank point into the window system selection.
3116 If optional arg DO-NOT-MOVE is non-nil, then don't actually
3117 move the yanking point; just return the Nth kill forward."
3119 (let ((interprogram-paste (and (= n 0)
3120 interprogram-paste-function
3121 (funcall interprogram-paste-function))))
3122 (if interprogram-paste
3123 (progn
3124 ;; Disable the interprogram cut function when we add the new
3125 ;; text to the kill ring, so Emacs doesn't try to own the
3126 ;; selection, with identical text.
3127 (let ((interprogram-cut-function nil))
3128 (if (listp interprogram-paste)
3129 (mapc 'kill-new (nreverse interprogram-paste))
3130 (kill-new interprogram-paste)))
3131 (car kill-ring))
3132 (or kill-ring (error "Kill ring is empty"))
3133 (let ((ARGth-kill-element
3134 (nthcdr (mod (- n (length kill-ring-yank-pointer))
3135 (length kill-ring))
3136 kill-ring)))
3137 (unless do-not-move
3138 (setq kill-ring-yank-pointer ARGth-kill-element)
3139 (when (and yank-pop-change-selection
3140 (> n 0)
3141 interprogram-cut-function)
3142 (funcall interprogram-cut-function (car ARGth-kill-element))))
3143 (car ARGth-kill-element)))))
3147 ;;;; Commands for manipulating the kill ring.
3149 (defcustom kill-read-only-ok nil
3150 "Non-nil means don't signal an error for killing read-only text."
3151 :type 'boolean
3152 :group 'killing)
3154 (put 'text-read-only 'error-conditions
3155 '(text-read-only buffer-read-only error))
3156 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3158 (defun kill-region (beg end &optional yank-handler)
3160 This deletes the text from the buffer and saves it in the kill ring.
3164 If you want to append the killed region to the last killed text,
3167 If the buffer is read-only, Emacs will beep and refrain from deleting
3168 the text, but put the text in the kill ring anyway. This means that
3169 you can use the killing commands to copy text from a read-only buffer.
3171 Lisp programs should use this function for killing text.
3172 (To delete text, use `delete-region'.)
3173 Supply two arguments, character positions indicating the stretch of text
3174 to be killed.
3176 If the previous command was also a kill command,
3177 the text killed this time appends to the text killed last time
3178 to make one entry in the kill ring."
3179 ;; Pass point first, then mark, because the order matters
3180 ;; when calling kill-append.
3181 (interactive (list (point) (mark)))
3182 (unless (and beg end)
3183 (error "The mark is not set now, so there is no region"))
3184 (condition-case nil
3185 (let ((string (filter-buffer-substring beg end t)))
3186 (when string ;STRING is nil if BEG = END
3187 ;; Add that string to the kill ring, one way or another.
3188 (if (eq last-command 'kill-region)
3189 (kill-append string (< end beg) yank-handler)
3190 (kill-new string nil yank-handler)))
3191 (when (or string (eq last-command 'kill-region))
3192 (setq this-command 'kill-region))
3193 nil)
3194 ((buffer-read-only text-read-only)
3195 ;; The code above failed because the buffer, or some of the characters
3196 ;; in the region, are read-only.
3197 ;; We should beep, in case the user just isn't aware of this.
3198 ;; However, there's no harm in putting
3199 ;; the region's text in the kill ring, anyway.
3200 (copy-region-as-kill beg end)
3201 ;; Set this-command now, so it will be set even if we get an error.
3202 (setq this-command 'kill-region)
3203 ;; This should barf, if appropriate, and give us the correct error.
3204 (if kill-read-only-ok
3205 (progn (message "Read only text copied to kill ring") nil)
3206 ;; Signal an error if the buffer is read-only.
3207 (barf-if-buffer-read-only)
3208 ;; If the buffer isn't read-only, the text is.
3209 (signal 'text-read-only (list (current-buffer)))))))
3210 (set-advertised-calling-convention 'kill-region '(beg end) "23.3")
3212 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3213 ;; to get two copies of the text when the user accidentally types M-w and
3214 ;; then corrects it with the intended C-w.
3215 (defun copy-region-as-kill (beg end)
3216 "Save the region as if killed, but don't kill it.
3217 In Transient Mark mode, deactivate the mark.
3218 If `interprogram-cut-function' is non-nil, also save the text for a window
3219 system cut and paste.
3221 This command's old key binding has been given to `kill-ring-save'."
3222 (interactive "r")
3223 (if (eq last-command 'kill-region)
3224 (kill-append (filter-buffer-substring beg end) (< end beg))
3225 (kill-new (filter-buffer-substring beg end)))
3226 (setq deactivate-mark t)
3227 nil)
3229 (defun kill-ring-save (beg end)
3230 "Save the region as if killed, but don't kill it.
3231 In Transient Mark mode, deactivate the mark.
3232 If `interprogram-cut-function' is non-nil, also save the text for a window
3233 system cut and paste.
3235 If you want to append the killed line to the last killed text,
3238 This command is similar to `copy-region-as-kill', except that it gives
3239 visual feedback indicating the extent of the region being copied."
3240 (interactive "r")
3241 (copy-region-as-kill beg end)
3242 ;; This use of called-interactively-p is correct
3243 ;; because the code it controls just gives the user visual feedback.
3244 (if (called-interactively-p 'interactive)
3245 (let ((other-end (if (= (point) beg) end beg))
3246 (opoint (point))
3247 ;; Inhibit quitting so we can make a quit here
3248 ;; look like a C-g typed as a command.
3249 (inhibit-quit t))
3250 (if (pos-visible-in-window-p other-end (selected-window))
3251 ;; Swap point-and-mark quickly so as to show the region that
3252 ;; was selected. Don't do it if the region is highlighted.
3253 (unless (and (region-active-p)
3254 (face-background 'region))
3255 ;; Swap point and mark.
3256 (set-marker (mark-marker) (point) (current-buffer))
3257 (goto-char other-end)
3258 (sit-for blink-matching-delay)
3259 ;; Swap back.
3260 (set-marker (mark-marker) other-end (current-buffer))
3261 (goto-char opoint)
3262 ;; If user quit, deactivate the mark
3263 ;; as C-g would as a command.
3264 (and quit-flag mark-active
3265 (deactivate-mark)))
3266 (let* ((killed-text (current-kill 0))
3267 (message-len (min (length killed-text) 40)))
3268 (if (= (point) beg)
3269 ;; Don't say "killed"; that is misleading.
3271 (substring killed-text (- message-len)))
3273 (substring killed-text 0 message-len))))))))
3275 (defun append-next-kill (&optional interactive)
3276 "Cause following command, if it kills, to append to previous kill.
3277 The argument is used for internal purposes; do not supply one."
3278 (interactive "p")
3279 ;; We don't use (interactive-p), since that breaks kbd macros.
3280 (if interactive
3281 (progn
3282 (setq this-command 'kill-region)
3283 (message "If the next command is a kill, it will append"))
3284 (setq last-command 'kill-region)))
3285 \f
3286 ;; Yanking.
3288 ;; This is actually used in subr.el but defcustom does not work there.
3289 (defcustom yank-excluded-properties
3290 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3291 yank-handler follow-link fontified)
3292 "Text properties to discard when yanking.
3293 The value should be a list of text properties to discard or t,
3294 which means to discard all text properties."
3295 :type '(choice (const :tag "All" t) (repeat symbol))
3296 :group 'killing
3297 :version "22.1")
3299 (defvar yank-window-start nil)
3300 (defvar yank-undo-function nil
3301 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3302 Function is called with two parameters, START and END corresponding to
3303 the value of the mark and point; it is guaranteed that START <= END.
3304 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3306 (defun yank-pop (&optional arg)
3307 "Replace just-yanked stretch of killed text with a different stretch.
3308 This command is allowed only immediately after a `yank' or a `yank-pop'.
3309 At such a time, the region contains a stretch of reinserted
3310 previously-killed text. `yank-pop' deletes that text and inserts in its
3311 place a different stretch of killed text.
3313 With no argument, the previous kill is inserted.
3314 With argument N, insert the Nth previous kill.
3315 If N is negative, this is a more recent kill.
3317 The sequence of kills wraps around, so that after the oldest one
3318 comes the newest one.
3320 When this command inserts killed text into the buffer, it honors
3321 `yank-excluded-properties' and `yank-handler' as described in the
3322 doc string for `insert-for-yank-1', which see."
3323 (interactive "*p")
3324 (if (not (eq last-command 'yank))
3325 (error "Previous command was not a yank"))
3326 (setq this-command 'yank)
3327 (unless arg (setq arg 1))
3328 (let ((inhibit-read-only t)
3329 (before (< (point) (mark t))))
3330 (if before
3331 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3332 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3333 (setq yank-undo-function nil)
3334 (set-marker (mark-marker) (point) (current-buffer))
3335 (insert-for-yank (current-kill arg))
3336 ;; Set the window start back where it was in the yank command,
3337 ;; if possible.
3338 (set-window-start (selected-window) yank-window-start t)
3339 (if before
3340 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3341 ;; It is cleaner to avoid activation, even though the command
3342 ;; loop would deactivate the mark because we inserted text.
3343 (goto-char (prog1 (mark t)
3344 (set-marker (mark-marker) (point) (current-buffer))))))
3345 nil)
3347 (defun yank (&optional arg)
3349 More precisely, reinsert the stretch of killed text most recently
3350 killed OR yanked. Put point at end, and set mark at beginning.
3351 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3352 With argument N, reinsert the Nth most recently killed stretch of killed
3353 text.
3355 When this command inserts killed text into the buffer, it honors
3356 `yank-excluded-properties' and `yank-handler' as described in the
3357 doc string for `insert-for-yank-1', which see.
3360 (interactive "*P")
3361 (setq yank-window-start (window-start))
3362 ;; If we don't get all the way thru, make last-command indicate that
3363 ;; for the following command.
3364 (setq this-command t)
3365 (push-mark (point))
3366 (insert-for-yank (current-kill (cond
3367 ((listp arg) 0)
3368 ((eq arg '-) -2)
3369 (t (1- arg)))))
3370 (if (consp arg)
3371 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3372 ;; It is cleaner to avoid activation, even though the command
3373 ;; loop would deactivate the mark because we inserted text.
3374 (goto-char (prog1 (mark t)
3375 (set-marker (mark-marker) (point) (current-buffer)))))
3376 ;; If we do get all the way thru, make this-command indicate that.
3377 (if (eq this-command t)
3378 (setq this-command 'yank))
3379 nil)
3381 (defun rotate-yank-pointer (arg)
3382 "Rotate the yanking point in the kill ring.
3383 With ARG, rotate that many kills forward (or backward, if negative)."
3384 (interactive "p")
3385 (current-kill arg))
3386 \f
3387 ;; Some kill commands.
3389 ;; Internal subroutine of delete-char
3390 (defun kill-forward-chars (arg)
3391 (if (listp arg) (setq arg (car arg)))
3392 (if (eq arg '-) (setq arg -1))
3393 (kill-region (point) (+ (point) arg)))
3395 ;; Internal subroutine of backward-delete-char
3396 (defun kill-backward-chars (arg)
3397 (if (listp arg) (setq arg (car arg)))
3398 (if (eq arg '-) (setq arg -1))
3399 (kill-region (point) (- (point) arg)))
3401 (defcustom backward-delete-char-untabify-method 'untabify
3402 "The method for untabifying when deleting backward.
3403 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3404 `hungry' -- delete all whitespace, both tabs and spaces;
3405 `all' -- delete all whitespace, including tabs, spaces and newlines;
3406 nil -- just delete one character."
3407 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3408 :version "20.3"
3409 :group 'killing)
3411 (defun backward-delete-char-untabify (arg &optional killp)
3412 "Delete characters backward, changing tabs into spaces.
3413 The exact behavior depends on `backward-delete-char-untabify-method'.
3414 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3415 Interactively, ARG is the prefix arg (default 1)
3416 and KILLP is t if a prefix arg was specified."
3418 (when (eq backward-delete-char-untabify-method 'untabify)
3419 (let ((count arg))
3420 (save-excursion
3421 (while (and (> count 0) (not (bobp)))
3423 (let ((col (current-column)))
3424 (forward-char -1)
3425 (setq col (- col (current-column)))
3426 (insert-char ?\s col)
3427 (delete-char 1)))
3428 (forward-char -1)
3429 (setq count (1- count))))))
3431 ((eq backward-delete-char-untabify-method 'all)
3433 (n (if skip
3434 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3435 (point)))))
3436 (+ arg (if (zerop wh) 0 (1- wh))))
3437 arg)))
3438 ;; Avoid warning about delete-backward-char
3439 (with-no-warnings (delete-backward-char n killp))))
3441 (defun zap-to-char (arg char)
3442 "Kill up to and including ARGth occurrence of CHAR.
3443 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3444 Goes backward if ARG is negative; error if CHAR not found."
3446 ;; Avoid "obsolete" warnings for translation-table-for-input.
3447 (with-no-warnings
3448 (if (char-table-p translation-table-for-input)
3449 (setq char (or (aref translation-table-for-input char) char))))
3450 (kill-region (point) (progn
3451 (search-forward (char-to-string char) nil nil arg)
3452 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3453 (point))))
3455 ;; kill-line and its subroutines.
3457 (defcustom kill-whole-line nil
3458 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3459 :type 'boolean
3460 :group 'killing)
3462 (defun kill-line (&optional arg)
3463 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3464 With prefix argument ARG, kill that many lines from point.
3465 Negative arguments kill lines backward.
3466 With zero argument, kills the text before point on the current line.
3469 a number counts as a prefix arg.
3471 To kill a whole line, when point is not at the beginning, type \
3474 If `kill-whole-line' is non-nil, then this command kills the whole line
3475 including its terminating newline, when used at the beginning of a line
3476 with no argument. As a consequence, you can always kill a whole line
3479 If you want to append the killed line to the last killed text,
3482 If the buffer is read-only, Emacs will beep and refrain from deleting
3483 the line, but put the line in the kill ring anyway. This means that
3484 you can use this command to copy text from a read-only buffer.
3485 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3486 even beep.)"
3487 (interactive "P")
3488 (kill-region (point)
3489 ;; It is better to move point to the other end of the kill
3490 ;; before killing. That way, in a read-only buffer, point
3491 ;; moves across the text that is copied to the kill ring.
3492 ;; The choice has no effect on undo now that undo records
3493 ;; the value of point from before the command was run.
3494 (progn
3495 (if arg
3496 (forward-visible-line (prefix-numeric-value arg))
3497 (if (eobp)
3498 (signal 'end-of-buffer nil))
3499 (let ((end
3500 (save-excursion
3501 (end-of-visible-line) (point))))
3502 (if (or (save-excursion
3503 ;; If trailing whitespace is visible,
3504 ;; don't treat it as nothing.
3505 (unless show-trailing-whitespace
3507 (= (point) end))
3508 (and kill-whole-line (bolp)))
3509 (forward-visible-line 1)
3510 (goto-char end))))
3511 (point))))
3513 (defun kill-whole-line (&optional arg)
3514 "Kill current line.
3515 With prefix ARG, kill that many lines starting from the current line.
3516 If ARG is negative, kill backward. Also kill the preceding newline.
3518 If ARG is zero, kill current line but exclude the trailing newline."
3519 (interactive "p")
3520 (or arg (setq arg 1))
3521 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3522 (signal 'end-of-buffer nil))
3523 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3524 (signal 'beginning-of-buffer nil))
3525 (unless (eq last-command 'kill-region)
3526 (kill-new "")
3527 (setq last-command 'kill-region))
3528 (cond ((zerop arg)
3529 ;; We need to kill in two steps, because the previous command
3530 ;; could have been a kill command, in which case the text
3531 ;; before point needs to be prepended to the current kill
3532 ;; ring entry and the text after point appended. Also, we
3533 ;; need to use save-excursion to avoid copying the same text
3534 ;; twice to the kill ring in read-only buffers.
3535 (save-excursion
3536 (kill-region (point) (progn (forward-visible-line 0) (point))))
3537 (kill-region (point) (progn (end-of-visible-line) (point))))
3538 ((< arg 0)
3539 (save-excursion
3540 (kill-region (point) (progn (end-of-visible-line) (point))))
3541 (kill-region (point)
3542 (progn (forward-visible-line (1+ arg))
3543 (unless (bobp) (backward-char))
3544 (point))))
3545 (t
3546 (save-excursion
3547 (kill-region (point) (progn (forward-visible-line 0) (point))))
3548 (kill-region (point)
3549 (progn (forward-visible-line arg) (point))))))
3551 (defun forward-visible-line (arg)
3552 "Move forward by ARG lines, ignoring currently invisible newlines only.
3553 If ARG is negative, move backward -ARG lines.
3554 If ARG is zero, move to the beginning of the current line."
3555 (condition-case nil
3556 (if (> arg 0)
3557 (progn
3558 (while (> arg 0)
3559 (or (zerop (forward-line 1))
3560 (signal 'end-of-buffer nil))
3561 ;; If the newline we just skipped is invisible,
3562 ;; don't count it.
3563 (let ((prop
3564 (get-char-property (1- (point)) 'invisible)))
3565 (if (if (eq buffer-invisibility-spec t)
3566 prop
3567 (or (memq prop buffer-invisibility-spec)
3568 (assq prop buffer-invisibility-spec)))
3569 (setq arg (1+ arg))))
3570 (setq arg (1- arg)))
3571 ;; If invisible text follows, and it is a number of complete lines,
3572 ;; skip it.
3573 (let ((opoint (point)))
3574 (while (and (not (eobp))
3575 (let ((prop
3576 (get-char-property (point) 'invisible)))
3577 (if (eq buffer-invisibility-spec t)
3578 prop
3579 (or (memq prop buffer-invisibility-spec)
3580 (assq prop buffer-invisibility-spec)))))
3581 (goto-char
3582 (if (get-text-property (point) 'invisible)
3583 (or (next-single-property-change (point) 'invisible)
3584 (point-max))
3585 (next-overlay-change (point)))))
3586 (unless (bolp)
3587 (goto-char opoint))))
3588 (let ((first t))
3589 (while (or first (<= arg 0))
3590 (if first
3591 (beginning-of-line)
3592 (or (zerop (forward-line -1))
3593 (signal 'beginning-of-buffer nil)))
3594 ;; If the newline we just moved to is invisible,
3595 ;; don't count it.
3596 (unless (bobp)
3597 (let ((prop
3598 (get-char-property (1- (point)) 'invisible)))
3599 (unless (if (eq buffer-invisibility-spec t)
3600 prop
3601 (or (memq prop buffer-invisibility-spec)
3602 (assq prop buffer-invisibility-spec)))
3603 (setq arg (1+ arg)))))
3604 (setq first nil))
3605 ;; If invisible text follows, and it is a number of complete lines,
3606 ;; skip it.
3607 (let ((opoint (point)))
3608 (while (and (not (bobp))
3609 (let ((prop
3610 (get-char-property (1- (point)) 'invisible)))
3611 (if (eq buffer-invisibility-spec t)
3612 prop
3613 (or (memq prop buffer-invisibility-spec)
3614 (assq prop buffer-invisibility-spec)))))
3615 (goto-char
3616 (if (get-text-property (1- (point)) 'invisible)
3617 (or (previous-single-property-change (point) 'invisible)
3618 (point-min))
3619 (previous-overlay-change (point)))))
3620 (unless (bolp)
3621 (goto-char opoint)))))
3622 ((beginning-of-buffer end-of-buffer)
3623 nil)))
3625 (defun end-of-visible-line ()
3626 "Move to end of current visible line."
3627 (end-of-line)
3628 ;; If the following character is currently invisible,
3629 ;; skip all characters with that same `invisible' property value,
3630 ;; then find the next newline.
3631 (while (and (not (eobp))
3632 (save-excursion
3634 (let ((prop
3635 (get-char-property (point) 'invisible)))
3636 (if (eq buffer-invisibility-spec t)
3637 prop
3638 (or (memq prop buffer-invisibility-spec)
3639 (assq prop buffer-invisibility-spec))))))
3641 (if (get-text-property (point) 'invisible)
3642 (goto-char (next-single-property-change (point) 'invisible))
3643 (goto-char (next-overlay-change (point))))
3644 (end-of-line)))
3645 \f
3646 (defun insert-buffer (buffer)
3647 "Insert after point the contents of BUFFER.
3648 Puts mark after the inserted text.
3649 BUFFER may be a buffer or a buffer name.
3651 This function is meant for the user to run interactively.
3652 Don't call it from programs: use `insert-buffer-substring' instead!"
3653 (interactive
3654 (list
3655 (progn
3656 (barf-if-buffer-read-only)
3657 (read-buffer "Insert buffer: "
3658 (if (eq (selected-window) (next-window (selected-window)))
3659 (other-buffer (current-buffer))
3660 (window-buffer (next-window (selected-window))))
3661 t))))
3662 (push-mark
3663 (save-excursion
3664 (insert-buffer-substring (get-buffer buffer))
3665 (point)))
3666 nil)
3668 (defun append-to-buffer (buffer start end)
3669 "Append to specified buffer the text of the region.
3670 It is inserted into that buffer before its point.
3672 When calling from a program, give three arguments:
3673 BUFFER (or buffer name), START and END.
3674 START and END specify the portion of the current buffer to be copied."
3675 (interactive
3676 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3677 (region-beginning) (region-end)))
3678 (let* ((oldbuf (current-buffer))
3679 (append-to (get-buffer-create buffer))
3680 (windows (get-buffer-window-list append-to t t))
3681 point)
3682 (save-excursion
3683 (with-current-buffer append-to
3684 (setq point (point))
3685 (barf-if-buffer-read-only)
3686 (insert-buffer-substring oldbuf start end)
3687 (dolist (window windows)
3688 (when (= (window-point window) point)
3689 (set-window-point window (point))))))))
3691 (defun prepend-to-buffer (buffer start end)
3692 "Prepend to specified buffer the text of the region.
3693 It is inserted into that buffer after its point.
3695 When calling from a program, give three arguments:
3696 BUFFER (or buffer name), START and END.
3697 START and END specify the portion of the current buffer to be copied."
3699 (let ((oldbuf (current-buffer)))
3700 (with-current-buffer (get-buffer-create buffer)
3701 (barf-if-buffer-read-only)
3702 (save-excursion
3703 (insert-buffer-substring oldbuf start end)))))
3705 (defun copy-to-buffer (buffer start end)
3706 "Copy to specified buffer the text of the region.
3707 It is inserted into that buffer, replacing existing text there.
3709 When calling from a program, give three arguments:
3710 BUFFER (or buffer name), START and END.
3711 START and END specify the portion of the current buffer to be copied."
3713 (let ((oldbuf (current-buffer)))
3714 (with-current-buffer (get-buffer-create buffer)
3715 (barf-if-buffer-read-only)
3716 (erase-buffer)
3717 (save-excursion
3718 (insert-buffer-substring oldbuf start end)))))
3719 \f
3720 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3721 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3723 (defvar activate-mark-hook nil
3724 "Hook run when the mark becomes active.
3725 It is also run at the end of a command, if the mark is active and
3726 it is possible that the region may have changed.")
3728 (defvar deactivate-mark-hook nil
3729 "Hook run when the mark becomes inactive.")
3731 (defun mark (&optional force)
3732 "Return this buffer's mark value as integer, or nil if never set.
3734 In Transient Mark mode, this function signals an error if
3735 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3736 or the argument FORCE is non-nil, it disregards whether the mark
3737 is active, and returns an integer or nil in the usual way.
3739 If you are using this in an editing command, you are most likely making
3740 a mistake; see the documentation of `set-mark'."
3741 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3742 (marker-position (mark-marker))
3743 (signal 'mark-inactive nil)))
3745 (defsubst deactivate-mark (&optional force)
3746 "Deactivate the mark by setting `mark-active' to nil.
3747 Unless FORCE is non-nil, this function does nothing if Transient
3748 Mark mode is disabled.
3749 This function also runs `deactivate-mark-hook'."
3750 (when (or transient-mark-mode force)
3751 (when (and (if (eq select-active-regions 'only)
3752 (eq (car-safe transient-mark-mode) 'only)
3753 select-active-regions)
3754 (region-active-p)
3755 (display-selections-p))
3756 ;; The var `saved-region-selection', if non-nil, is the text in
3757 ;; the region prior to the last command modifying the buffer.
3758 ;; Set the selection to that, or to the current region.
3759 (cond (saved-region-selection
3760 (x-set-selection 'PRIMARY saved-region-selection)
3761 (setq saved-region-selection nil))
3762 ((/= (region-beginning) (region-end))
3763 (x-set-selection 'PRIMARY
3764 (buffer-substring-no-properties
3765 (region-beginning)
3766 (region-end))))))
3767 (if (and (null force)
3768 (or (eq transient-mark-mode 'lambda)
3769 (and (eq (car-safe transient-mark-mode) 'only)
3770 (null (cdr transient-mark-mode)))))
3771 ;; When deactivating a temporary region, don't change
3772 ;; `mark-active' or run `deactivate-mark-hook'.
3773 (setq transient-mark-mode nil)
3774 (if (eq (car-safe transient-mark-mode) 'only)
3775 (setq transient-mark-mode (cdr transient-mark-mode)))
3776 (setq mark-active nil)
3777 (run-hooks 'deactivate-mark-hook))))
3779 (defun activate-mark ()
3780 "Activate the mark."
3781 (when (mark t)
3782 (setq mark-active t)
3783 (unless transient-mark-mode
3784 (setq transient-mark-mode 'lambda))))
3786 (defun set-mark (pos)
3787 "Set this buffer's mark to POS. Don't use this function!
3788 That is to say, don't use this function unless you want
3789 the user to see that the mark has moved, and you want the previous
3790 mark position to be lost.
3792 Normally, when a new mark is set, the old one should go on the stack.
3793 This is why most applications should use `push-mark', not `set-mark'.
3795 Novice Emacs Lisp programmers often try to use the mark for the wrong
3796 purposes. The mark saves a location for the user's convenience.
3797 Most editing commands should not alter the mark.
3798 To remember a location for internal use in the Lisp program,
3799 store it in a Lisp variable. Example:
3801 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3803 (if pos
3804 (progn
3805 (setq mark-active t)
3806 (run-hooks 'activate-mark-hook)
3807 (set-marker (mark-marker) pos (current-buffer)))
3808 ;; Normally we never clear mark-active except in Transient Mark mode.
3809 ;; But when we actually clear out the mark value too, we must
3810 ;; clear mark-active in any mode.
3811 (deactivate-mark t)
3812 (set-marker (mark-marker) nil)))
3814 (defcustom use-empty-active-region nil
3816 If nil, region-aware commands treat empty regions as inactive.
3817 If non-nil, region-aware commands treat the region as active as
3818 long as the mark is active, even if the region is empty.
3820 Region-aware commands are those that act on the region if it is
3821 active and Transient Mark mode is enabled, and on the text near
3822 point otherwise."
3823 :type 'boolean
3824 :version "23.1"
3825 :group 'editing-basics)
3827 (defun use-region-p ()
3828 "Return t if the region is active and it is appropriate to act on it.
3829 This is used by commands that act specially on the region under
3830 Transient Mark mode.
3832 The return value is t if Transient Mark mode is enabled and the
3833 mark is active; furthermore, if `use-empty-active-region' is nil,
3834 the region must not be empty. Otherwise, the return value is nil.
3836 For some commands, it may be appropriate to ignore the value of
3837 `use-empty-active-region'; in that case, use `region-active-p'."
3838 (and (region-active-p)
3839 (or use-empty-active-region (> (region-end) (region-beginning)))))
3841 (defun region-active-p ()
3842 "Return t if Transient Mark mode is enabled and the mark is active.
3844 Some commands act specially on the region when Transient Mark
3845 mode is enabled. Usually, such commands should use
3846 `use-region-p' instead of this function, because `use-region-p'
3847 also checks the value of `use-empty-active-region'."
3848 (and transient-mark-mode mark-active))
3850 (defvar mark-ring nil
3851 "The list of former marks of the current buffer, most recent first.")
3852 (make-variable-buffer-local 'mark-ring)
3853 (put 'mark-ring 'permanent-local t)
3855 (defcustom mark-ring-max 16
3856 "Maximum size of mark ring. Start discarding off end if gets this big."
3857 :type 'integer
3858 :group 'editing-basics)
3860 (defvar global-mark-ring nil
3861 "The list of saved global marks, most recent first.")
3863 (defcustom global-mark-ring-max 16
3864 "Maximum size of global mark ring. \
3865 Start discarding off end if gets this big."
3866 :type 'integer
3867 :group 'editing-basics)
3869 (defun pop-to-mark-command ()
3870 "Jump to mark, and pop a new position for mark off the ring.
3871 \(Does not affect global mark ring\)."
3872 (interactive)
3873 (if (null (mark t))
3874 (error "No mark set in this buffer")
3875 (if (= (point) (mark t))
3876 (message "Mark popped"))
3877 (goto-char (mark t))
3878 (pop-mark)))
3880 (defun push-mark-command (arg &optional nomsg)
3881 "Set mark at where point is.
3882 If no prefix ARG and mark is already set there, just activate it.
3883 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3884 (interactive "P")
3885 (let ((mark (marker-position (mark-marker))))
3886 (if (or arg (null mark) (/= mark (point)))
3887 (push-mark nil nomsg t)
3888 (setq mark-active t)
3889 (run-hooks 'activate-mark-hook)
3890 (unless nomsg
3891 (message "Mark activated")))))
3893 (defcustom set-mark-command-repeat-pop nil
3896 will pop the mark twice, and
3898 will pop the mark three times.
3902 :type 'boolean
3903 :group 'editing-basics)
3905 (defcustom set-mark-default-inactive nil
3906 "If non-nil, setting the mark does not activate it.
3908 behave the same whether or not `transient-mark-mode' is enabled."
3909 :type 'boolean
3910 :group 'editing-basics
3911 :version "23.1")
3913 (defun set-mark-command (arg)
3914 "Set the mark where point is, or jump to the mark.
3915 Setting the mark also alters the region, which is the text
3916 between point and mark; this is the closest equivalent in
3919 With no prefix argument, set the mark at point, and push the
3920 old mark position on local mark ring. Also push the old mark on
3921 global mark ring, if the previous mark was set in another buffer.
3923 When Transient Mark Mode is off, immediately repeating this
3924 command activates `transient-mark-mode' temporarily.
3927 jump to the mark, and set the mark from
3928 position popped off the local mark ring \(this does not affect the global
3930 mark ring \(see `pop-global-mark'\).
3932 If `set-mark-command-repeat-pop' is non-nil, repeating
3934 off the local (or global) mark ring and jumps there.
3937 argument, unconditionally set mark where point is, even if
3938 `set-mark-command-repeat-pop' is non-nil.
3940 Novice Emacs Lisp programmers often try to use the mark for the wrong
3941 purposes. See the documentation of `set-mark' for more information."
3942 (interactive "P")
3943 (cond ((eq transient-mark-mode 'lambda)
3944 (setq transient-mark-mode nil))
3945 ((eq (car-safe transient-mark-mode) 'only)
3946 (deactivate-mark)))
3947 (cond
3948 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3949 (push-mark-command nil))
3950 ((not (eq this-command 'set-mark-command))
3951 (if arg
3952 (pop-to-mark-command)
3953 (push-mark-command t)))
3954 ((and set-mark-command-repeat-pop
3955 (eq last-command 'pop-to-mark-command))
3956 (setq this-command 'pop-to-mark-command)
3957 (pop-to-mark-command))
3958 ((and set-mark-command-repeat-pop
3959 (eq last-command 'pop-global-mark)
3960 (not arg))
3961 (setq this-command 'pop-global-mark)
3962 (pop-global-mark))
3963 (arg
3964 (setq this-command 'pop-to-mark-command)
3965 (pop-to-mark-command))
3966 ((eq last-command 'set-mark-command)
3967 (if (region-active-p)
3968 (progn
3969 (deactivate-mark)
3970 (message "Mark deactivated"))
3971 (activate-mark)
3972 (message "Mark activated")))
3973 (t
3974 (push-mark-command nil)
3975 (if set-mark-default-inactive (deactivate-mark)))))
3977 (defun push-mark (&optional location nomsg activate)
3978 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3979 If the last global mark pushed was not in the current buffer,
3980 also push LOCATION on the global mark ring.
3981 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3983 Novice Emacs Lisp programmers often try to use the mark for the wrong
3984 purposes. See the documentation of `set-mark' for more information.
3986 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3987 (unless (null (mark t))
3988 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3989 (when (> (length mark-ring) mark-ring-max)
3990 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3991 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3992 (set-marker (mark-marker) (or location (point)) (current-buffer))
3993 ;; Now push the mark on the global mark ring.
3994 (if (and global-mark-ring
3995 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3996 ;; The last global mark pushed was in this same buffer.
3997 ;; Don't push another one.
3998 nil
3999 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
4000 (when (> (length global-mark-ring) global-mark-ring-max)
4001 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
4002 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
4003 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
4004 (message "Mark set"))
4005 (if (or activate (not transient-mark-mode))
4006 (set-mark (mark t)))
4007 nil)
4009 (defun pop-mark ()
4010 "Pop off mark ring into the buffer's actual mark.
4011 Does not set point. Does nothing if mark ring is empty."
4012 (when mark-ring
4013 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
4014 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
4015 (move-marker (car mark-ring) nil)
4016 (if (null (mark t)) (ding))
4017 (setq mark-ring (cdr mark-ring)))
4018 (deactivate-mark))
4020 (define-obsolete-function-alias
4021 'exchange-dot-and-mark 'exchange-point-and-mark "23.3")
4022 (defun exchange-point-and-mark (&optional arg)
4023 "Put the mark where point is now, and point where the mark is now.
4024 This command works even when the mark is not active,
4025 and it reactivates the mark.
4027 If Transient Mark mode is on, a prefix ARG deactivates the mark
4028 if it is active, and otherwise avoids reactivating it. If
4029 Transient Mark mode is off, a prefix ARG enables Transient Mark
4030 mode temporarily."
4031 (interactive "P")
4032 (let ((omark (mark t))
4033 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
4034 (if (null omark)
4035 (error "No mark set in this buffer"))
4036 (deactivate-mark)
4037 (set-mark (point))
4038 (goto-char omark)
4039 (if set-mark-default-inactive (deactivate-mark))
4040 (cond (temp-highlight
4041 (setq transient-mark-mode (cons 'only transient-mark-mode)))
4042 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
4043 (not (or arg (region-active-p))))
4044 (deactivate-mark))
4045 (t (activate-mark)))
4046 nil))
4048 (defcustom shift-select-mode t
4049 "When non-nil, shifted motion keys activate the mark momentarily.
4051 While the mark is activated in this way, any shift-translated point
4052 motion key extends the region, and if Transient Mark mode was off, it
4053 is temporarily turned on. Furthermore, the mark will be deactivated
4054 by any subsequent point motion key that was not shift-translated, or
4055 by any action that normally deactivates the mark in Transient Mark mode.
4057 See `this-command-keys-shift-translated' for the meaning of
4058 shift-translation."
4059 :type 'boolean
4060 :group 'editing-basics)
4062 (defun handle-shift-selection ()
4063 "Activate/deactivate mark depending on invocation thru shift translation.
4064 This function is called by `call-interactively' when a command
4065 with a `^' character in its `interactive' spec is invoked, before
4066 running the command itself.
4068 If `shift-select-mode' is enabled and the command was invoked
4069 through shift translation, set the mark and activate the region
4070 temporarily, unless it was already set in this way. See
4071 `this-command-keys-shift-translated' for the meaning of shift
4072 translation.
4074 Otherwise, if the region has been activated temporarily,
4075 deactivate it, and restore the variable `transient-mark-mode' to
4076 its earlier value."
4077 (cond ((and shift-select-mode this-command-keys-shift-translated)
4078 (unless (and mark-active
4079 (eq (car-safe transient-mark-mode) 'only))
4080 (setq transient-mark-mode
4081 (cons 'only
4082 (unless (eq transient-mark-mode 'lambda)
4083 transient-mark-mode)))
4084 (push-mark nil nil t)))
4085 ((eq (car-safe transient-mark-mode) 'only)
4086 (setq transient-mark-mode (cdr transient-mark-mode))
4087 (deactivate-mark))))
4089 (define-minor-mode transient-mark-mode
4090 "Toggle Transient Mark mode.
4091 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
4093 In Transient Mark mode, when the mark is active, the region is highlighted.
4095 So do certain other operations that set the mark
4096 but whose main purpose is something else--for example,
4102 Many commands change their behavior when Transient Mark mode is in effect
4103 and the mark is active, by acting on the region instead of their usual
4104 default part of the buffer's text. Examples of such commands include
4109 commands which are sensitive to the Transient Mark mode."
4110 :global t
4111 ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again.
4112 :variable transient-mark-mode)
4114 (defvar widen-automatically t
4115 "Non-nil means it is ok for commands to call `widen' when they want to.
4116 Some commands will do this in order to go to positions outside
4117 the current accessible part of the buffer.
4119 If `widen-automatically' is nil, these commands will do something else
4120 as a fallback, and won't change the buffer bounds.")
4122 (defvar non-essential nil
4123 "Whether the currently executing code is performing an essential task.
4124 This variable should be non-nil only when running code which should not
4125 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4126 user for a password when we are simply scanning a set of files in the
4127 background or displaying possible completions before the user even asked
4128 for it.")
4130 (defun pop-global-mark ()
4131 "Pop off global mark ring and jump to the top location."
4132 (interactive)
4133 ;; Pop entries which refer to non-existent buffers.
4134 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4135 (setq global-mark-ring (cdr global-mark-ring)))
4136 (or global-mark-ring
4137 (error "No global mark set"))
4138 (let* ((marker (car global-mark-ring))
4139 (buffer (marker-buffer marker))
4140 (position (marker-position marker)))
4141 (setq global-mark-ring (nconc (cdr global-mark-ring)
4142 (list (car global-mark-ring))))
4143 (set-buffer buffer)
4144 (or (and (>= position (point-min))
4145 (<= position (point-max)))
4146 (if widen-automatically
4147 (widen)
4148 (error "Global mark position is outside accessible part of buffer")))
4149 (goto-char position)
4150 (switch-to-buffer buffer)))
4151 \f
4152 (defcustom next-line-add-newlines nil
4153 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4154 :type 'boolean
4155 :version "21.1"
4156 :group 'editing-basics)
4158 (defun next-line (&optional arg try-vscroll)
4159 "Move cursor vertically down ARG lines.
4160 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4161 If there is no character in the target line exactly under the current column,
4162 the cursor is positioned after the character in that line which spans this
4163 column, or at the end of the line if it is not long enough.
4164 If there is no line in the buffer after this one, behavior depends on the
4165 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4166 to create a line, and moves the cursor to that line. Otherwise it moves the
4167 cursor to the end of the buffer.
4169 If the variable `line-move-visual' is non-nil, this command moves
4170 by display lines. Otherwise, it moves by buffer lines, without
4171 taking variable-width characters or continued lines into account.
4174 a semipermanent goal column for this command.
4175 Then instead of trying to move exactly vertically (or as close as possible),
4176 this command moves to the specified goal column (or as close as possible).
4177 The goal column is stored in the variable `goal-column', which is nil
4178 when there is no goal column.
4180 If you are thinking of using this in a Lisp program, consider
4181 using `forward-line' instead. It is usually easier to use
4182 and more reliable (no dependence on goal column, etc.)."
4184 (or arg (setq arg 1))
4185 (if (and next-line-add-newlines (= arg 1))
4186 (if (save-excursion (end-of-line) (eobp))
4187 ;; When adding a newline, don't expand an abbrev.
4188 (let ((abbrev-mode nil))
4189 (end-of-line)
4191 (line-move arg nil nil try-vscroll))
4192 (if (called-interactively-p 'interactive)
4193 (condition-case err
4194 (line-move arg nil nil try-vscroll)
4195 ((beginning-of-buffer end-of-buffer)
4196 (signal (car err) (cdr err))))
4197 (line-move arg nil nil try-vscroll)))
4198 nil)
4200 (defun previous-line (&optional arg try-vscroll)
4201 "Move cursor vertically up ARG lines.
4202 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4203 If there is no character in the target line exactly over the current column,
4204 the cursor is positioned after the character in that line which spans this
4205 column, or at the end of the line if it is not long enough.
4207 If the variable `line-move-visual' is non-nil, this command moves
4208 by display lines. Otherwise, it moves by buffer lines, without
4209 taking variable-width characters or continued lines into account.
4212 a semipermanent goal column for this command.
4213 Then instead of trying to move exactly vertically (or as close as possible),
4214 this command moves to the specified goal column (or as close as possible).
4215 The goal column is stored in the variable `goal-column', which is nil
4216 when there is no goal column.
4218 If you are thinking of using this in a Lisp program, consider using
4219 `forward-line' with a negative argument instead. It is usually easier
4220 to use and more reliable (no dependence on goal column, etc.)."
4222 (or arg (setq arg 1))
4223 (if (called-interactively-p 'interactive)
4224 (condition-case err
4225 (line-move (- arg) nil nil try-vscroll)
4226 ((beginning-of-buffer end-of-buffer)
4227 (signal (car err) (cdr err))))
4228 (line-move (- arg) nil nil try-vscroll))
4229 nil)
4231 (defcustom track-eol nil
4232 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4233 This means moving to the end of each line moved onto.
4234 The beginning of a blank line does not count as the end of a line.
4235 This has no effect when `line-move-visual' is non-nil."
4236 :type 'boolean
4237 :group 'editing-basics)
4239 (defcustom goal-column nil
4241 :type '(choice integer
4242 (const :tag "None" nil))
4243 :group 'editing-basics)
4244 (make-variable-buffer-local 'goal-column)
4246 (defvar temporary-goal-column 0
4247 "Current goal column for vertical motion.
4248 It is the column where point was at the start of the current run
4249 of vertical motion commands.
4251 When moving by visual lines via `line-move-visual', it is a cons
4252 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4253 divided by the default column width, and HSCROLL is the number of
4254 columns by which window is scrolled from left margin.
4256 When the `track-eol' feature is doing its job, the value is
4257 `most-positive-fixnum'.")
4259 (defcustom line-move-ignore-invisible t
4261 Outline mode sets this."
4262 :type 'boolean
4263 :group 'editing-basics)
4265 (defcustom line-move-visual t
4266 "When non-nil, `line-move' moves point by visual lines.
4267 This movement is based on where the cursor is displayed on the
4268 screen, instead of relying on buffer contents alone. It takes
4269 into account variable-width characters and line continuation.
4270 If nil, `line-move' moves point by logical lines."
4271 :type 'boolean
4272 :group 'editing-basics
4273 :version "23.1")
4275 ;; Returns non-nil if partial move was done.
4276 (defun line-move-partial (arg noerror to-end)
4277 (if (< arg 0)
4278 ;; Move backward (up).
4279 ;; If already vscrolled, reduce vscroll
4280 (let ((vs (window-vscroll nil t)))
4281 (when (> vs (frame-char-height))
4282 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4284 ;; Move forward (down).
4285 (let* ((lh (window-line-height -1))
4286 (vpos (nth 1 lh))
4287 (ypos (nth 2 lh))
4288 (rbot (nth 3 lh))
4289 py vs)
4290 (when (or (null lh)
4291 (>= rbot (frame-char-height))
4292 (<= ypos (- (frame-char-height))))
4293 (unless lh
4294 (let ((wend (pos-visible-in-window-p t nil t)))
4295 (setq rbot (nth 3 wend)
4296 vpos (nth 5 wend))))
4297 (cond
4298 ;; If last line of window is fully visible, move forward.
4299 ((or (null rbot) (= rbot 0))
4300 nil)
4301 ;; If cursor is not in the bottom scroll margin, move forward.
4302 ((and (> vpos 0)
4303 (< (setq py
4304 (or (nth 1 (window-line-height))
4305 (let ((ppos (posn-at-point)))
4306 (cdr (or (posn-actual-col-row ppos)
4307 (posn-col-row ppos))))))
4308 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4309 nil)
4310 ;; When already vscrolled, we vscroll some more if we can,
4311 ;; or clear vscroll and move forward at end of tall image.
4312 ((> (setq vs (window-vscroll nil t)) 0)
4313 (when (> rbot 0)
4314 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4315 ;; If cursor just entered the bottom scroll margin, move forward,
4316 ;; but also vscroll one line so redisplay wont recenter.
4317 ((and (> vpos 0)
4318 (= py (min (- (window-text-height) scroll-margin 1)
4319 (1- vpos))))
4320 (set-window-vscroll nil (frame-char-height) t)
4321 (line-move-1 arg noerror to-end)
4322 t)
4323 ;; If there are lines above the last line, scroll-up one line.
4324 ((> vpos 0)
4325 (scroll-up 1)
4326 t)
4327 ;; Finally, start vscroll.
4328 (t
4329 (set-window-vscroll nil (frame-char-height) t)))))))
4332 ;; This is like line-move-1 except that it also performs
4333 ;; vertical scrolling of tall images if appropriate.
4334 ;; That is not really a clean thing to do, since it mixes
4335 ;; scrolling with cursor motion. But so far we don't have
4336 ;; a cleaner solution to the problem of making C-n do something
4337 ;; useful given a tall image.
4338 (defun line-move (arg &optional noerror to-end try-vscroll)
4339 (unless (and auto-window-vscroll try-vscroll
4340 ;; Only vscroll for single line moves
4341 (= (abs arg) 1)
4342 ;; But don't vscroll in a keyboard macro.
4343 (not defining-kbd-macro)
4344 (not executing-kbd-macro)
4345 (line-move-partial arg noerror to-end))
4346 (set-window-vscroll nil 0 t)
4347 (if line-move-visual
4348 (line-move-visual arg noerror)
4349 (line-move-1 arg noerror to-end))))
4351 ;; Display-based alternative to line-move-1.
4352 ;; Arg says how many lines to move. The value is t if we can move the
4353 ;; specified number of lines.
4354 (defun line-move-visual (arg &optional noerror)
4355 (let ((opoint (point))
4356 (hscroll (window-hscroll))
4357 target-hscroll)
4358 ;; Check if the previous command was a line-motion command, or if
4359 ;; we were called from some other command.
4360 (if (and (consp temporary-goal-column)
4361 (memq last-command `(next-line previous-line ,this-command)))
4362 ;; If so, there's no need to reset `temporary-goal-column',
4363 ;; but we may need to hscroll.
4364 (if (or (/= (cdr temporary-goal-column) hscroll)
4365 (> (cdr temporary-goal-column) 0))
4366 (setq target-hscroll (cdr temporary-goal-column)))
4367 ;; Otherwise, we should reset `temporary-goal-column'.
4368 (let ((posn (posn-at-point)))
4369 (cond
4370 ;; Handle the `overflow-newline-into-fringe' case:
4371 ((eq (nth 1 posn) 'right-fringe)
4372 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4373 ((car (posn-x-y posn))
4374 (setq temporary-goal-column
4375 (cons (/ (float (car (posn-x-y posn)))
4376 (frame-char-width)) hscroll))))))
4377 (if target-hscroll
4378 (set-window-hscroll (selected-window) target-hscroll))
4379 (or (and (= (vertical-motion
4380 (cons (or goal-column
4381 (if (consp temporary-goal-column)
4382 (car temporary-goal-column)
4383 temporary-goal-column))
4384 arg))
4385 arg)
4386 (or (>= arg 0)
4387 (/= (point) opoint)
4388 ;; If the goal column lies on a display string,
4389 ;; `vertical-motion' advances the cursor to the end
4390 ;; of the string. For arg < 0, this can cause the
4391 ;; cursor to get stuck. (Bug#3020).
4392 (= (vertical-motion arg) arg)))
4393 (unless noerror
4394 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4395 nil)))))
4397 ;; This is the guts of next-line and previous-line.
4398 ;; Arg says how many lines to move.
4399 ;; The value is t if we can move the specified number of lines.
4400 (defun line-move-1 (arg &optional noerror _to-end)
4401 ;; Don't run any point-motion hooks, and disregard intangibility,
4402 ;; for intermediate positions.
4403 (let ((inhibit-point-motion-hooks t)
4404 (opoint (point))
4405 (orig-arg arg))
4406 (if (consp temporary-goal-column)
4407 (setq temporary-goal-column (+ (car temporary-goal-column)
4408 (cdr temporary-goal-column))))
4409 (unwind-protect
4410 (progn
4411 (if (not (memq last-command '(next-line previous-line)))
4412 (setq temporary-goal-column
4413 (if (and track-eol (eolp)
4414 ;; Don't count beg of empty line as end of line
4415 ;; unless we just did explicit end-of-line.
4416 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4417 most-positive-fixnum
4418 (current-column))))
4420 (if (not (or (integerp selective-display)
4421 line-move-ignore-invisible))
4422 ;; Use just newline characters.
4423 ;; Set ARG to 0 if we move as many lines as requested.
4424 (or (if (> arg 0)
4425 (progn (if (> arg 1) (forward-line (1- arg)))
4426 ;; This way of moving forward ARG lines
4427 ;; verifies that we have a newline after the last one.
4428 ;; It doesn't get confused by intangible text.
4429 (end-of-line)
4430 (if (zerop (forward-line 1))
4431 (setq arg 0)))
4432 (and (zerop (forward-line arg))
4433 (bolp)
4434 (setq arg 0)))
4435 (unless noerror
4436 (signal (if (< arg 0)
4437 'beginning-of-buffer
4438 'end-of-buffer)
4439 nil)))
4440 ;; Move by arg lines, but ignore invisible ones.
4441 (let (done)
4442 (while (and (> arg 0) (not done))
4443 ;; If the following character is currently invisible,
4444 ;; skip all characters with that same `invisible' property value.
4445 (while (and (not (eobp)) (invisible-p (point)))
4446 (goto-char (next-char-property-change (point))))
4447 ;; Move a line.
4448 ;; We don't use `end-of-line', since we want to escape
4449 ;; from field boundaries occurring exactly at point.
4450 (goto-char (constrain-to-field
4451 (let ((inhibit-field-text-motion t))
4452 (line-end-position))
4453 (point) t t
4454 'inhibit-line-move-field-capture))
4455 ;; If there's no invisibility here, move over the newline.
4456 (cond
4457 ((eobp)
4458 (if (not noerror)
4459 (signal 'end-of-buffer nil)
4460 (setq done t)))
4461 ((and (> arg 1) ;; Use vertical-motion for last move
4462 (not (integerp selective-display))
4463 (not (invisible-p (point))))
4464 ;; We avoid vertical-motion when possible
4465 ;; because that has to fontify.
4466 (forward-line 1))
4467 ;; Otherwise move a more sophisticated way.
4468 ((zerop (vertical-motion 1))
4469 (if (not noerror)
4470 (signal 'end-of-buffer nil)
4471 (setq done t))))
4472 (unless done
4473 (setq arg (1- arg))))
4474 ;; The logic of this is the same as the loop above,
4475 ;; it just goes in the other direction.
4476 (while (and (< arg 0) (not done))
4477 ;; For completely consistency with the forward-motion
4478 ;; case, we should call beginning-of-line here.
4479 ;; However, if point is inside a field and on a
4480 ;; continued line, the call to (vertical-motion -1)
4481 ;; below won't move us back far enough; then we return
4482 ;; to the same column in line-move-finish, and point
4483 ;; gets stuck -- cyd
4484 (forward-line 0)
4485 (cond
4486 ((bobp)
4487 (if (not noerror)
4488 (signal 'beginning-of-buffer nil)
4489 (setq done t)))
4490 ((and (< arg -1) ;; Use vertical-motion for last move
4491 (not (integerp selective-display))
4492 (not (invisible-p (1- (point)))))
4493 (forward-line -1))
4494 ((zerop (vertical-motion -1))
4495 (if (not noerror)
4496 (signal 'beginning-of-buffer nil)
4497 (setq done t))))
4498 (unless done
4499 (setq arg (1+ arg))
4500 (while (and ;; Don't move over previous invis lines
4501 ;; if our target is the middle of this line.
4502 (or (zerop (or goal-column temporary-goal-column))
4503 (< arg 0))
4504 (not (bobp)) (invisible-p (1- (point))))
4505 (goto-char (previous-char-property-change (point))))))))
4506 ;; This is the value the function returns.
4507 (= arg 0))
4509 (cond ((> arg 0)
4510 ;; If we did not move down as far as desired, at least go
4511 ;; to end of line. Be sure to call point-entered and
4512 ;; point-left-hooks.
4513 (let* ((npoint (prog1 (line-end-position)
4514 (goto-char opoint)))
4515 (inhibit-point-motion-hooks nil))
4516 (goto-char npoint)))
4517 ((< arg 0)
4518 ;; If we did not move up as far as desired,
4519 ;; at least go to beginning of line.
4520 (let* ((npoint (prog1 (line-beginning-position)
4521 (goto-char opoint)))
4522 (inhibit-point-motion-hooks nil))
4523 (goto-char npoint)))
4524 (t
4525 (line-move-finish (or goal-column temporary-goal-column)
4526 opoint (> orig-arg 0)))))))
4528 (defun line-move-finish (column opoint forward)
4529 (let ((repeat t))
4530 (while repeat
4531 ;; Set REPEAT to t to repeat the whole thing.
4532 (setq repeat nil)
4534 (let (new
4535 (old (point))
4536 (line-beg (line-beginning-position))
4537 (line-end
4538 ;; Compute the end of the line
4539 ;; ignoring effectively invisible newlines.
4540 (save-excursion
4541 ;; Like end-of-line but ignores fields.
4543 (while (and (not (eobp)) (invisible-p (point)))
4544 (goto-char (next-char-property-change (point)))
4546 (point))))
4548 ;; Move to the desired column.
4549 (line-move-to-column (truncate column))
4551 ;; Corner case: suppose we start out in a field boundary in
4552 ;; the middle of a continued line. When we get to
4553 ;; line-move-finish, point is at the start of a new *screen*
4554 ;; line but the same text line; then line-move-to-column would
4555 ;; move us backwards. Test using C-n with point on the "x" in
4556 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4557 (and forward
4558 (< (point) old)
4559 (goto-char old))
4561 (setq new (point))
4563 ;; Process intangibility within a line.
4564 ;; With inhibit-point-motion-hooks bound to nil, a call to
4565 ;; goto-char moves point past intangible text.
4567 ;; However, inhibit-point-motion-hooks controls both the
4568 ;; intangibility and the point-entered/point-left hooks. The
4569 ;; following hack avoids calling the point-* hooks
4570 ;; unnecessarily. Note that we move *forward* past intangible
4571 ;; text when the initial and final points are the same.
4572 (goto-char new)
4573 (let ((inhibit-point-motion-hooks nil))
4574 (goto-char new)
4576 ;; If intangibility moves us to a different (later) place
4577 ;; in the same line, use that as the destination.
4578 (if (<= (point) line-end)
4579 (setq new (point))
4580 ;; If that position is "too late",
4581 ;; try the previous allowable position.
4582 ;; See if it is ok.
4583 (backward-char)
4584 (if (if forward
4585 ;; If going forward, don't accept the previous
4586 ;; allowable position if it is before the target line.
4587 (< line-beg (point))
4588 ;; If going backward, don't accept the previous
4589 ;; allowable position if it is still after the target line.
4590 (<= (point) line-end))
4591 (setq new (point))
4592 ;; As a last resort, use the end of the line.
4593 (setq new line-end))))
4595 ;; Now move to the updated destination, processing fields
4596 ;; as well as intangibility.
4597 (goto-char opoint)
4598 (let ((inhibit-point-motion-hooks nil))
4599 (goto-char
4600 ;; Ignore field boundaries if the initial and final
4601 ;; positions have the same `field' property, even if the
4602 ;; fields are non-contiguous. This seems to be "nicer"
4603 ;; behavior in many situations.
4604 (if (eq (get-char-property new 'field)
4605 (get-char-property opoint 'field))
4606 new
4607 (constrain-to-field new opoint t t
4608 'inhibit-line-move-field-capture))))
4610 ;; If all this moved us to a different line,
4611 ;; retry everything within that new line.
4612 (when (or (< (point) line-beg) (> (point) line-end))
4613 ;; Repeat the intangibility and field processing.
4614 (setq repeat t))))))
4616 (defun line-move-to-column (col)
4617 "Try to find column COL, considering invisibility.
4618 This function works only in certain cases,
4619 because what we really need is for `move-to-column'
4620 and `current-column' to be able to ignore invisible text."
4621 (if (zerop col)
4622 (beginning-of-line)
4623 (move-to-column col))
4625 (when (and line-move-ignore-invisible
4626 (not (bolp)) (invisible-p (1- (point))))
4627 (let ((normal-location (point))
4628 (normal-column (current-column)))
4629 ;; If the following character is currently invisible,
4630 ;; skip all characters with that same `invisible' property value.
4631 (while (and (not (eobp))
4632 (invisible-p (point)))
4633 (goto-char (next-char-property-change (point))))
4634 ;; Have we advanced to a larger column position?
4635 (if (> (current-column) normal-column)
4636 ;; We have made some progress towards the desired column.
4637 ;; See if we can make any further progress.
4638 (line-move-to-column (+ (current-column) (- col normal-column)))
4639 ;; Otherwise, go to the place we originally found
4640 ;; and move back over invisible text.
4641 ;; that will get us to the same place on the screen
4642 ;; but with a more reasonable buffer position.
4643 (goto-char normal-location)
4644 (let ((line-beg (line-beginning-position)))
4645 (while (and (not (bolp)) (invisible-p (1- (point))))
4646 (goto-char (previous-char-property-change (point) line-beg))))))))
4648 (defun move-end-of-line (arg)
4649 "Move point to end of current line as displayed.
4650 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4651 If point reaches the beginning or end of buffer, it stops there.
4653 To ignore the effects of the `intangible' text or overlay
4654 property, bind `inhibit-point-motion-hooks' to t.
4655 If there is an image in the current line, this function
4656 disregards newlines that are part of the text on which the image
4657 rests."
4658 (interactive "^p")
4659 (or arg (setq arg 1))
4660 (let (done)
4661 (while (not done)
4662 (let ((newpos
4663 (save-excursion
4664 (let ((goal-column 0)
4665 (line-move-visual nil))
4666 (and (line-move arg t)
4667 ;; With bidi reordering, we may not be at bol,
4668 ;; so make sure we are.
4670 (not (bobp))
4671 (progn
4672 (while (and (not (bobp)) (invisible-p (1- (point))))
4673 (goto-char (previous-single-char-property-change
4674 (point) 'invisible)))
4675 (backward-char 1)))
4676 (point)))))
4677 (goto-char newpos)
4678 (if (and (> (point) newpos)
4680 (backward-char 1)
4681 (if (and (> (point) newpos) (not (eobp))
4683 ;; If we skipped something intangible and now we're not
4684 ;; really at eol, keep going.
4685 (setq arg 1)
4686 (setq done t)))))))
4688 (defun move-beginning-of-line (arg)
4689 "Move point to beginning of current line as displayed.
4690 \(If there's an image in the line, this disregards newlines
4691 which are part of the text that the image rests on.)
4693 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4694 If point reaches the beginning or end of buffer, it stops there.
4695 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4696 (interactive "^p")
4697 (or arg (setq arg 1))
4699 (let ((orig (point))
4700 first-vis first-vis-field-value)
4702 ;; Move by lines, if ARG is not 1 (the default).
4703 (if (/= arg 1)
4704 (let ((line-move-visual nil))
4705 (line-move (1- arg) t)))
4707 ;; Move to beginning-of-line, ignoring fields and invisibles.
4709 (while (and (not (bobp)) (invisible-p (1- (point))))
4710 (goto-char (previous-char-property-change (point)))
4713 ;; Now find first visible char in the line
4714 (while (and (not (eobp)) (invisible-p (point)))
4715 (goto-char (next-char-property-change (point))))
4716 (setq first-vis (point))
4718 ;; See if fields would stop us from reaching FIRST-VIS.
4719 (setq first-vis-field-value
4720 (constrain-to-field first-vis orig (/= arg 1) t nil))
4722 (goto-char (if (/= first-vis-field-value first-vis)
4723 ;; If yes, obey them.
4724 first-vis-field-value
4725 ;; Otherwise, move to START with attention to fields.
4726 ;; (It is possible that fields never matter in this case.)
4727 (constrain-to-field (point) orig
4728 (/= arg 1) t nil)))))
4731 ;; Many people have said they rarely use this feature, and often type
4732 ;; it by accident. Maybe it shouldn't even be on a key.
4733 (put 'set-goal-column 'disabled t)
4735 (defun set-goal-column (arg)
4737 Those commands will move to this position in the line moved to
4738 rather than trying to keep the same horizontal position.
4739 With a non-nil argument ARG, clears out the goal column
4741 The goal column is stored in the variable `goal-column'."
4742 (interactive "P")
4743 (if arg
4744 (progn
4745 (setq goal-column nil)
4746 (message "No goal column"))
4747 (setq goal-column (current-column))
4748 ;; The older method below can be erroneous if `set-goal-column' is bound
4749 ;; to a sequence containing %
4750 ;;(message (substitute-command-keys
4752 ;;goal-column)
4753 (message "%s"
4754 (concat
4755 (format "Goal column %d " goal-column)
4756 (substitute-command-keys
4759 )
4760 nil)
4761 \f
4762 ;;; Editing based on visual lines, as opposed to logical lines.
4764 (defun end-of-visual-line (&optional n)
4765 "Move point to end of current visual line.
4766 With argument N not nil or 1, move forward N - 1 visual lines first.
4767 If point reaches the beginning or end of buffer, it stops there.
4768 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4769 (interactive "^p")
4770 (or n (setq n 1))
4771 (if (/= n 1)
4772 (let ((line-move-visual t))
4773 (line-move (1- n) t)))
4774 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4775 ;; constrain to field boundaries, so we don't either.
4776 (vertical-motion (cons (window-width) 0)))
4778 (defun beginning-of-visual-line (&optional n)
4779 "Move point to beginning of current visual line.
4780 With argument N not nil or 1, move forward N - 1 visual lines first.
4781 If point reaches the beginning or end of buffer, it stops there.
4782 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4783 (interactive "^p")
4784 (or n (setq n 1))
4785 (let ((opoint (point)))
4786 (if (/= n 1)
4787 (let ((line-move-visual t))
4788 (line-move (1- n) t)))
4789 (vertical-motion 0)
4790 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4791 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4793 (defun kill-visual-line (&optional arg)
4794 "Kill the rest of the visual line.
4795 With prefix argument ARG, kill that many visual lines from point.
4796 If ARG is negative, kill visual lines backward.
4797 If ARG is zero, kill the text before point on the current visual
4798 line.
4800 If you want to append the killed line to the last killed text,
4803 If the buffer is read-only, Emacs will beep and refrain from deleting
4804 the line, but put the line in the kill ring anyway. This means that
4805 you can use this command to copy text from a read-only buffer.
4806 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4807 even beep.)"
4808 (interactive "P")
4809 ;; Like in `kill-line', it's better to move point to the other end
4810 ;; of the kill before killing.
4811 (let ((opoint (point))
4812 (kill-whole-line (and kill-whole-line (bolp))))
4813 (if arg
4814 (vertical-motion (prefix-numeric-value arg))
4815 (end-of-visual-line 1)
4816 (if (= (point) opoint)
4817 (vertical-motion 1)
4818 ;; Skip any trailing whitespace at the end of the visual line.
4819 ;; We used to do this only if `show-trailing-whitespace' is
4820 ;; nil, but that's wrong; the correct thing would be to check
4821 ;; whether the trailing whitespace is highlighted. But, it's
4822 ;; OK to just do this unconditionally.
4825 (1+ (point))
4826 (point)))))
4828 (defun next-logical-line (&optional arg try-vscroll)
4829 "Move cursor vertically down ARG lines.
4830 This is identical to `next-line', except that it always moves
4831 by logical lines instead of visual lines, ignoring the value of
4832 the variable `line-move-visual'."
4834 (let ((line-move-visual nil))
4835 (with-no-warnings
4836 (next-line arg try-vscroll))))
4838 (defun previous-logical-line (&optional arg try-vscroll)
4839 "Move cursor vertically up ARG lines.
4840 This is identical to `previous-line', except that it always moves
4841 by logical lines instead of visual lines, ignoring the value of
4842 the variable `line-move-visual'."
4844 (let ((line-move-visual nil))
4845 (with-no-warnings
4846 (previous-line arg try-vscroll))))
4848 (defgroup visual-line nil
4849 "Editing based on visual lines."
4850 :group 'convenience
4851 :version "23.1")
4853 (defvar visual-line-mode-map
4854 (let ((map (make-sparse-keymap)))
4855 (define-key map [remap kill-line] 'kill-visual-line)
4856 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4857 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4858 ;; These keybindings interfere with xterm function keys. Are
4859 ;; there any other suitable bindings?
4860 ;; (define-key map "\M-[" 'previous-logical-line)
4861 ;; (define-key map "\M-]" 'next-logical-line)
4862 map))
4864 (defcustom visual-line-fringe-indicators '(nil nil)
4865 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4866 The value should be a list of the form (LEFT RIGHT), where LEFT
4867 and RIGHT are symbols representing the bitmaps to display, to
4868 indicate wrapped lines, in the left and right fringes respectively.
4869 See also `fringe-indicator-alist'.
4870 The default is not to display fringe indicators for wrapped lines.
4871 This variable does not affect fringe indicators displayed for
4872 other purposes."
4873 :type '(list (choice (const :tag "Hide left indicator" nil)
4874 (const :tag "Left curly arrow" left-curly-arrow)
4875 (symbol :tag "Other bitmap"))
4876 (choice (const :tag "Hide right indicator" nil)
4877 (const :tag "Right curly arrow" right-curly-arrow)
4878 (symbol :tag "Other bitmap")))
4879 :set (lambda (symbol value)
4880 (dolist (buf (buffer-list))
4881 (with-current-buffer buf
4882 (when (and (boundp 'visual-line-mode)
4883 (symbol-value 'visual-line-mode))
4884 (setq fringe-indicator-alist
4885 (cons (cons 'continuation value)
4886 (assq-delete-all
4887 'continuation
4888 (copy-tree fringe-indicator-alist)))))))
4889 (set-default symbol value)))
4891 (defvar visual-line--saved-state nil)
4893 (define-minor-mode visual-line-mode
4894 "Redefine simple editing commands to act on visual lines, not logical lines.
4895 This also turns on `word-wrap' in the buffer."
4896 :keymap visual-line-mode-map
4897 :group 'visual-line
4898 :lighter " Wrap"
4899 (if visual-line-mode
4900 (progn
4901 (set (make-local-variable 'visual-line--saved-state) nil)
4902 ;; Save the local values of some variables, to be restored if
4903 ;; visual-line-mode is turned off.
4904 (dolist (var '(line-move-visual truncate-lines
4905 truncate-partial-width-windows
4906 word-wrap fringe-indicator-alist))
4907 (if (local-variable-p var)
4908 (push (cons var (symbol-value var))
4909 visual-line--saved-state)))
4910 (set (make-local-variable 'line-move-visual) t)
4911 (set (make-local-variable 'truncate-partial-width-windows) nil)
4912 (setq truncate-lines nil
4913 word-wrap t
4914 fringe-indicator-alist
4915 (cons (cons 'continuation visual-line-fringe-indicators)
4916 fringe-indicator-alist)))
4917 (kill-local-variable 'line-move-visual)
4918 (kill-local-variable 'word-wrap)
4919 (kill-local-variable 'truncate-lines)
4920 (kill-local-variable 'truncate-partial-width-windows)
4921 (kill-local-variable 'fringe-indicator-alist)
4922 (dolist (saved visual-line--saved-state)
4923 (set (make-local-variable (car saved)) (cdr saved)))
4924 (kill-local-variable 'visual-line--saved-state)))
4926 (defun turn-on-visual-line-mode ()
4927 (visual-line-mode 1))
4929 (define-globalized-minor-mode global-visual-line-mode
4930 visual-line-mode turn-on-visual-line-mode
4931 :lighter " vl")
4933 \f
4934 (defun transpose-chars (arg)
4935 "Interchange characters around point, moving forward one character.
4936 With prefix arg ARG, effect is to take character before point
4937 and drag it forward past ARG other characters (backward if ARG negative).
4938 If no argument and at end of line, the previous two chars are exchanged."
4939 (interactive "*P")
4940 (and (null arg) (eolp) (forward-char -1))
4941 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4943 (defun transpose-words (arg)
4944 "Interchange words around point, leaving point at end of them.
4945 With prefix arg ARG, effect is to take word before or around point
4946 and drag it forward past ARG other words (backward if ARG negative).
4947 If ARG is zero, the words around or after point and around or after mark
4948 are interchanged."
4949 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4950 (interactive "*p")
4951 (transpose-subr 'forward-word arg))
4953 (defun transpose-sexps (arg)
4955 Does not work on a sexp that point is in the middle of
4956 if it is a list or string."
4957 (interactive "*p")
4958 (transpose-subr
4959 (lambda (arg)
4960 ;; Here we should try to simulate the behavior of
4961 ;; (cons (progn (forward-sexp x) (point))
4962 ;; (progn (forward-sexp (- x)) (point)))
4963 ;; Except that we don't want to rely on the second forward-sexp
4964 ;; putting us back to where we want to be, since forward-sexp-function
4965 ;; might do funny things like infix-precedence.
4966 (if (if (> arg 0)
4968 (and (not (bobp))
4970 ;; Jumping over a symbol. We might be inside it, mind you.
4971 (progn (funcall (if (> arg 0)
4972 'skip-syntax-backward 'skip-syntax-forward)
4973 "w_")
4974 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4975 ;; Otherwise, we're between sexps. Take a step back before jumping
4976 ;; to make sure we'll obey the same precedence no matter which direction
4977 ;; we're going.
4978 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4979 (cons (save-excursion (forward-sexp arg) (point))
4980 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4981 (not (zerop (funcall (if (> arg 0)
4982 'skip-syntax-forward
4983 'skip-syntax-backward)
4984 ".")))))
4985 (point)))))
4986 arg 'special))
4988 (defun transpose-lines (arg)
4989 "Exchange current line and previous line, leaving point after both.
4990 With argument ARG, takes previous line and moves it past ARG lines.
4991 With argument 0, interchanges line point is in with line mark is in."
4992 (interactive "*p")
4993 (transpose-subr (function
4994 (lambda (arg)
4995 (if (> arg 0)
4996 (progn
4997 ;; Move forward over ARG lines,
4998 ;; but create newlines if necessary.
4999 (setq arg (forward-line arg))
5001 (setq arg (1+ arg)))
5002 (if (> arg 0)
5003 (newline arg)))
5004 (forward-line arg))))
5005 arg))
5007 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
5008 ;; which seems inconsistent with the ARG /= 0 case.
5009 ;; FIXME document SPECIAL.
5010 (defun transpose-subr (mover arg &optional special)
5011 "Subroutine to do the work of transposing objects.
5012 Works for lines, sentences, paragraphs, etc. MOVER is a function that
5013 moves forward by units of the given object (e.g. forward-sentence,
5014 forward-paragraph). If ARG is zero, exchanges the current object
5015 with the one containing mark. If ARG is an integer, moves the
5016 current object past ARG following (if ARG is positive) or
5017 preceding (if ARG is negative) objects, leaving point after the
5018 current object."
5019 (let ((aux (if special mover
5020 (lambda (x)
5021 (cons (progn (funcall mover x) (point))
5022 (progn (funcall mover (- x)) (point))))))
5023 pos1 pos2)
5024 (cond
5025 ((= arg 0)
5026 (save-excursion
5027 (setq pos1 (funcall aux 1))
5028 (goto-char (or (mark) (error "No mark set in this buffer")))
5029 (setq pos2 (funcall aux 1))
5030 (transpose-subr-1 pos1 pos2))
5031 (exchange-point-and-mark))
5032 ((> arg 0)
5033 (setq pos1 (funcall aux -1))
5034 (setq pos2 (funcall aux arg))
5035 (transpose-subr-1 pos1 pos2)
5036 (goto-char (car pos2)))
5037 (t
5038 (setq pos1 (funcall aux -1))
5039 (goto-char (car pos1))
5040 (setq pos2 (funcall aux arg))
5041 (transpose-subr-1 pos1 pos2)))))
5043 (defun transpose-subr-1 (pos1 pos2)
5044 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
5045 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
5046 (when (> (car pos1) (car pos2))
5047 (let ((swap pos1))
5048 (setq pos1 pos2 pos2 swap)))
5049 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
5050 (atomic-change-group
5051 (let (word2)
5052 ;; FIXME: We first delete the two pieces of text, so markers that
5053 ;; used to point to after the text end up pointing to before it :-(
5054 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
5055 (goto-char (car pos2))
5056 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
5057 (goto-char (car pos1))
5058 (insert word2))))
5059 \f
5060 (defun backward-word (&optional arg)
5061 "Move backward until encountering the beginning of a word.
5062 With argument ARG, do this that many times."
5063 (interactive "^p")
5064 (forward-word (- (or arg 1))))
5066 (defun mark-word (&optional arg allow-extend)
5067 "Set mark ARG words away from point.
5069 move to with the same argument.
5070 Interactively, if this command is repeated
5071 or (in Transient Mark mode) if the mark is active,
5072 it marks the next ARG words after the ones already marked."
5074 (cond ((and allow-extend
5075 (or (and (eq last-command this-command) (mark t))
5076 (region-active-p)))
5077 (setq arg (if arg (prefix-numeric-value arg)
5078 (if (< (mark) (point)) -1 1)))
5079 (set-mark
5080 (save-excursion
5081 (goto-char (mark))
5082 (forward-word arg)
5083 (point))))
5084 (t
5085 (push-mark
5086 (save-excursion
5087 (forward-word (prefix-numeric-value arg))
5088 (point))
5089 nil t))))
5091 (defun kill-word (arg)
5092 "Kill characters forward until encountering the end of a word.
5093 With argument ARG, do this that many times."
5094 (interactive "p")
5095 (kill-region (point) (progn (forward-word arg) (point))))
5097 (defun backward-kill-word (arg)
5098 "Kill characters backward until encountering the beginning of a word.
5099 With argument ARG, do this that many times."
5100 (interactive "p")
5101 (kill-word (- arg)))
5103 (defun current-word (&optional strict really-word)
5104 "Return the symbol or word that point is on (or a nearby one) as a string.
5105 The return value includes no text properties.
5106 If optional arg STRICT is non-nil, return nil unless point is within
5107 or adjacent to a symbol or word. In all cases the value can be nil
5108 if there is no word nearby.
5109 The function, belying its name, normally finds a symbol.
5110 If optional arg REALLY-WORD is non-nil, it finds just a word."
5111 (save-excursion
5112 (let* ((oldpoint (point)) (start (point)) (end (point))
5113 (syntaxes (if really-word "w" "w_"))
5114 (not-syntaxes (concat "^" syntaxes)))
5115 (skip-syntax-backward syntaxes) (setq start (point))
5116 (goto-char oldpoint)
5117 (skip-syntax-forward syntaxes) (setq end (point))
5118 (when (and (eq start oldpoint) (eq end oldpoint)
5119 ;; Point is neither within nor adjacent to a word.
5120 (not strict))
5121 ;; Look for preceding word in same line.
5122 (skip-syntax-backward not-syntaxes (line-beginning-position))
5123 (if (bolp)
5124 ;; No preceding word in same line.
5125 ;; Look for following word in same line.
5126 (progn
5127 (skip-syntax-forward not-syntaxes (line-end-position))
5128 (setq start (point))
5129 (skip-syntax-forward syntaxes)
5130 (setq end (point)))
5131 (setq end (point))
5132 (skip-syntax-backward syntaxes)
5133 (setq start (point))))
5134 ;; If we found something nonempty, return it as a string.
5135 (unless (= start end)
5136 (buffer-substring-no-properties start end)))))
5137 \f
5138 (defcustom fill-prefix nil
5139 "String for filling to insert at front of new line, or nil for none."
5140 :type '(choice (const :tag "None" nil)
5141 string)
5142 :group 'fill)
5143 (make-variable-buffer-local 'fill-prefix)
5144 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5146 (defcustom auto-fill-inhibit-regexp nil
5147 "Regexp to match lines which should not be auto-filled."
5148 :type '(choice (const :tag "None" nil)
5149 regexp)
5150 :group 'fill)
5152 (defun do-auto-fill ()
5153 "The default value for `normal-auto-fill-function'.
5154 This is the default auto-fill function, some major modes use a different one.
5155 Returns t if it really did any work."
5156 (let (fc justify give-up
5157 (fill-prefix fill-prefix))
5158 (if (or (not (setq justify (current-justification)))
5159 (null (setq fc (current-fill-column)))
5160 (and (eq justify 'left)
5161 (<= (current-column) fc))
5162 (and auto-fill-inhibit-regexp
5163 (save-excursion (beginning-of-line)
5164 (looking-at auto-fill-inhibit-regexp))))
5165 nil ;; Auto-filling not required
5166 (if (memq justify '(full center right))
5167 (save-excursion (unjustify-current-line)))
5169 ;; Choose a fill-prefix automatically.
5170 (when (and adaptive-fill-mode
5171 (or (null fill-prefix) (string= fill-prefix "")))
5172 (let ((prefix
5173 (fill-context-prefix
5174 (save-excursion (fill-forward-paragraph -1) (point))
5175 (save-excursion (fill-forward-paragraph 1) (point)))))
5176 (and prefix (not (equal prefix ""))
5177 ;; Use auto-indentation rather than a guessed empty prefix.
5178 (not (and fill-indent-according-to-mode
5180 (setq fill-prefix prefix))))
5182 (while (and (not give-up) (> (current-column) fc))
5183 ;; Determine where to split the line.
5184 (let* (after-prefix
5185 (fill-point
5186 (save-excursion
5187 (beginning-of-line)
5188 (setq after-prefix (point))
5189 (and fill-prefix
5190 (looking-at (regexp-quote fill-prefix))
5191 (setq after-prefix (match-end 0)))
5192 (move-to-column (1+ fc))
5193 (fill-move-to-break-point after-prefix)
5194 (point))))
5196 ;; See whether the place we found is any good.
5197 (if (save-excursion
5198 (goto-char fill-point)
5199 (or (bolp)
5200 ;; There is no use breaking at end of line.
5201 (save-excursion (skip-chars-forward " ") (eolp))
5202 ;; It is futile to split at the end of the prefix
5203 ;; since we would just insert the prefix again.
5204 (and after-prefix (<= (point) after-prefix))
5205 ;; Don't split right after a comment starter
5206 ;; since we would just make another comment starter.
5207 (and comment-start-skip
5208 (let ((limit (point)))
5209 (beginning-of-line)
5210 (and (re-search-forward comment-start-skip
5211 limit t)
5212 (eq (point) limit))))))
5213 ;; No good place to break => stop trying.
5214 (setq give-up t)
5215 ;; Ok, we have a useful place to break the line. Do it.
5216 (let ((prev-column (current-column)))
5217 ;; If point is at the fill-point, do not `save-excursion'.
5218 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5219 ;; point will end up before it rather than after it.
5220 (if (save-excursion
5222 (= (point) fill-point))
5223 (default-indent-new-line t)
5224 (save-excursion
5225 (goto-char fill-point)
5226 (default-indent-new-line t)))
5227 ;; Now do justification, if required
5228 (if (not (eq justify 'left))
5229 (save-excursion
5230 (end-of-line 0)
5231 (justify-current-line justify nil t)))
5232 ;; If making the new line didn't reduce the hpos of
5233 ;; the end of the line, then give up now;
5234 ;; trying again will not help.
5235 (if (>= (current-column) prev-column)
5236 (setq give-up t))))))
5237 ;; Justify last line.
5238 (justify-current-line justify t t)
5239 t)))
5241 (defvar comment-line-break-function 'comment-indent-new-line
5242 "*Mode-specific function which line breaks and continues a comment.
5243 This function is called during auto-filling when a comment syntax
5244 is defined.
5245 The function should take a single optional argument, which is a flag
5246 indicating whether it should use soft newlines.")
5248 (defun default-indent-new-line (&optional soft)
5249 "Break line at point and indent.
5250 If a comment syntax is defined, call `comment-indent-new-line'.
5252 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5253 unless optional argument SOFT is non-nil."
5254 (interactive)
5255 (if comment-start
5256 (funcall comment-line-break-function soft)
5257 ;; Insert the newline before removing empty space so that markers
5258 ;; get preserved better.
5260 (save-excursion (forward-char -1) (delete-horizontal-space))
5261 (delete-horizontal-space)
5263 (if (and fill-prefix (not adaptive-fill-mode))
5264 ;; Blindly trust a non-adaptive fill-prefix.
5265 (progn
5266 (indent-to-left-margin)
5267 (insert-before-markers-and-inherit fill-prefix))
5269 (cond
5270 ;; If there's an adaptive prefix, use it unless we're inside
5271 ;; a comment and the prefix is not a comment starter.
5272 (fill-prefix
5273 (indent-to-left-margin)
5274 (insert-and-inherit fill-prefix))
5275 ;; If we're not inside a comment, just try to indent.
5276 (t (indent-according-to-mode))))))
5278 (defvar normal-auto-fill-function 'do-auto-fill
5279 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5280 Some major modes set this.")
5282 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5283 ;; `functions' and `hooks' are usually unsafe to set, but setting
5284 ;; auto-fill-function to nil in a file-local setting is safe and
5285 ;; can be useful to prevent auto-filling.
5286 (put 'auto-fill-function 'safe-local-variable 'null)
5287 ;; FIXME: turn into a proper minor mode.
5288 ;; Add a global minor mode version of it.
5289 (define-minor-mode auto-fill-mode
5290 "Toggle Auto Fill mode.
5291 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5292 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5293 automatically breaks the line at a previous space.
5295 The value of `normal-auto-fill-function' specifies the function to use
5296 for `auto-fill-function' when turning Auto Fill mode on."
5297 :variable (eq auto-fill-function normal-auto-fill-function))
5299 ;; This holds a document string used to document auto-fill-mode.
5300 (defun auto-fill-function ()
5301 "Automatically break line at a previous space, in insertion of text."
5302 nil)
5304 (defun turn-on-auto-fill ()
5305 "Unconditionally turn on Auto Fill mode."
5306 (auto-fill-mode 1))
5308 (defun turn-off-auto-fill ()
5309 "Unconditionally turn off Auto Fill mode."
5310 (auto-fill-mode -1))
5312 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5314 (defun set-fill-column (arg)
5315 "Set `fill-column' to specified argument.
5318 (interactive
5319 (list (or current-prefix-arg
5320 ;; We used to use current-column silently, but C-x f is too easily
5321 ;; typed as a typo for C-x C-f, so we turned it into an error and
5322 ;; now an interactive prompt.
5323 (read-number "Set fill-column to: " (current-column)))))
5324 (if (consp arg)
5325 (setq arg (current-column)))
5326 (if (not (integerp arg))
5327 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5328 (error "set-fill-column requires an explicit argument")
5329 (message "Fill column set to %d (was %d)" arg fill-column)
5330 (setq fill-column arg)))
5331 \f
5332 (defun set-selective-display (arg)
5333 "Set `selective-display' to ARG; clear it if no arg.
5334 When the value of `selective-display' is a number > 0,
5335 lines whose indentation is >= that value are not displayed.
5336 The variable `selective-display' has a separate value for each buffer."
5337 (interactive "P")
5338 (if (eq selective-display t)
5339 (error "selective-display already in use for marked lines"))
5340 (let ((current-vpos
5341 (save-restriction
5342 (narrow-to-region (point-min) (point))
5343 (goto-char (window-start))
5344 (vertical-motion (window-height)))))
5345 (setq selective-display
5346 (and arg (prefix-numeric-value arg)))
5347 (recenter current-vpos))
5348 (set-window-start (selected-window) (window-start (selected-window)))
5349 (princ "selective-display set to " t)
5350 (prin1 selective-display t)
5351 (princ "." t))
5353 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5355 (defun toggle-truncate-lines (&optional arg)
5356 "Toggle whether to fold or truncate long lines for the current buffer.
5357 With prefix argument ARG, truncate long lines if ARG is positive,
5358 otherwise don't truncate them. Note that in side-by-side windows,
5359 this command has no effect if `truncate-partial-width-windows'
5360 is non-nil."
5361 (interactive "P")
5362 (setq truncate-lines
5363 (if (null arg)
5364 (not truncate-lines)
5365 (> (prefix-numeric-value arg) 0)))
5366 (force-mode-line-update)
5367 (unless truncate-lines
5368 (let ((buffer (current-buffer)))
5369 (walk-windows (lambda (window)
5370 (if (eq buffer (window-buffer window))
5371 (set-window-hscroll window 0)))
5372 nil t)))
5373 (message "Truncate long lines %s"
5374 (if truncate-lines "enabled" "disabled")))
5376 (defun toggle-word-wrap (&optional arg)
5377 "Toggle whether to use word-wrapping for continuation lines.
5378 With prefix argument ARG, wrap continuation lines at word boundaries
5379 if ARG is positive, otherwise wrap them at the right screen edge.
5380 This command toggles the value of `word-wrap'. It has no effect
5381 if long lines are truncated."
5382 (interactive "P")
5383 (setq word-wrap
5384 (if (null arg)
5385 (not word-wrap)
5386 (> (prefix-numeric-value arg) 0)))
5387 (force-mode-line-update)
5388 (message "Word wrapping %s"
5389 (if word-wrap "enabled" "disabled")))
5391 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5392 "The string displayed in the mode line when in overwrite mode.")
5393 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5394 "The string displayed in the mode line when in binary overwrite mode.")
5396 (define-minor-mode overwrite-mode
5397 "Toggle overwrite mode.
5398 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5399 otherwise turn it off. In overwrite mode, printing characters typed
5400 in replace existing text on a one-for-one basis, rather than pushing
5401 it to the right. At the end of a line, such characters extend the line.
5402 Before a tab, such characters insert until the tab is filled in.
5404 is supposed to make it easier to insert characters when necessary."
5405 :variable (eq overwrite-mode 'overwrite-mode-textual))
5407 (define-minor-mode binary-overwrite-mode
5408 "Toggle binary overwrite mode.
5409 With prefix argument ARG, turn binary overwrite mode on if ARG is
5410 positive, otherwise turn it off. In binary overwrite mode, printing
5411 characters typed in replace existing text. Newlines are not treated
5412 specially, so typing at the end of a line joins the line to the next,
5413 with the typed character between them. Typing before a tab character
5415 replaces the text at the cursor, just as ordinary typing characters do.
5417 Note that binary overwrite mode is not its own minor mode; it is a
5418 specialization of overwrite mode, entered by setting the
5419 `overwrite-mode' variable to `overwrite-mode-binary'."
5420 :variable (eq overwrite-mode 'overwrite-mode-binary))
5422 (define-minor-mode line-number-mode
5423 "Toggle Line Number mode.
5424 With ARG, turn Line Number mode on if ARG is positive, otherwise
5425 turn it off. When Line Number mode is enabled, the line number
5426 appears in the mode line.
5428 Line numbers do not appear for very large buffers and buffers
5429 with very long lines; see variables `line-number-display-limit'
5430 and `line-number-display-limit-width'."
5431 :init-value t :global t :group 'mode-line)
5433 (define-minor-mode column-number-mode
5434 "Toggle Column Number mode.
5435 With ARG, turn Column Number mode on if ARG is positive,
5436 otherwise turn it off. When Column Number mode is enabled, the
5437 column number appears in the mode line."
5438 :global t :group 'mode-line)
5440 (define-minor-mode size-indication-mode
5441 "Toggle Size Indication mode.
5442 With ARG, turn Size Indication mode on if ARG is positive,
5443 otherwise turn it off. When Size Indication mode is enabled, the
5444 size of the accessible part of the buffer appears in the mode line."
5445 :global t :group 'mode-line)
5447 (define-minor-mode auto-save-mode
5448 "Toggle auto-saving of contents of current buffer.
5449 With prefix argument ARG, turn auto-saving on if positive, else off."
5450 :variable ((and buffer-auto-save-file-name
5451 ;; If auto-save is off because buffer has shrunk,
5452 ;; then toggling should turn it on.
5453 (>= buffer-saved-size 0))
5454 . (lambda (val)
5455 (setq buffer-auto-save-file-name
5456 (cond
5457 ((null val) nil)
5458 ((and buffer-file-name auto-save-visited-file-name
5459 (not buffer-read-only))
5460 buffer-file-name)
5461 (t (make-auto-save-file-name))))))
5462 ;; If -1 was stored here, to temporarily turn off saving,
5463 ;; turn it back on.
5464 (and (< buffer-saved-size 0)
5465 (setq buffer-saved-size 0)))
5466 \f
5467 (defgroup paren-blinking nil
5468 "Blinking matching of parens and expressions."
5469 :prefix "blink-matching-"
5470 :group 'paren-matching)
5472 (defcustom blink-matching-paren t
5473 "Non-nil means show matching open-paren when close-paren is inserted."
5474 :type 'boolean
5475 :group 'paren-blinking)
5477 (defcustom blink-matching-paren-on-screen t
5478 "Non-nil means show matching open-paren when it is on screen.
5479 If nil, don't show it (but the open-paren can still be shown
5480 when it is off screen).
5482 This variable has no effect if `blink-matching-paren' is nil.
5483 \(In that case, the open-paren is never shown.)
5484 It is also ignored if `show-paren-mode' is enabled."
5485 :type 'boolean
5486 :group 'paren-blinking)
5488 (defcustom blink-matching-paren-distance (* 100 1024)
5489 "If non-nil, maximum distance to search backwards for matching open-paren.
5490 If nil, search stops at the beginning of the accessible portion of the buffer."
5491 :version "23.2" ; 25->100k
5492 :type '(choice (const nil) integer)
5493 :group 'paren-blinking)
5495 (defcustom blink-matching-delay 1
5496 "Time in seconds to delay after showing a matching paren."
5497 :type 'number
5498 :group 'paren-blinking)
5500 (defcustom blink-matching-paren-dont-ignore-comments nil
5501 "If nil, `blink-matching-paren' ignores comments.
5502 More precisely, when looking for the matching parenthesis,
5503 it skips the contents of comments that end before point."
5504 :type 'boolean
5505 :group 'paren-blinking)
5507 (defun blink-matching-check-mismatch (start end)
5508 "Return whether or not START...END are matching parens.
5509 END is the current point and START is the blink position.
5510 START might be nil if no matching starter was found.
5511 Returns non-nil if we find there is a mismatch."
5512 (let* ((end-syntax (syntax-after (1- end)))
5513 (matching-paren (and (consp end-syntax)
5514 (eq (syntax-class end-syntax) 5)
5515 (cdr end-syntax))))
5516 ;; For self-matched chars like " and $, we can't know when they're
5517 ;; mismatched or unmatched, so we can only do it for parens.
5518 (when matching-paren
5519 (not (and start
5520 (or
5521 (eq (char-after start) matching-paren)
5522 ;; The cdr might hold a new paren-class info rather than
5523 ;; a matching-char info, in which case the two CDRs
5524 ;; should match.
5525 (eq matching-paren (cdr-safe (syntax-after start)))))))))
5527 (defvar blink-matching-check-function #'blink-matching-check-mismatch
5528 "Function to check parentheses mismatches.
5529 The function takes two arguments (START and END) where START is the
5530 position just before the opening token and END is the position right after.
5531 START can be nil, if it was not found.
5532 The function should return non-nil if the two tokens do not match.")
5534 (defun blink-matching-open ()
5535 "Move cursor momentarily to the beginning of the sexp before point."
5536 (interactive)
5537 (when (and (not (bobp))
5538 blink-matching-paren)
5539 (let* ((oldpos (point))
5540 (message-log-max nil) ; Don't log messages about paren matching.
5541 (blinkpos
5542 (save-excursion
5543 (save-restriction
5544 (if blink-matching-paren-distance
5545 (narrow-to-region
5546 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5547 (- (point) blink-matching-paren-distance))
5548 oldpos))
5549 (let ((parse-sexp-ignore-comments
5550 (and parse-sexp-ignore-comments
5551 (not blink-matching-paren-dont-ignore-comments))))
5552 (condition-case ()
5553 (progn
5554 (forward-sexp -1)
5555 ;; backward-sexp skips backward over prefix chars,
5556 ;; so move back to the matching paren.
5557 (while (and (< (point) (1- oldpos))
5558 (let ((code (syntax-after (point))))
5559 (or (eq (syntax-class code) 6)
5560 (eq (logand 1048576 (car code))
5561 1048576))))
5562 (forward-char 1))
5563 (point))
5564 (error nil))))))
5565 (mismatch (funcall blink-matching-check-function blinkpos oldpos)))
5566 (cond
5567 (mismatch
5568 (if blinkpos
5569 (if (minibufferp)
5570 (minibuffer-message "Mismatched parentheses")
5571 (message "Mismatched parentheses"))
5572 (if (minibufferp)
5573 (minibuffer-message "Unmatched parenthesis")
5574 (message "Unmatched parenthesis"))))
5575 ((not blinkpos) nil)
5576 ((pos-visible-in-window-p blinkpos)
5577 ;; Matching open within window, temporarily move to blinkpos but only
5578 ;; if `blink-matching-paren-on-screen' is non-nil.
5579 (and blink-matching-paren-on-screen
5580 (not show-paren-mode)
5581 (save-excursion
5582 (goto-char blinkpos)
5583 (sit-for blink-matching-delay))))
5584 (t
5585 (save-excursion
5586 (goto-char blinkpos)
5587 (let ((open-paren-line-string
5588 ;; Show what precedes the open in its line, if anything.
5589 (cond
5591 (buffer-substring (line-beginning-position)
5592 (1+ blinkpos)))
5593 ;; Show what follows the open in its line, if anything.
5594 ((save-excursion
5595 (forward-char 1)
5597 (not (eolp)))
5598 (buffer-substring blinkpos
5599 (line-end-position)))
5600 ;; Otherwise show the previous nonblank line,
5601 ;; if there is one.
5603 (concat
5604 (buffer-substring (progn
5606 (line-beginning-position))
5607 (progn (end-of-line)
5609 (point)))
5610 ;; Replace the newline and other whitespace with `...'.
5611 "..."
5612 (buffer-substring blinkpos (1+ blinkpos))))
5613 ;; There is nothing to show except the char itself.
5614 (t (buffer-substring blinkpos (1+ blinkpos))))))
5615 (message "Matches %s"
5616 (substring-no-properties open-paren-line-string)))))))))
5618 (defvar blink-paren-function 'blink-matching-open
5619 "Function called, if non-nil, whenever a close parenthesis is inserted.
5620 More precisely, a char with closeparen syntax is self-inserted.")
5622 (defun blink-paren-post-self-insert-function ()
5623 (when (and (eq (char-before) last-command-event) ; Sanity check.
5624 (memq (char-syntax last-command-event) '(?\) ?\$))
5625 blink-paren-function
5626 (not executing-kbd-macro)
5627 (not noninteractive)
5628 ;; Verify an even number of quoting characters precede the close.
5629 (= 1 (logand 1 (- (point)
5630 (save-excursion
5631 (forward-char -1)
5633 (point))))))
5634 (funcall blink-paren-function)))
5636 (add-hook 'post-self-insert-hook #'blink-paren-post-self-insert-function
5637 ;; Most likely, this hook is nil, so this arg doesn't matter,
5638 ;; but I use it as a reminder that this function usually
5639 ;; likes to be run after others since it does `sit-for'.
5640 'append)
5641 \f
5642 ;; This executes C-g typed while Emacs is waiting for a command.
5643 ;; Quitting out of a program does not go through here;
5644 ;; that happens in the QUIT macro at the C code level.
5645 (defun keyboard-quit ()
5646 "Signal a `quit' condition.
5647 During execution of Lisp code, this character causes a quit directly.
5648 At top-level, as an editor command, this simply beeps."
5649 (interactive)
5650 ;; Avoid adding the region to the window selection.
5651 (setq saved-region-selection nil)
5652 (let (select-active-regions)
5653 (deactivate-mark))
5654 (if (fboundp 'kmacro-keyboard-quit)
5655 (kmacro-keyboard-quit))
5656 (setq defining-kbd-macro nil)
5657 (let ((debug-on-quit nil))
5658 (signal 'quit nil)))
5660 (defvar buffer-quit-function nil
5663 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5665 (defun keyboard-escape-quit ()
5667 This command can exit an interactive command such as `query-replace',
5668 can clear out a prefix argument or a region,
5669 can get out of the minibuffer or other recursive edit,
5670 cancel the use of the current buffer (for special-purpose buffers),
5671 or go back to just one window (by deleting all but the selected window)."
5672 (interactive)
5673 (cond ((eq last-command 'mode-exited) nil)
5674 ((region-active-p)
5675 (deactivate-mark))
5676 ((> (minibuffer-depth) 0)
5677 (abort-recursive-edit))
5678 (current-prefix-arg
5679 nil)
5680 ((> (recursion-depth) 0)
5681 (exit-recursive-edit))
5682 (buffer-quit-function
5683 (funcall buffer-quit-function))
5684 ((not (one-window-p t))
5685 (delete-other-windows))
5687 (bury-buffer))))
5689 (defun play-sound-file (file &optional volume device)
5690 "Play sound stored in FILE.
5691 VOLUME and DEVICE correspond to the keywords of the sound
5692 specification for `play-sound'."
5693 (interactive "fPlay sound file: ")
5694 (let ((sound (list :file file)))
5695 (if volume
5696 (plist-put sound :volume volume))
5697 (if device
5698 (plist-put sound :device device))
5699 (push 'sound sound)
5700 (play-sound sound)))
5702 \f
5703 (defcustom read-mail-command 'rmail
5704 "Your preference for a mail reading package.
5705 This is used by some keybindings which support reading mail.
5706 See also `mail-user-agent' concerning sending mail."
5709 (function-item :tag "Emacs interface to MH"
5711 (function :tag "Other"))
5712 :version "21.1"
5713 :group 'mail)
5715 (defcustom mail-user-agent 'message-user-agent
5716 "Your preference for a mail composition package.
5717 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5718 outgoing email message. This variable lets you specify which
5719 mail-sending package you prefer.
5721 Valid values include:
5723 `message-user-agent' -- use the Message package.
5724 See Info node `(message)'.
5725 `sendmail-user-agent' -- use the Mail package.
5726 See Info node `(emacs)Sending Mail'.
5727 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5728 See Info node `(mh-e)'.
5729 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5730 paraphernalia, particularly the Gcc: header for
5731 archiving.
5733 Additional valid symbols may be available; check with the author of
5734 your package for details. The function should return non-nil if it
5735 succeeds.
5737 See also `read-mail-command' concerning reading mail."
5738 :type '(radio (function-item :tag "Message package"
5740 message-user-agent)
5741 (function-item :tag "Mail package"
5743 sendmail-user-agent)
5744 (function-item :tag "Emacs interface to MH"
5746 mh-e-user-agent)
5747 (function-item :tag "Message with full Gnus features"
5749 gnus-user-agent)
5750 (function :tag "Other"))
5751 :version "23.2" ; sendmail->message
5752 :group 'mail)
5754 (defcustom compose-mail-user-agent-warnings t
5755 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5756 If the value of `mail-user-agent' is the default, and the user
5757 appears to have customizations applying to the old default,
5758 `compose-mail' issues a warning."
5759 :type 'boolean
5760 :version "23.2"
5761 :group 'mail)
5763 (defun rfc822-goto-eoh ()
5764 "If the buffer starts with a mail header, move point to the header's end.
5765 Otherwise, moves to `point-min'.
5766 The end of the header is the start of the next line, if there is one,
5767 else the end of the last line. This function obeys RFC822."
5768 (goto-char (point-min))
5769 (when (re-search-forward
5771 (goto-char (match-beginning 0))))
5773 (defun compose-mail (&optional to subject other-headers continue
5774 switch-function yank-action send-actions
5775 return-action)
5776 "Start composing a mail message to send.
5777 This uses the user's chosen mail composition package
5778 as selected with the variable `mail-user-agent'.
5779 The optional arguments TO and SUBJECT specify recipients
5780 and the initial Subject field, respectively.
5782 OTHER-HEADERS is an alist specifying additional
5783 header fields. Elements look like (HEADER . VALUE) where both
5784 HEADER and VALUE are strings.
5786 CONTINUE, if non-nil, says to continue editing a message already
5787 being composed. Interactively, CONTINUE is the prefix argument.
5789 SWITCH-FUNCTION, if non-nil, is a function to use to
5790 switch to and display the buffer used for mail composition.
5792 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5793 to insert the raw text of the message being replied to.
5794 It has the form (FUNCTION . ARGS). The user agent will apply
5795 FUNCTION to ARGS, to insert the raw text of the original message.
5796 \(The user agent will also run `mail-citation-hook', *after* the
5797 original text has been inserted in this way.)
5799 SEND-ACTIONS is a list of actions to call when the message is sent.
5800 Each action has the form (FUNCTION . ARGS).
5802 RETURN-ACTION, if non-nil, is an action for returning to the
5803 caller. It has the form (FUNCTION . ARGS). The function is
5804 called after the mail has been sent or put aside, and the mail
5805 buffer buried."
5806 (interactive
5807 (list nil nil nil current-prefix-arg))
5809 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5810 ;; from sendmail-user-agent to message-user-agent. Some users may
5811 ;; encounter incompatibilities. This hack tries to detect problems
5812 ;; and warn about them.
5813 (and compose-mail-user-agent-warnings
5814 (eq mail-user-agent 'message-user-agent)
5815 (let (warn-vars)
5816 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5817 mail-yank-hooks mail-archive-file-name
5818 mail-default-reply-to mail-mailing-lists
5819 mail-self-blind))
5820 (and (boundp var)
5821 (symbol-value var)
5822 (push var warn-vars)))
5823 (when warn-vars
5824 (display-warning 'mail
5825 (format "\
5826 The default mail mode is now Message mode.
5827 You have the following Mail mode variable%s customized:
5829 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5830 (if (> (length warn-vars) 1) "s" "")
5831 (mapconcat 'symbol-name
5832 warn-vars " "))))))
5834 (let ((function (get mail-user-agent 'composefunc)))
5835 (funcall function to subject other-headers continue switch-function
5836 yank-action send-actions return-action)))
5838 (defun compose-mail-other-window (&optional to subject other-headers continue
5839 yank-action send-actions
5840 return-action)
5842 (interactive (list nil nil nil current-prefix-arg))
5843 (compose-mail to subject other-headers continue
5844 'switch-to-buffer-other-window yank-action send-actions
5845 return-action))
5847 (defun compose-mail-other-frame (&optional to subject other-headers continue
5848 yank-action send-actions
5849 return-action)
5851 (interactive (list nil nil nil current-prefix-arg))
5852 (compose-mail to subject other-headers continue
5853 'switch-to-buffer-other-frame yank-action send-actions
5854 return-action))
5856 \f
5857 (defvar set-variable-value-history nil
5858 "History of values entered with `set-variable'.
5860 Maximum length of the history list is determined by the value
5861 of `history-length', which see.")
5863 (defun set-variable (variable value &optional make-local)
5864 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5865 VARIABLE should be a user option variable name, a Lisp variable
5866 meant to be customized by users. You should enter VALUE in Lisp syntax,
5867 so if you want VALUE to be a string, you must surround it with doublequotes.
5868 VALUE is used literally, not evaluated.
5870 If VARIABLE has a `variable-interactive' property, that is used as if
5871 it were the arg to `interactive' (which see) to interactively read VALUE.
5873 If VARIABLE has been defined with `defcustom', then the type information
5874 in the definition is used to check that VALUE is valid.
5876 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5877 (interactive
5878 (let* ((default-var (variable-at-point))
5879 (var (if (user-variable-p default-var)
5880 (read-variable (format "Set variable (default %s): " default-var)
5881 default-var)
5882 (read-variable "Set variable: ")))
5883 (minibuffer-help-form '(describe-variable var))
5884 (prop (get var 'variable-interactive))
5885 (obsolete (car (get var 'byte-obsolete-variable)))
5886 (prompt (format "Set %s %s to value: " var
5887 (cond ((local-variable-p var)
5888 "(buffer-local)")
5889 ((or current-prefix-arg
5890 (local-variable-if-set-p var))
5891 "buffer-locally")
5892 (t "globally"))))
5893 (val (progn
5894 (when obsolete
5895 (message (concat "`%S' is obsolete; "
5896 (if (symbolp obsolete) "use `%S' instead" "%s"))
5897 var obsolete)
5898 (sit-for 3))
5899 (if prop
5900 ;; Use VAR's `variable-interactive' property
5901 ;; as an interactive spec for prompting.
5902 (call-interactively `(lambda (arg)
5903 (interactive ,prop)
5904 arg))
5905 (read
5906 (read-string prompt nil
5907 'set-variable-value-history
5908 (format "%S" (symbol-value var))))))))
5909 (list var val current-prefix-arg)))
5911 (and (custom-variable-p variable)
5912 (not (get variable 'custom-type))
5913 (custom-load-symbol variable))
5914 (let ((type (get variable 'custom-type)))
5915 (when type
5916 ;; Match with custom type.
5917 (require 'cus-edit)
5918 (setq type (widget-convert type))
5919 (unless (widget-apply type :match value)
5920 (error "Value `%S' does not match type %S of %S"
5921 value (car type) variable))))
5923 (if make-local
5924 (make-local-variable variable))
5926 (set variable value)
5928 ;; Force a thorough redisplay for the case that the variable
5929 ;; has an effect on the display, like `tab-width' has.
5930 (force-mode-line-update))
5931 \f
5932 ;; Define the major mode for lists of completions.
5934 (defvar completion-list-mode-map
5935 (let ((map (make-sparse-keymap)))
5936 (define-key map [mouse-2] 'mouse-choose-completion)
5937 (define-key map [follow-link] 'mouse-face)
5938 (define-key map [down-mouse-2] nil)
5939 (define-key map "\C-m" 'choose-completion)
5940 (define-key map "\e\e\e" 'delete-completion-window)
5941 (define-key map [left] 'previous-completion)
5942 (define-key map [right] 'next-completion)
5943 (define-key map "q" 'quit-window)
5944 (define-key map "z" 'kill-this-buffer)
5945 map)
5946 "Local map for completion list buffers.")
5948 ;; Completion mode is suitable only for specially formatted data.
5949 (put 'completion-list-mode 'mode-class 'special)
5951 (defvar completion-reference-buffer nil
5952 "Record the buffer that was current when the completion list was requested.
5953 This is a local variable in the completion list buffer.
5954 Initial value is nil to avoid some compiler warnings.")
5956 (defvar completion-no-auto-exit nil
5957 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5958 This also applies to other functions such as `choose-completion'.")
5960 (defvar completion-base-position nil
5961 "Position of the base of the text corresponding to the shown completions.
5962 This variable is used in the *Completions* buffers.
5963 Its value is a list of the form (START END) where START is the place
5964 where the completion should be inserted and END (if non-nil) is the end
5965 of the text to replace. If END is nil, point is used instead.")
5967 (defvar completion-list-insert-choice-function #'completion--replace
5968 "Function to use to insert the text chosen in *Completions*.
5969 Called with 3 arguments (BEG END TEXT), it should replace the text
5970 between BEG and END with TEXT. Expected to be set buffer-locally
5971 in the *Completions* buffer.")
5973 (defvar completion-base-size nil
5974 "Number of chars before point not involved in completion.
5975 This is a local variable in the completion list buffer.
5976 It refers to the chars in the minibuffer if completing in the
5977 minibuffer, or in `completion-reference-buffer' otherwise.
5978 Only characters in the field at point are included.
5980 If nil, Emacs determines which part of the tail end of the
5981 buffer's text is involved in completion by comparing the text
5982 directly.")
5983 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5985 (defun delete-completion-window ()
5986 "Delete the completion list window.
5987 Go to the window from which completion was requested."
5988 (interactive)
5989 (let ((buf completion-reference-buffer))
5990 (if (one-window-p t)
5991 (if (window-dedicated-p (selected-window))
5992 (delete-frame (selected-frame)))
5993 (delete-window (selected-window))
5994 (if (get-buffer-window buf)
5995 (select-window (get-buffer-window buf))))))
5997 (defun previous-completion (n)
5998 "Move to the previous item in the completion list."
5999 (interactive "p")
6000 (next-completion (- n)))
6002 (defun next-completion (n)
6003 "Move to the next item in the completion list.
6004 With prefix argument N, move N items (negative N means move backward)."
6005 (interactive "p")
6006 (let ((beg (point-min)) (end (point-max)))
6007 (while (and (> n 0) (not (eobp)))
6008 ;; If in a completion, move to the end of it.
6009 (when (get-text-property (point) 'mouse-face)
6010 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6011 ;; Move to start of next one.
6012 (unless (get-text-property (point) 'mouse-face)
6013 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
6014 (setq n (1- n)))
6015 (while (and (< n 0) (not (bobp)))
6016 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
6017 ;; If in a completion, move to the start of it.
6018 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
6019 (goto-char (previous-single-property-change
6020 (point) 'mouse-face nil beg)))
6021 ;; Move to end of the previous completion.
6022 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
6023 (goto-char (previous-single-property-change
6024 (point) 'mouse-face nil beg)))
6025 ;; Move to the start of that one.
6026 (goto-char (previous-single-property-change
6027 (point) 'mouse-face nil beg))
6028 (setq n (1+ n))))))
6030 (defun choose-completion (&optional event)
6031 "Choose the completion at point."
6032 (interactive (list last-nonmenu-event))
6033 ;; In case this is run via the mouse, give temporary modes such as
6034 ;; isearch a chance to turn off.
6035 (run-hooks 'mouse-leave-buffer-hook)
6036 (with-current-buffer (window-buffer (posn-window (event-start event)))
6037 (let ((buffer completion-reference-buffer)
6038 (base-size completion-base-size)
6039 (base-position completion-base-position)
6040 (insert-function completion-list-insert-choice-function)
6041 (choice
6042 (save-excursion
6043 (goto-char (posn-point (event-start event)))
6044 (let (beg end)
6045 (cond
6046 ((and (not (eobp)) (get-text-property (point) 'mouse-face))
6047 (setq end (point) beg (1+ (point))))
6048 ((and (not (bobp))
6049 (get-text-property (1- (point)) 'mouse-face))
6050 (setq end (1- (point)) beg (point)))
6051 (t (error "No completion here")))
6052 (setq beg (previous-single-property-change beg 'mouse-face))
6053 (setq end (or (next-single-property-change end 'mouse-face)
6054 (point-max)))
6055 (buffer-substring-no-properties beg end))))
6056 (owindow (selected-window)))
6058 (unless (buffer-live-p buffer)
6059 (error "Destination buffer is dead"))
6060 (select-window (posn-window (event-start event)))
6061 (if (and (one-window-p t 'selected-frame)
6062 (window-dedicated-p (selected-window)))
6063 ;; This is a special buffer's frame
6064 (iconify-frame (selected-frame))
6065 (or (window-dedicated-p (selected-window))
6066 (bury-buffer)))
6067 (select-window
6068 (or (get-buffer-window buffer 0)
6069 owindow))
6071 (with-current-buffer buffer
6072 (choose-completion-string
6073 choice buffer
6074 (or base-position
6075 (when base-size
6076 ;; Someone's using old completion code that doesn't know
6077 ;; about base-position yet.
6078 (list (+ base-size (field-beginning))))
6079 ;; If all else fails, just guess.
6080 (list (choose-completion-guess-base-position choice)))
6081 insert-function)))))
6083 ;; Delete the longest partial match for STRING
6084 ;; that can be found before POINT.
6085 (defun choose-completion-guess-base-position (string)
6086 (save-excursion
6087 (let ((opoint (point))
6088 len)
6089 ;; Try moving back by the length of the string.
6090 (goto-char (max (- (point) (length string))
6091 (minibuffer-prompt-end)))
6092 ;; See how far back we were actually able to move. That is the
6093 ;; upper bound on how much we can match and delete.
6094 (setq len (- opoint (point)))
6095 (if completion-ignore-case
6096 (setq string (downcase string)))
6097 (while (and (> len 0)
6098 (let ((tail (buffer-substring (point) opoint)))
6099 (if completion-ignore-case
6100 (setq tail (downcase tail)))
6101 (not (string= tail (substring string 0 len)))))
6102 (setq len (1- len))
6103 (forward-char 1))
6104 (point))))
6106 (defun choose-completion-delete-max-match (string)
6107 (delete-region (choose-completion-guess-base-position string) (point)))
6108 (make-obsolete 'choose-completion-delete-max-match
6109 'choose-completion-guess-base-position "23.2")
6111 (defvar choose-completion-string-functions nil
6112 "Functions that may override the normal insertion of a completion choice.
6113 These functions are called in order with four arguments:
6114 CHOICE - the string to insert in the buffer,
6115 BUFFER - the buffer in which the choice should be inserted,
6116 MINI-P - non-nil if BUFFER is a minibuffer, and
6117 BASE-SIZE - the number of characters in BUFFER before
6118 the string being completed.
6120 If a function in the list returns non-nil, that function is supposed
6121 to have inserted the CHOICE in the BUFFER, and possibly exited
6122 the minibuffer; no further functions will be called.
6124 If all functions in the list return nil, that means to use
6125 the default method of inserting the completion in BUFFER.")
6127 (defun choose-completion-string (choice &optional
6128 buffer base-position insert-function)
6129 "Switch to BUFFER and insert the completion choice CHOICE.
6130 BASE-POSITION, says where to insert the completion."
6132 ;; If BUFFER is the minibuffer, exit the minibuffer
6133 ;; unless it is reading a file name and CHOICE is a directory,
6134 ;; or completion-no-auto-exit is non-nil.
6136 ;; Some older code may call us passing `base-size' instead of
6137 ;; `base-position'. It's difficult to make any use of `base-size',
6138 ;; so we just ignore it.
6139 (unless (consp base-position)
6140 (message "Obsolete `base-size' passed to choose-completion-string")
6141 (setq base-position nil))
6143 (let* ((buffer (or buffer completion-reference-buffer))
6144 (mini-p (minibufferp buffer)))
6145 ;; If BUFFER is a minibuffer, barf unless it's the currently
6146 ;; active minibuffer.
6147 (if (and mini-p
6148 (not (and (active-minibuffer-window)
6149 (equal buffer
6150 (window-buffer (active-minibuffer-window))))))
6151 (error "Minibuffer is not active for completion")
6152 ;; Set buffer so buffer-local choose-completion-string-functions works.
6153 (set-buffer buffer)
6154 (unless (run-hook-with-args-until-success
6155 'choose-completion-string-functions
6156 ;; The fourth arg used to be `mini-p' but was useless
6157 ;; (since minibufferp can be used on the `buffer' arg)
6158 ;; and indeed unused. The last used to be `base-size', so we
6159 ;; keep it to try and avoid breaking old code.
6160 choice buffer base-position nil)
6161 ;; This remove-text-properties should be unnecessary since `choice'
6162 ;; comes from buffer-substring-no-properties.
6163 ;;(remove-text-properties 0 (lenth choice) '(mouse-face nil) choice)
6164 ;; Insert the completion into the buffer where it was requested.
6165 (funcall (or insert-function completion-list-insert-choice-function)
6166 (or (car base-position) (point))
6167 (or (cadr base-position) (point))
6168 choice)
6169 ;; Update point in the window that BUFFER is showing in.
6170 (let ((window (get-buffer-window buffer t)))
6171 (set-window-point window (point)))
6172 ;; If completing for the minibuffer, exit it with this choice.
6173 (and (not completion-no-auto-exit)
6174 (minibufferp buffer)
6175 minibuffer-completion-table
6176 ;; If this is reading a file name, and the file name chosen
6177 ;; is a directory, don't exit the minibuffer.
6178 (let* ((result (buffer-substring (field-beginning) (point)))
6179 (bounds
6180 (completion-boundaries result minibuffer-completion-table
6181 minibuffer-completion-predicate
6182 "")))
6183 (if (eq (car bounds) (length result))
6184 ;; The completion chosen leads to a new set of completions
6185 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6186 (let ((mini (active-minibuffer-window)))
6187 (select-window mini)
6188 (when minibuffer-auto-raise
6189 (raise-frame (window-frame mini))))
6190 (exit-minibuffer))))))))
6192 (define-derived-mode completion-list-mode nil "Completion List"
6193 "Major mode for buffers showing lists of possible completions.
6195 to select the completion near point.
6197 with the mouse.
6200 (set (make-local-variable 'completion-base-size) nil))
6202 (defun completion-list-mode-finish ()
6203 "Finish setup of the completions buffer.
6204 Called from `temp-buffer-show-hook'."
6205 (when (eq major-mode 'completion-list-mode)
6206 (toggle-read-only 1)))
6208 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6211 ;; Variables and faces used in `completion-setup-function'.
6213 (defcustom completion-show-help t
6214 "Non-nil means show help message in *Completions* buffer."
6215 :type 'boolean
6216 :version "22.1"
6217 :group 'completion)
6219 ;; This function goes in completion-setup-hook, so that it is called
6220 ;; after the text of the completion list buffer is written.
6221 (defun completion-setup-function ()
6222 (let* ((mainbuf (current-buffer))
6223 (base-dir
6224 ;; When reading a file name in the minibuffer,
6225 ;; try and find the right default-directory to set in the
6226 ;; completion list buffer.
6227 ;; FIXME: Why do we do that, actually? --Stef
6228 (if minibuffer-completing-file-name
6229 (file-name-as-directory
6230 (expand-file-name
6231 (substring (minibuffer-completion-contents)
6232 0 (or completion-base-size 0)))))))
6233 (with-current-buffer standard-output
6234 (let ((base-size completion-base-size) ;Read before killing localvars.
6235 (base-position completion-base-position)
6236 (insert-fun completion-list-insert-choice-function))
6237 (completion-list-mode)
6238 (set (make-local-variable 'completion-base-size) base-size)
6239 (set (make-local-variable 'completion-base-position) base-position)
6240 (set (make-local-variable 'completion-list-insert-choice-function)
6241 insert-fun))
6242 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6243 (if base-dir (setq default-directory base-dir))
6244 ;; Maybe insert help string.
6245 (when completion-show-help
6246 (goto-char (point-min))
6247 (if (display-mouse-p)
6248 (insert (substitute-command-keys
6250 (insert (substitute-command-keys
6254 (add-hook 'completion-setup-hook 'completion-setup-function)
6256 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6257 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6259 (defun switch-to-completions ()
6260 "Select the completion list window."
6261 (interactive)
6262 (let ((window (or (get-buffer-window "*Completions*" 0)
6263 ;; Make sure we have a completions window.
6264 (progn (minibuffer-completion-help)
6265 (get-buffer-window "*Completions*" 0)))))
6266 (when window
6267 (select-window window)
6268 ;; In the new buffer, go to the first completion.
6269 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6270 (when (bobp)
6271 (next-completion 1)))))
6272 \f
6273 ;;; Support keyboard commands to turn on various modifiers.
6275 ;; These functions -- which are not commands -- each add one modifier
6276 ;; to the following event.
6278 (defun event-apply-alt-modifier (_ignore-prompt)
6281 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6282 (defun event-apply-super-modifier (_ignore-prompt)
6285 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6286 (defun event-apply-hyper-modifier (_ignore-prompt)
6289 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6290 (defun event-apply-shift-modifier (_ignore-prompt)
6293 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6294 (defun event-apply-control-modifier (_ignore-prompt)
6297 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6298 (defun event-apply-meta-modifier (_ignore-prompt)
6301 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6303 (defun event-apply-modifier (event symbol lshiftby prefix)
6304 "Apply a modifier flag to event EVENT.
6305 SYMBOL is the name of this modifier, as a symbol.
6306 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6307 PREFIX is the string that represents this modifier in an event type symbol."
6308 (if (numberp event)
6309 (cond ((eq symbol 'control)
6310 (if (and (<= (downcase event) ?z)
6311 (>= (downcase event) ?a))
6312 (- (downcase event) ?a -1)
6313 (if (and (<= (downcase event) ?Z)
6314 (>= (downcase event) ?A))
6315 (- (downcase event) ?A -1)
6316 (logior (lsh 1 lshiftby) event))))
6317 ((eq symbol 'shift)
6318 (if (and (<= (downcase event) ?z)
6319 (>= (downcase event) ?a))
6320 (upcase event)
6321 (logior (lsh 1 lshiftby) event)))
6322 (t
6323 (logior (lsh 1 lshiftby) event)))
6324 (if (memq symbol (event-modifiers event))
6325 event
6326 (let ((event-type (if (symbolp event) event (car event))))
6327 (setq event-type (intern (concat prefix (symbol-name event-type))))
6328 (if (symbolp event)
6329 event-type
6330 (cons event-type (cdr event)))))))
6332 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6333 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6334 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6335 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6336 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6337 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6338 \f
6339 ;;;; Keypad support.
6341 ;; Make the keypad keys act like ordinary typing keys. If people add
6342 ;; bindings for the function key symbols, then those bindings will
6343 ;; override these, so this shouldn't interfere with any existing
6344 ;; bindings.
6346 ;; Also tell read-char how to handle these keys.
6347 (mapc
6348 (lambda (keypad-normal)
6349 (let ((keypad (nth 0 keypad-normal))
6350 (normal (nth 1 keypad-normal)))
6351 (put keypad 'ascii-character normal)
6352 (define-key function-key-map (vector keypad) (vector normal))))
6353 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6354 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6355 (kp-space ?\s)
6358 (kp-multiply ?*)
6359 (kp-add ?+)
6360 (kp-separator ?,)
6361 (kp-subtract ?-)
6362 (kp-decimal ?.)
6363 (kp-divide ?/)
6364 (kp-equal ?=)
6365 ;; Do the same for various keys that are represented as symbols under
6366 ;; GUIs but naturally correspond to characters.
6367 (backspace 127)
6368 (delete 127)
6371 (clear ?\C-l)
6372 (return ?\C-m)
6373 (escape ?\e)
6374 ))
6375 \f
6376 ;;;;
6377 ;;;; forking a twin copy of a buffer.
6378 ;;;;
6380 (defvar clone-buffer-hook nil
6381 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6383 (defvar clone-indirect-buffer-hook nil
6384 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6386 (defun clone-process (process &optional newname)
6387 "Create a twin copy of PROCESS.
6388 If NEWNAME is nil, it defaults to PROCESS' name;
6389 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6390 If PROCESS is associated with a buffer, the new process will be associated
6391 with the current buffer instead.
6392 Returns nil if PROCESS has already terminated."
6393 (setq newname (or newname (process-name process)))
6395 (setq newname (substring newname 0 (match-beginning 0))))
6396 (when (memq (process-status process) '(run stop open))
6397 (let* ((process-connection-type (process-tty-name process))
6398 (new-process
6399 (if (memq (process-status process) '(open))
6400 (let ((args (process-contact process t)))
6401 (setq args (plist-put args :name newname))
6402 (setq args (plist-put args :buffer
6403 (if (process-buffer process)
6404 (current-buffer))))
6405 (apply 'make-network-process args))
6406 (apply 'start-process newname
6407 (if (process-buffer process) (current-buffer))
6408 (process-command process)))))
6409 (set-process-query-on-exit-flag
6410 new-process (process-query-on-exit-flag process))
6411 (set-process-inherit-coding-system-flag
6412 new-process (process-inherit-coding-system-flag process))
6413 (set-process-filter new-process (process-filter process))
6414 (set-process-sentinel new-process (process-sentinel process))
6415 (set-process-plist new-process (copy-sequence (process-plist process)))
6416 new-process)))
6418 ;; things to maybe add (currently partly covered by `funcall mode'):
6419 ;; - syntax-table
6420 ;; - overlays
6421 (defun clone-buffer (&optional newname display-flag)
6422 "Create and return a twin copy of the current buffer.
6423 Unlike an indirect buffer, the new buffer can be edited
6424 independently of the old one (if it is not read-only).
6425 NEWNAME is the name of the new buffer. It may be modified by
6426 adding or incrementing <N> at the end as necessary to create a
6427 unique buffer name. If nil, it defaults to the name of the
6428 current buffer, with the proper suffix. If DISPLAY-FLAG is
6429 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6430 clone a file-visiting buffer, or a buffer whose major mode symbol
6431 has a non-nil `no-clone' property, results in an error.
6433 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6434 current buffer with appropriate suffix. However, if a prefix
6435 argument is given, then the command prompts for NEWNAME in the
6436 minibuffer.
6438 This runs the normal hook `clone-buffer-hook' in the new buffer
6439 after it has been set up properly in other respects."
6440 (interactive
6441 (progn
6442 (if buffer-file-name
6443 (error "Cannot clone a file-visiting buffer"))
6444 (if (get major-mode 'no-clone)
6445 (error "Cannot clone a buffer in %s mode" mode-name))
6446 (list (if current-prefix-arg
6447 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6448 t)))
6449 (if buffer-file-name
6450 (error "Cannot clone a file-visiting buffer"))
6451 (if (get major-mode 'no-clone)
6452 (error "Cannot clone a buffer in %s mode" mode-name))
6453 (setq newname (or newname (buffer-name)))
6455 (setq newname (substring newname 0 (match-beginning 0))))
6456 (let ((buf (current-buffer))
6457 (ptmin (point-min))
6458 (ptmax (point-max))
6459 (pt (point))
6460 (mk (if mark-active (mark t)))
6461 (modified (buffer-modified-p))
6462 (mode major-mode)
6463 (lvars (buffer-local-variables))
6464 (process (get-buffer-process (current-buffer)))
6465 (new (generate-new-buffer (or newname (buffer-name)))))
6466 (save-restriction
6467 (widen)
6468 (with-current-buffer new
6469 (insert-buffer-substring buf)))
6470 (with-current-buffer new
6471 (narrow-to-region ptmin ptmax)
6472 (goto-char pt)
6473 (if mk (set-mark mk))
6474 (set-buffer-modified-p modified)
6476 ;; Clone the old buffer's process, if any.
6477 (when process (clone-process process))
6479 ;; Now set up the major mode.
6480 (funcall mode)
6482 ;; Set up other local variables.
6483 (mapc (lambda (v)
6484 (condition-case () ;in case var is read-only
6485 (if (symbolp v)
6486 (makunbound v)
6487 (set (make-local-variable (car v)) (cdr v)))
6488 (error nil)))
6489 lvars)
6491 ;; Run any hooks (typically set up by the major mode
6492 ;; for cloning to work properly).
6493 (run-hooks 'clone-buffer-hook))
6494 (if display-flag
6495 ;; Presumably the current buffer is shown in the selected frame, so
6496 ;; we want to display the clone elsewhere.
6497 (let ((same-window-regexps nil)
6498 (same-window-buffer-names))
6499 (pop-to-buffer new)))
6500 new))
6503 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6504 "Create an indirect buffer that is a twin copy of the current buffer.
6506 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6507 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6508 or if not called with a prefix arg, NEWNAME defaults to the current
6509 buffer's name. The name is modified by adding a `<N>' suffix to it
6510 or by incrementing the N in an existing suffix. Trying to clone a
6511 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6512 property results in an error.
6514 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6515 This is always done when called interactively.
6517 Optional third arg NORECORD non-nil means do not put this buffer at the
6518 front of the list of recently selected ones."
6519 (interactive
6520 (progn
6521 (if (get major-mode 'no-clone-indirect)
6522 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6523 (list (if current-prefix-arg
6524 (read-buffer "Name of indirect buffer: " (current-buffer)))
6525 t)))
6526 (if (get major-mode 'no-clone-indirect)
6527 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6528 (setq newname (or newname (buffer-name)))
6530 (setq newname (substring newname 0 (match-beginning 0))))
6531 (let* ((name (generate-new-buffer-name newname))
6532 (buffer (make-indirect-buffer (current-buffer) name t)))
6533 (with-current-buffer buffer
6534 (run-hooks 'clone-indirect-buffer-hook))
6535 (when display-flag
6536 (pop-to-buffer buffer norecord))
6537 buffer))
6540 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6541 "Like `clone-indirect-buffer' but display in another window."
6542 (interactive
6543 (progn
6544 (if (get major-mode 'no-clone-indirect)
6545 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6546 (list (if current-prefix-arg
6547 (read-buffer "Name of indirect buffer: " (current-buffer)))
6548 t)))
6549 (let ((pop-up-windows t))
6550 (clone-indirect-buffer newname display-flag norecord)))
6552 \f
6553 ;;; Handling of Backspace and Delete keys.
6555 (defcustom normal-erase-is-backspace 'maybe
6556 "Set the default behavior of the Delete and Backspace keys.
6558 If set to t, Delete key deletes forward and Backspace key deletes
6559 backward.
6561 If set to nil, both Delete and Backspace keys delete backward.
6563 If set to 'maybe (which is the default), Emacs automatically
6564 selects a behavior. On window systems, the behavior depends on
6565 the keyboard used. If the keyboard has both a Backspace key and
6566 a Delete key, and both are mapped to their usual meanings, the
6567 option's default value is set to t, so that Backspace can be used
6568 to delete backward, and Delete can be used to delete forward.
6570 If not running under a window system, customizing this option
6571 accomplishes a similar effect by mapping C-h, which is usually
6572 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6573 via `keyboard-translate'. The former functionality of C-h is
6574 available on the F1 key. You should probably not use this
6575 setting if you don't have both Backspace, Delete and F1 keys.
6577 Setting this variable with setq doesn't take effect. Programmatically,
6578 call `normal-erase-is-backspace-mode' (which see) instead."
6579 :type '(choice (const :tag "Off" nil)
6580 (const :tag "Maybe" maybe)
6581 (other :tag "On" t))
6582 :group 'editing-basics
6583 :version "21.1"
6584 :set (lambda (symbol value)
6585 ;; The fboundp is because of a problem with :set when
6586 ;; dumping Emacs. It doesn't really matter.
6587 (if (fboundp 'normal-erase-is-backspace-mode)
6588 (normal-erase-is-backspace-mode (or value 0))
6589 (set-default symbol value))))
6591 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6592 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6593 (unless frame (setq frame (selected-frame)))
6594 (with-selected-frame frame
6595 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6596 (normal-erase-is-backspace-mode
6597 (if (if (eq normal-erase-is-backspace 'maybe)
6598 (and (not noninteractive)
6599 (or (memq system-type '(ms-dos windows-nt))
6600 (memq window-system '(ns))
6601 (and (memq window-system '(x))
6602 (fboundp 'x-backspace-delete-keys-p)
6603 (x-backspace-delete-keys-p))
6604 ;; If the terminal Emacs is running on has erase char
6605 ;; set to ^H, use the Backspace key for deleting
6606 ;; backward, and the Delete key for deleting forward.
6607 (and (null window-system)
6608 (eq tty-erase-char ?\^H))))
6609 normal-erase-is-backspace)
6610 1 0)))))
6612 (define-minor-mode normal-erase-is-backspace-mode
6613 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6615 With numeric ARG, turn the mode on if and only if ARG is positive.
6617 On window systems, when this mode is on, Delete is mapped to C-d
6618 and Backspace is mapped to DEL; when this mode is off, both
6619 Delete and Backspace are mapped to DEL. (The remapping goes via
6620 `local-function-key-map', so binding Delete or Backspace in the
6621 global or local keymap will override that.)
6623 In addition, on window systems, the bindings of C-Delete, M-Delete,
6624 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6625 the global keymap in accordance with the functionality of Delete and
6626 Backspace. For example, if Delete is remapped to C-d, which deletes
6627 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6628 to DEL, which deletes backward, C-Delete is bound to
6629 `backward-kill-word'.
6631 If not running on a window system, a similar effect is accomplished by
6632 remapping C-h (normally produced by the Backspace key) and DEL via
6633 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6634 to C-d; if it's off, the keys are not remapped.
6636 When not running on a window system, and this mode is turned on, the
6637 former functionality of C-h is available on the F1 key. You should
6638 probably not turn on this mode on a text-only terminal if you don't
6639 have both Backspace, Delete and F1 keys.
6641 See also `normal-erase-is-backspace'."
6642 :variable (eq (terminal-parameter
6643 nil 'normal-erase-is-backspace) 1)
6644 (let ((enabled (eq 1 (terminal-parameter
6645 nil 'normal-erase-is-backspace))))
6647 (cond ((or (memq window-system '(x w32 ns pc))
6648 (memq system-type '(ms-dos windows-nt)))
6649 (let ((bindings
6650 `(([M-delete] [M-backspace])
6651 ([C-M-delete] [C-M-backspace])
6652 ([?\e C-delete] [?\e C-backspace]))))
6654 (if enabled
6655 (progn
6656 (define-key local-function-key-map [delete] [deletechar])
6657 (define-key local-function-key-map [kp-delete] [?\C-d])
6658 (define-key local-function-key-map [backspace] [?\C-?])
6659 (dolist (b bindings)
6660 ;; Not sure if input-decode-map is really right, but
6661 ;; keyboard-translate-table (used below) only works
6662 ;; for integer events, and key-translation-table is
6663 ;; global (like the global-map, used earlier).
6664 (define-key input-decode-map (car b) nil)
6665 (define-key input-decode-map (cadr b) nil)))
6666 (define-key local-function-key-map [delete] [?\C-?])
6667 (define-key local-function-key-map [kp-delete] [?\C-?])
6668 (define-key local-function-key-map [backspace] [?\C-?])
6669 (dolist (b bindings)
6670 (define-key input-decode-map (car b) (cadr b))
6671 (define-key input-decode-map (cadr b) (car b))))))
6672 (t
6673 (if enabled
6674 (progn
6675 (keyboard-translate ?\C-h ?\C-?)
6676 (keyboard-translate ?\C-? ?\C-d))
6677 (keyboard-translate ?\C-h ?\C-h)
6678 (keyboard-translate ?\C-? ?\C-?))))
6680 (if (called-interactively-p 'interactive)
6681 (message "Delete key deletes %s"
6682 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6683 "forward" "backward")))))
6684 \f
6685 (defvar vis-mode-saved-buffer-invisibility-spec nil
6686 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6688 (define-minor-mode visible-mode
6689 "Toggle Visible mode.
6690 With argument ARG turn Visible mode on if ARG is positive, otherwise
6691 turn it off.
6693 Enabling Visible mode makes all invisible text temporarily visible.
6694 Disabling Visible mode turns off that effect. Visible mode works by
6695 saving the value of `buffer-invisibility-spec' and setting it to nil."
6696 :lighter " Vis"
6697 :group 'editing-basics
6698 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6699 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6700 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6701 (when visible-mode
6702 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6703 buffer-invisibility-spec)
6704 (setq buffer-invisibility-spec nil)))
6705 \f
6706 ;; Minibuffer prompt stuff.
6708 ;;(defun minibuffer-prompt-modification (start end)
6709 ;; (error "You cannot modify the prompt"))
6710 ;;
6711 ;;
6712 ;;(defun minibuffer-prompt-insertion (start end)
6713 ;; (let ((inhibit-modification-hooks t))
6714 ;; (delete-region start end)
6715 ;; ;; Discard undo information for the text insertion itself
6716 ;; ;; and for the text deletion.above.
6717 ;; (when (consp buffer-undo-list)
6718 ;; (setq buffer-undo-list (cddr buffer-undo-list)))
6719 ;; (message "You cannot modify the prompt")))
6720 ;;
6721 ;;
6722 ;;(setq minibuffer-prompt-properties
6723 ;; (list 'modification-hooks '(minibuffer-prompt-modification)
6724 ;; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6726 \f
6727 ;;;; Problematic external packages.
6729 ;; rms says this should be done by specifying symbols that define
6730 ;; versions together with bad values. This is therefore not as
6731 ;; flexible as it could be. See the thread:
6732 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6733 (defconst bad-packages-alist
6734 ;; Not sure exactly which semantic versions have problems.
6735 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6737 "The version of `semantic' loaded does not work in Emacs 22.
6738 It can cause constant high CPU load.
6739 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6740 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6741 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6742 ;; provided the `CUA-mode' feature. Since this is no longer true,
6743 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6744 (CUA-mode t nil
6745 "CUA-mode is now part of the standard GNU Emacs distribution,
6746 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6748 You have loaded an older version of CUA-mode which does not work
6749 correctly with this version of Emacs. You should remove the old
6750 version and use the one distributed with Emacs."))
6751 "Alist of packages known to cause problems in this version of Emacs.
6752 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6753 PACKAGE is either a regular expression to match file names, or a
6754 symbol (a feature name); see the documentation of
6755 `after-load-alist', to which this variable adds functions.
6756 SYMBOL is either the name of a string variable, or `t'. Upon
6757 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6758 warning using STRING as the message.")
6760 (defun bad-package-check (package)
6761 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6762 (condition-case nil
6763 (let* ((list (assoc package bad-packages-alist))
6764 (symbol (nth 1 list)))
6765 (and list
6766 (boundp symbol)
6767 (or (eq symbol t)
6768 (and (stringp (setq symbol (eval symbol)))
6769 (string-match-p (nth 2 list) symbol)))
6770 (display-warning package (nth 3 list) :warning)))
6771 (error nil)))
6773 (mapc (lambda (elem)
6774 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6775 bad-packages-alist)
6778 (provide 'simple)
6780 ;;; simple.el ends here