| blob | ef30e98dd1cd426bbd3a158fd43959956d25b69b |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: internal
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; A grab-bag of basic Emacs commands not specifically related to some
28 ;; major mode or to file-handling.
30 ;;; Code:
32 ;; This is for lexical-let in apply-partially.
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 See variables `compilation-parse-errors-function' and
309 \`compilation-error-regexp-alist' for customization ideas."
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.
418 map))
422 "Parent major mode from which special major modes should inherit."
425 ;; Major mode meant to be the parent of programming modes.
428 "Major mode for editing programming language source code."
432 ;; Making and deleting lines.
438 "Insert a newline, and move to left margin of the new line if it's blank.
439 If `use-hard-newlines' is non-nil, the newline is marked with the
440 text-property `hard'.
441 With ARG, insert that many newlines.
442 Call `auto-fill-function' if the current column number is greater
443 than the value of `fill-column' and ARG is nil."
446 ;; Inserting a newline at the end of a line produces better redisplay in
447 ;; try_window_id than inserting at the beginning of a line, and the textual
448 ;; result is the same. So, if we're at beginning of line, pretend to be at
449 ;; the end of the previous line.
452 ;; Make sure no functions want to be told about
453 ;; the range of the changes.
456 ;; Make sure there are no markers here.
459 ;; Make sure no text properties want to know
460 ;; where the change was.
465 ;; Make sure the newline before point isn't intangible.
467 ;; Make sure the newline before point isn't read-only.
469 ;; Make sure the newline before point isn't invisible.
471 ;; Make sure the newline before point has the same
472 ;; properties as the char before it (if any).
479 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
480 ;; Set last-command-event to tell self-insert what to insert.
482 ;; Don't auto-fill if we have a numeric argument.
483 ;; Also not if flag is true (it would fill wrong line);
484 ;; there is no need to since we're at BOL.
488 ;; If we get an error in self-insert-command, put point at right place.
490 ;; Even if we did *not* get an error, keep that forward-char;
491 ;; all further processing should apply to the newline that the user
492 ;; thinks he inserted.
494 ;; Mark the newline(s) `hard'.
498 ;; If the newline leaves the previous line blank,
499 ;; and we have a left margin, delete that from the blank line.
507 ;; Indent the line after the newline, except in one case:
508 ;; when we added the newline at the beginning of a line
509 ;; which starts a page.
512 nil)
517 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
523 "Insert a newline and leave point before it.
524 If there is a fill prefix and/or a `left-margin', insert them
525 on the new line if the line would have been blank.
526 With arg N, insert N newlines."
531 ;; Don't expand an abbrev before point.
545 "Split current line, moving portion beyond point vertically down.
546 If the current line starts with `fill-prefix', insert it on the new
547 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
549 When called from Lisp code, ARG may be a prefix string to copy."
554 ;; What prefix should we check for (nil means don't).
558 ;; Does this line start with it?
569 "Join this line to previous and fix up whitespace at join.
570 If there is a fill prefix, delete it from the beginning of this line.
571 With argument, join this line to following line."
578 ;; If the second line started with the fill prefix,
579 ;; delete the prefix.
591 "On blank line, delete all surrounding blank lines, leaving just one.
592 On isolated blank line, delete that one.
593 On nonblank line, delete any immediately following blank lines."
599 ;; Set singleblank if there is just one blank line here.
606 ;; Delete preceding blank lines, and this one too if it's the only one.
615 ;; Delete following blank lines, unless the current line is blank
616 ;; and there are no following blank lines.
625 ;; Handle the special case where point is followed by newline and eob.
626 ;; Delete the line, leaving point at eob.
631 "Delete all the trailing whitespace across the current buffer.
632 All whitespace after the last non-whitespace character in a line is deleted.
634 A formfeed is not considered whitespace by this function."
641 ;; Don't delete formfeeds, even if they are considered whitespace.
648 "Insert a newline, then indent according to major mode.
649 Indentation is done using the value of `indent-line-function'.
650 In programming language modes, this is the same as TAB.
651 In some text modes, where TAB inserts a tab, this command indents to the
652 column specified by the function `current-left-margin'."
659 "Reindent current line, insert newline, then indent the new line.
660 Indentation of both lines is done according to the current major mode,
661 which means calling the current value of `indent-line-function'.
662 In programming language modes, this is the same as TAB.
663 In some text modes, where TAB inserts a tab, this indents to the
664 column specified by the function `current-left-margin'."
667 ;; Be careful to insert the newline before indenting the line.
668 ;; Otherwise, the indentation might be wrong.
672 ;; We are at EOL before the call to indent-according-to-mode, and
673 ;; after it we usually are as well, but not always. We tried to
674 ;; address it with `save-excursion' but that uses a normal marker
675 ;; whereas we need `move after insertion', so we do the save/restore
676 ;; by hand.
680 ;; Remove the trailing white-space after indentation because
681 ;; indentation may introduce the whitespace.
686 "Read next input character and insert it.
687 This is useful for inserting control characters.
688 With argument, insert ARG copies of the character.
690 If the first character you type after this command is an octal digit,
691 you should type a sequence of octal digits which specify a character code.
692 Any nondigit terminates the sequence. If the terminator is a RET,
693 it is discarded; any other terminator is used itself as input.
694 The variable `read-quoted-char-radix' specifies the radix for this feature;
695 set it to 10 or 16 to use decimal or hex instead of octal.
697 In overwrite mode, this function inserts the character anyway, and
698 does not handle octal digits specially. This means that if you use
699 overwrite as your normal editing mode, you can use this function to
700 insert characters when necessary.
702 In binary overwrite mode, this function does overwrite, and octal
703 digits are interpreted as a character code. This is intended to be
704 useful for editing binary files."
707 ;; Avoid "obsolete" warnings for translation-table-for-input.
714 ;; This used to assume character codes 0240 - 0377 stand for
715 ;; characters in some single-byte character set, and converted them
716 ;; to Emacs characters. But in 23.1 this feature is deprecated
717 ;; in favor of inserting the corresponding Unicode characters.
718 ;; (if (and enable-multibyte-characters
719 ;; (>= char ?\240)
720 ;; (<= char ?\377))
721 ;; (setq char (unibyte-char-to-multibyte char)))
730 "Move forward ARG lines and position at first nonblank character."
736 "Move backward ARG lines and position at first nonblank character."
742 "Move point to the first non-whitespace character on this line."
746 ;; Move back over chars that have whitespace syntax but have the p flag.
750 "Fixup white space between objects around point.
751 Leave one space or none, according to the context."
758 nil
762 "Delete all spaces and tabs around point.
763 If BACKWARD-ONLY is non-nil, only delete them before point."
768 orig-pos
777 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
791 \f
793 "Move point to the beginning of the buffer; leave mark at previous position.
795 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 and size
798 of the accessible part of the buffer.
800 Don't use this command in Lisp programs!
801 \(goto-char (point-min)) is faster and avoids clobbering the mark."
810 ;; Avoid overflow for large buffer sizes!
818 "Move point to the end of the buffer; leave mark at previous position.
820 With numeric arg N, put point N/10 of the way from the end.
822 If the buffer is narrowed, this command uses the beginning and size
823 of the accessible part of the buffer.
825 Don't use this command in Lisp programs!
826 \(goto-char (point-max)) is faster and avoids clobbering the mark."
833 ;; Avoid overflow for large buffer sizes!
838 ;; If we went to a place in the middle of the buffer,
839 ;; adjust it to the beginning of a line.
842 ;; If the end of the buffer is not already on the screen,
843 ;; then scroll specially to put it near, but not at, the bottom.
848 "Put point at beginning and mark at end of buffer.
849 You probably should not use this function in Lisp programs;
850 it is usually a mistake for a Lisp function to use any subroutine
851 that uses or sets the mark."
856 \f
858 ;; Counting lines, one way or another.
861 "Goto LINE, counting from line 1 at beginning of buffer.
862 Normally, move point in the current buffer, and leave mark at the
864 move point in the most recently selected other buffer, and switch to it.
866 If there's a number in the buffer at point, it is the default for LINE.
868 This function is usually the wrong thing to use in a Lisp program.
869 What you probably want instead is something like:
870 (goto-char (point-min)) (forward-line (1- N))
871 If at all possible, an even better solution is to use char counts
872 rather than line counts."
876 ;; Look for a default, a number in the buffer at point.
885 ;; Decide if we're switching buffers.
893 ;; Read the argument, offering that number (if any) as default.
896 buffer-prompt
897 default)
898 nil nil t
899 'minibuffer-history
900 default)
901 buffer))))
902 ;; Switch to the desired buffer, one way or another.
907 ;; Leave mark at previous position
909 ;; Move to the specified line number in that buffer.
918 "Print number of lines and characters in the region."
924 "Print the current buffer line number and narrowed line number of point."
937 "Return number of lines between START and END.
938 This is usually the number of newlines between them,
939 but can be one more if START is not equal to END
940 and the greater of them is not at the start of a line."
956 done)))
960 "Return (narrowed) buffer line number at position POS.
961 If POS is nil, use current buffer location.
962 Counting starts at (point-min), so the value refers
963 to the contents of the accessible portion of the buffer."
973 "Print info on cursor position (on screen and within buffer).
974 Also describe the character after point, and give its character code
975 in octal, decimal and hex.
977 For a non-ASCII multibyte character, also give its encoding in the
978 buffer's selected coding system if the coding system encodes the
979 character safely. If the character is encoded into one byte, that
980 code is shown in hex. If the character is encoded into more than one
983 In addition, with prefix argument, show details about that character
984 in *Help* buffer. See also the command `describe-char'."
992 ;; Avoid overflow from multiplying by 100!
996 ""
1002 pos total percent beg end col hscroll)
1004 pos total col hscroll))
1006 encoded encoding-msg display-prop under-display)
1013 ;; Check if the character is displayed with some `display'
1014 ;; text property. In that case, set under-display to the
1015 ;; buffer substring covered by that property.
1026 under-display)))
1032 char char char under-display)
1034 char char char under-display display-prop))
1037 char char char
1039 "..."
1043 ;; We show the detailed information about CHAR.
1050 encoding-msg pos total percent beg end col hscroll)
1057 encoding-msg pos total percent col hscroll))))))
1058 \f
1059 ;; Initialize read-expression-map. It is defined at C level.
1071 "The current default value or list of default values in the minibuffer.
1072 The functions `read-from-minibuffer' and `completing-read' bind
1076 "Value for `print-level' while printing value in `eval-expression'.
1077 A value of nil means no limit."
1083 "Value for `print-length' while printing value in `eval-expression'.
1084 A value of nil means no limit."
1090 "If non-nil set `debug-on-error' to t in `eval-expression'.
1091 If nil, don't change the value of `debug-on-error'."
1097 "Format VALUE as a result of evaluated expression.
1098 Return a formatted string which is displayed in the echo area
1099 in addition to the value printed by prin1 in functions which
1100 display the result of expression evaluation."
1113 ;; We define this, rather than making `eval' interactive,
1114 ;; for the sake of completion of names like eval-region, eval-buffer.
1117 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1118 Value is also consed on to front of the variable `values'.
1119 Optional argument EVAL-EXPRESSION-INSERT-VALUE non-nil (interactively,
1120 with prefix argument) means insert the result into the current buffer
1121 instead of printing it in the echo area. Truncates long output
1122 according to the value of the variables `eval-expression-print-length'
1123 and `eval-expression-print-level'.
1125 If `eval-expression-debug-on-error' is non-nil, which is the default,
1126 this command arranges for all errors to enter the debugger."
1130 nil read-expression-map t
1132 current-prefix-arg))
1137 ;; Bind debug-on-error to something unique so that we can
1138 ;; detect when evaled code changes it.
1142 ;; If evaled code has changed the value of debug-on-error,
1143 ;; propagate that change to the global binding.
1159 "Prompting with PROMPT, let user edit COMMAND and eval result.
1160 COMMAND is a Lisp expression. Let user edit that expression in
1161 the minibuffer, then read and evaluate the result."
1168 read-expression-map t
1170 ;; If command was added to command-history as a string,
1171 ;; get rid of that. We want only evaluable expressions there.
1175 ;; If command to be redone does not match front of history,
1176 ;; add it to the history.
1182 "Edit and re-evaluate last complex command, or ARGth from last.
1183 A complex command is one which used the minibuffer.
1184 The command is placed in the minibuffer as a Lisp form for editing.
1185 The result is executed, repeating the command as changed.
1186 If the command has been changed or is not the most recent previous
1187 command it is added to the front of the command history.
1188 You can use the minibuffer history commands \
1190 to get different commands to edit and resubmit."
1193 newcmd)
1205 ;; If command was added to command-history as a
1206 ;; string, get rid of that. We want only
1207 ;; evaluable expressions there.
1211 ;; If command to be redone does not match front of history,
1212 ;; add it to the history.
1219 \f
1221 "Default minibuffer history list.
1222 This is used for all minibuffer input
1223 except when an alternate history list is specified.
1225 Maximum length of the history list is determined by the value
1228 "Control whether history list elements are expressions or strings.
1229 If the value of this variable equals current minibuffer depth,
1230 they are expressions; otherwise they are strings.
1231 \(That convention is designed to do the right thing for
1238 "Text that was in this minibuffer before any history commands.
1239 This is nil if there have not yet been any history commands
1248 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1252 "Minibuffer history variables for which matching should ignore case.
1253 If a history variable is a member of this list, then the
1255 commands ignore case when searching it, regardless of `case-fold-search'."
1260 "Find the previous history element that matches REGEXP.
1261 \(Previous history elements refer to earlier actions.)
1262 With prefix argument N, search for Nth previous match.
1263 If N is negative, find the next or Nth next match.
1264 Normally, history elements are matched case-insensitively if
1265 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1266 makes the search case-sensitive.
1267 See also `minibuffer-history-case-insensitive-variables'."
1271 nil
1272 minibuffer-local-map
1273 nil
1274 'minibuffer-history-search-history
1276 ;; Use the last regexp specified, by default, if input is empty.
1281 regexp)
1291 ;; On some systems, ignore case for file names.
1293 minibuffer-history-case-insensitive-variables)
1294 t
1295 ;; Respect the user's setting for case-fold-search:
1296 case-fold-search)
1297 nil))
1298 prevpos
1299 match-string
1300 match-offset
1307 "No later matching history item"
1328 next-matching-history-element))
1332 "Find the next history element that matches REGEXP.
1333 \(The next history element refers to a more recent action.)
1334 With prefix argument N, search for Nth next match.
1335 If N is negative, find the previous or Nth previous match.
1336 Normally, history elements are matched case-insensitively if
1337 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1338 makes the search case-sensitive."
1342 nil
1343 minibuffer-local-map
1344 nil
1345 'minibuffer-history-search-history
1347 ;; Use the last regexp specified, by default, if input is empty.
1352 regexp)
1359 "Function run by `goto-history-element' before consuming default values.
1360 This is useful to dynamically add more elements to the list of default values
1361 when `goto-history-element' reaches the end of this list.
1362 Before calling this function `goto-history-element' sets the variable
1363 `minibuffer-default-add-done' to t, so it will call this function only
1364 once. In special cases, when this function needs to be called more
1365 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1369 "When nil, add more elements to the end of the list of default values.
1370 The value nil causes `goto-history-element' to add more elements to
1371 the list of defaults when it reaches the end of this list. It does
1377 "Return a list of all completions without the default value.
1378 This function is used to add all elements of the completion table to
1379 the end of the list of defaults just after the default value."
1382 minibuffer-completion-table
1383 minibuffer-completion-predicate)))
1389 "Puts element of the minibuffer history in the minibuffer.
1390 The argument NABS specifies the absolute history position."
1404 elt minibuffer-returned-to-present)
1416 previous-history-element))
1428 minibuffer-default)))
1440 elt))
1444 "Puts next element of the minibuffer history in the minibuffer.
1445 With argument N, it uses the Nth following element."
1451 "Puts previous element of the minibuffer history in the minibuffer.
1452 With argument N, it uses the Nth previous element."
1458 "Get next history element which completes the minibuffer before the point.
1459 The contents of the minibuffer after the point are deleted, and replaced
1460 by the new completion."
1466 n)
1467 ;; next-matching-history-element always puts us at (point-min).
1468 ;; Move to the position we were at before changing the buffer contents.
1469 ;; This is still sensical, because the text before point has not changed.
1473 "\
1474 Get previous history element which completes the minibuffer before the point.
1475 The contents of the minibuffer after the point are deleted, and replaced
1476 by the new completion."
1480 ;; For compatibility with the old subr of the same name.
1482 "Return the display width of the minibuffer prompt.
1483 Return 0 if current buffer is not a minibuffer."
1484 ;; Return the width of everything before the field at the end of
1485 ;; the buffer; this should be 0 for normal buffers.
1487 \f
1488 ;; isearch minibuffer history
1495 "Set up a minibuffer for using isearch to search the minibuffer history.
1496 Intended to be added to `minibuffer-setup-hook'."
1508 "Clean up the minibuffer after terminating isearch in the minibuffer."
1513 "Return the proper search function, for isearch in minibuffer history."
1520 ;; Use standard functions to search within minibuffer text
1526 found)
1527 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1528 ;; searching forward. Lazy-highlight calls this lambda with the
1529 ;; bound arg, so skip the minibuffer prompt.
1533 ;; 1. First try searching in the initial minibuffer text
1536 noerror)
1537 ;; 2. If the above search fails, start putting next/prev history
1538 ;; elements in the minibuffer successively, and search the string
1539 ;; in them. Do this only when bound is nil (i.e. not while
1540 ;; lazy-highlighting search strings in the current minibuffer text).
1552 ;; After putting the next/prev history element, search
1553 ;; the string in them again, until next-history-element
1554 ;; or previous-history-element raises an error at the
1555 ;; beginning/end of history.
1558 ;; For backward search, don't search
1559 ;; in the minibuffer prompt
1561 noerror)))
1562 ;; Return point of the new search result
1564 ;; Return nil when next(prev)-history-element fails
1568 "Display the minibuffer history search prompt.
1569 If there are no search errors, this function displays an overlay with
1570 the isearch prompt which replaces the original minibuffer prompt.
1571 Otherwise, it displays the standard isearch message returned from
1572 `isearch-message'."
1574 ;; Use standard function `isearch-message' when not in the minibuffer,
1575 ;; or search fails, or has an error (like incomplete regexp).
1576 ;; This function overwrites minibuffer text with isearch message,
1577 ;; so it's possible to see what is wrong in the search string.
1579 ;; Otherwise, put the overlay with the standard isearch prompt over
1580 ;; the initial minibuffer prompt.
1589 ;; And clear any previous isearch message.
1593 "Wrap the minibuffer history search when search fails.
1594 Move point to the first history element for a forward search,
1595 or to the last history element for a backward search."
1597 ;; When `minibuffer-history-isearch-search' fails on reaching the
1598 ;; beginning/end of the history, wrap the search to the first/last
1599 ;; minibuffer history element.
1607 "Save a function restoring the state of minibuffer history search.
1608 Save `minibuffer-history-position' to the additional state parameter
1609 in the search status stack."
1614 "Restore the minibuffer history search state.
1615 Go to the history element by the absolute history position HIST-POS."
1618 \f
1619 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1623 "Table mapping redo records to the corresponding undo one.
1624 A redo record for undo-in-region maps to t.
1634 "Within a run of consecutive undo commands, list remaining to be undone.
1638 "Undo some previous changes.
1639 Repeat this command to undo more changes.
1640 A numeric ARG serves as a repeat count.
1642 In Transient Mark mode when the mark is active, only undo changes within
1644 as an argument limits undo to changes within the current region."
1646 ;; Make last-command indicate for the next command that this was an undo.
1647 ;; That way, another undo will undo more.
1648 ;; If we get to the end of the undo history and get an error,
1649 ;; another undo command will find the undo history empty
1650 ;; and will get another error. To begin undoing the undos,
1651 ;; you must type some other command.
1654 message)
1655 ;; If we get an error in undo-start,
1656 ;; the next command should not be a "consecutive undo".
1657 ;; So set `this-command' to something other than `undo'.
1662 ;; If something (a timer or filter?) changed the buffer
1663 ;; since the previous command, don't continue the undo seq.
1667 ;; If the last undo record made was made by undo
1668 ;; it shows nothing else happened in between.
1675 ;; get rid of initial undo boundary
1677 ;; If we got this far, the next command should be a consecutive undo.
1679 ;; Check to see whether we're hitting a redo record, and if
1680 ;; so, ask the user whether she wants to skip the redo/undo pair.
1687 ;; The equiv entry might point to another redo record if we have done
1688 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1696 ;; Record the fact that the just-generated undo records come from an
1697 ;; undo operation--that is, they are redo records.
1698 ;; In the ordinary case (not within a region), map the redo
1699 ;; record to the following undos.
1700 ;; I don't know how to do that in the undo-in-region case.
1702 ;; Strip any leading undo boundaries there might be, like we do
1703 ;; above when checking.
1707 undo-equiv-table))
1708 ;; Don't specify a position in the undo record for the undo command.
1709 ;; Instead, undoing this should move point to where the change is.
1728 ;; Record what the current undo list says,
1729 ;; so the next command can tell if the buffer was modified in between.
1732 ;; Display a message announcing success.
1737 "Make BUFFER stop keeping undo information.
1738 No argument or nil as argument means do this for the current buffer."
1744 "Undo some previous changes.
1745 Repeat this command to undo more changes.
1746 A numeric ARG serves as a repeat count.
1747 Contrary to `undo', this will not redo a previous undo."
1752 "Non-nil while performing an undo.
1756 "Undo back N undo-boundaries beyond what was already undone recently.
1757 Call `undo-start' to get ready to undo recent changes,
1758 then call `undo-more' one or more times to undo them."
1763 ;; Note: The following, while pulling elements off
1764 ;; `pending-undo-list' will call primitive change functions which
1765 ;; will push more elements onto `buffer-undo-list'.
1770 ;; Deep copy of a list
1772 "Make a copy of undo list LIST."
1778 elt))
1781 "Set `pending-undo-list' to the front of the undo list.
1782 The next call to `undo-more' will undo the most recently made change.
1783 If BEG and END are specified, then only undo elements
1784 that apply to text between BEG and END are used; other undo elements
1785 are ignored. If BEG and END are nil, all undo elements are used."
1791 buffer-undo-list)))
1796 "Return a list of undo elements for the region START to END.
1797 The elements come from `buffer-undo-list', but we keep only
1798 the elements inside this region, and discard those outside this region.
1799 If we find an element that crosses an edge of this region,
1800 we stop and ignore all further elements."
1803 undo-adjusted-markers
1804 some-rejected
1805 undo-elt undo-elt temp-undo-list delta)
1810 ;; This is a "was unmodified" element.
1811 ;; Keep it if we have kept everything thus far.
1818 ;; Don't put two nils together in the list
1832 ;; Loop down the earlier events adjusting their buffer
1833 ;; positions to reflect the fact that a change to the buffer
1834 ;; isn't being undone. We only need to process those element
1835 ;; types which undo-elt-in-region will return as being in
1836 ;; the region since only those types can ever get into the
1837 ;; output
1846 ;; (TEXT . POSITION)
1853 ;; (BEGIN . END)
1858 ;; (nil PROPERTY VALUE BEG . END)
1868 "Determine whether UNDO-ELT falls inside the region START ... END.
1869 If it crosses the edge, we return nil."
1874 t)
1876 nil)
1878 ;; (TEXT . POSITION)
1882 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1883 ;; See if MARKER is inside the region.
1894 ;; (nil PROPERTY VALUE BEG . END)
1899 ;; (BEGIN . END)
1904 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1905 This assumes we have already decided that UNDO-ELT
1906 is not *inside* the region START...END."
1909 ;; (nil PROPERTY VALUE BEG . END)
1914 ;; (BEGIN . END)
1918 ;; Return the first affected buffer position and the delta for an undo element
1919 ;; delta is defined as the change in subsequent buffer positions if we *did*
1920 ;; the undo.
1924 ;; (TEXT . POSITION)
1927 ;; (BEGIN . END)
1934 "If non-nil ask about discarding undo info for the current command.
1935 Normally, Emacs discards the undo info for the current command if
1936 it exceeds `undo-outer-limit'. But if you set this option
1937 non-nil, it asks in the echo area whether to discard the info.
1938 If you answer no, there is a slight risk that Emacs might crash, so
1939 only do it if you really want to undo the command.
1941 This option is mainly intended for debugging. You have to be
1942 careful if you use it for other purposes. Garbage collection is
1943 inhibited while the question is asked, meaning that Emacs might
1944 leak memory. So you should make sure that you do not wait
1945 excessively long before answering the question."
1951 "If non-nil, an extra level of size that's ok in an undo item.
1952 We don't ask the user about truncating the undo list until the
1953 current item gets bigger than this amount.
1958 ;; When the first undo batch in an undo list is longer than
1959 ;; undo-outer-limit, this function gets called to warn the user that
1960 ;; the undo info for the current command was discarded. Garbage
1961 ;; collection is inhibited around the call, so it had better not do a
1962 ;; lot of consing.
1968 ;; Don't ask the question again unless it gets even bigger.
1969 ;; This applies, in particular, if the user quits from the question.
1970 ;; Such a quit quits out of GC, but something else will call GC
1971 ;; again momentarily. It will call this function again,
1972 ;; but we don't want to ask the question again.
1979 t)
1980 nil))
1985 "The undo info was discarded because it exceeded \
1986 `undo-outer-limit'.
1988 This is normal if you executed a command that made a huge change
1989 to the buffer. In that case, to prevent similar problems in the
1990 future, set `undo-outer-limit' to a value that is large enough to
1991 cover the maximum size of normal changes you expect a single
1992 command to make, but not so large that it might exceed the
1993 maximum memory allotted to Emacs.
1995 If you did not execute any such command, the situation is
1996 probably due to a bug and you should report it.
1998 You can disable the popping up of this buffer by adding the entry
1999 \(undo discard-info) to the user option `warning-suppress-types',
2003 t))
2004 \f
2006 "History list for some commands that read shell commands.
2008 Maximum length of the history list is determined by the value
2015 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
2016 This buffer is used when `shell-command' or `shell-command-on-region'
2017 is run interactively. A value of nil means that output to stderr and
2024 "Return a list of all commands associated with the current file.
2025 This function is used to add all related commands retrieved by `mailcap'
2026 to the end of the list of defaults just after the default value."
2030 minibuffer-default))
2035 commands))
2045 "Dynamically complete shell command at point."
2057 map)
2061 "Read a shell command from the minibuffer.
2062 The arguments are the same as the ones of `read-from-minibuffer',
2063 except READ and KEYMAP are missing and HIST defaults
2064 to `shell-command-history'."
2070 minibuffer-local-shell-command-map
2071 nil
2073 args)))
2076 "Execute string COMMAND asynchronously in background.
2078 Like `shell-command' but if COMMAND doesn't end in ampersand, adds `&'
2079 surrounded by whitespace and executes the command asynchronously.
2080 The output appears in the buffer `*Async Shell Command*'.
2082 In Elisp, you will often be better served by calling `start-process'
2083 directly, since it offers more control and does not impose the use of a
2084 shell (with its need to quote arguments)."
2090 current-prefix-arg
2091 shell-command-default-error-buffer))
2097 "Execute string COMMAND in inferior shell; display output, if any.
2098 With prefix argument, insert the COMMAND's output at point.
2100 If COMMAND ends in ampersand, execute it asynchronously.
2101 The output appears in the buffer `*Async Shell Command*'.
2102 That buffer is in shell mode.
2104 Otherwise, COMMAND is executed synchronously. The output appears in
2105 the buffer `*Shell Command Output*'. If the output is short enough to
2106 display in the echo area (which is determined by the variables
2107 `resize-mini-windows' and `max-mini-window-height'), it is shown
2108 there, but it is nonetheless available in buffer `*Shell Command
2109 Output*' even though that buffer is not automatically displayed.
2111 To specify a coding system for converting non-ASCII characters
2113 before this command.
2115 Noninteractive callers can specify coding systems by binding
2116 `coding-system-for-read' and `coding-system-for-write'.
2118 The optional second argument OUTPUT-BUFFER, if non-nil,
2119 says to put the output in some other buffer.
2120 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2121 If OUTPUT-BUFFER is not a buffer and not nil,
2122 insert output in current buffer. (This cannot be done asynchronously.)
2123 In either case, the buffer is first erased, and the output is
2124 inserted after point (leaving mark after it).
2126 If the command terminates without error, but generates output,
2128 the output can be displayed in the echo area or in its buffer.
2129 If the output is short enough to display in the echo area
2130 \(determined by the variable `max-mini-window-height' if
2131 `resize-mini-windows' is non-nil), it is shown there.
2132 Otherwise,the buffer containing the output is displayed.
2136 of the output.
2138 If there is no output, or if output is inserted in the current buffer,
2139 then `*Shell Command Output*' is deleted.
2141 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2142 or buffer name to which to direct the command's standard error output.
2143 If it is nil, error output is mingled with regular output.
2144 In an interactive call, the variable `shell-command-default-error-buffer'
2145 specifies the value of ERROR-BUFFER.
2147 In Elisp, you will often be better served by calling `call-process' or
2148 `start-process' directly, since it offers more control and does not impose
2149 the use of a shell (with its need to quote arguments)."
2160 current-prefix-arg
2161 shell-command-default-error-buffer))
2162 ;; Look for a handler in case default-directory is a remote file name.
2170 ;; Output goes in current buffer.
2176 temporary-file-directory)))
2177 nil)))
2180 ;; We do not use -f for csh; we will not support broken use of
2181 ;; .cshrcs. Even the BSD csh manual says to use
2182 ;; "if ($?prompt) exit" before things which are not useful
2183 ;; non-interactively. Besides, if someone wants their other
2184 ;; aliases for shell commands then they can still have them.
2188 t)
2189 nil shell-command-switch command)
2196 ;; Do no formatting while reading error file,
2197 ;; because that can run a shell command, and we
2198 ;; don't want that to cause an infinite recursion.
2200 ;; Put point after the inserted errors.
2204 ;; This is like exchange-point-and-mark, but doesn't
2205 ;; activate the mark. It is cleaner to avoid activation,
2206 ;; even though the command loop would deactivate the mark
2207 ;; because we inserted text.
2211 ;; Output goes in a separate buffer.
2212 ;; Preserve the match data in case called from a program.
2215 ;; Command ending with ampersand means asynchronous.
2219 proc)
2220 ;; Remove the ampersand.
2222 ;; If will kill a process, query first.
2234 shell-command-switch command))
2238 ;; Use the comint filter for proper handling of carriage motion
2239 ;; (see `comint-inhibit-carriage-motion'),.
2241 ))
2242 ;; Otherwise, command is executed synchronously.
2244 output-buffer nil error-buffer)))))))
2248 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2249 MESSAGE may be either a string or a buffer.
2251 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2252 the maximum height of the echo area, as defined by `max-mini-window-height'
2253 if `resize-mini-windows' is non-nil.
2255 Returns either the string shown in the echo area, or when a pop-up
2256 buffer is used, the window used to display it.
2258 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2259 name of the buffer used to display it in the case where a pop-up buffer
2260 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2261 string and it is displayed in the echo area, it is not specified whether
2262 the contents are inserted into the buffer anyway.
2264 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2265 and only used if a buffer is displayed."
2267 ;; Trivial case where we can use the echo area
2271 ;; Trivial case where we can just remove single trailing newline
2274 ;; General case
2277 message
2286 0
2290 (<= lines
2294 max-mini-window-height))
2296 max-mini-window-height)
2300 ;; Don't use the echo area if the output buffer is
2301 ;; already dispayed in the selected frame.
2303 ;; Echo area
2309 ;; Buffer
2312 not-this-window frame))))))))
2315 ;; We have a sentinel to prevent insertion of a termination message
2316 ;; in the buffer itself.
2324 &optional output-buffer replace
2325 error-buffer display-error-buffer)
2326 "Execute string COMMAND in inferior shell with region as input.
2327 Normally display output (if any) in temp buffer `*Shell Command Output*';
2328 Prefix arg means replace the region with it. Return the exit code of
2329 COMMAND.
2331 To specify a coding system for converting non-ASCII characters
2333 before this command. By default, the input (from the current buffer)
2334 is encoded in the same coding system that will be used to save the file,
2335 `buffer-file-coding-system'. If the output is going to replace the region,
2336 then it is decoded from that same coding system.
2338 The noninteractive arguments are START, END, COMMAND,
2339 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2340 Noninteractive callers can specify coding systems by binding
2341 `coding-system-for-read' and `coding-system-for-write'.
2343 If the command generates output, the output may be displayed
2344 in the echo area or in a buffer.
2345 If the output is short enough to display in the echo area
2346 \(determined by the variable `max-mini-window-height' if
2347 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2348 it is displayed in the buffer `*Shell Command Output*'. The output
2349 is available in that buffer in both cases.
2351 If there is output and an error, a message about the error
2352 appears at the end of the output.
2354 If there is no output, or if output is inserted in the current buffer,
2355 then `*Shell Command Output*' is deleted.
2357 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2358 that says to put the output in some other buffer.
2359 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2360 If OUTPUT-BUFFER is not a buffer and not nil,
2361 insert output in the current buffer.
2362 In either case, the output is inserted after point (leaving mark after it).
2364 If REPLACE, the optional fifth argument, is non-nil, that means insert
2365 the output in place of text from START to END, putting point and mark
2366 around it.
2368 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2369 or buffer name to which to direct the command's standard error output.
2370 If it is nil, error output is mingled with regular output.
2371 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2372 were any errors. (This is always t, interactively.)
2373 In an interactive call, the variable `shell-command-default-error-buffer'
2374 specifies the value of ERROR-BUFFER."
2378 ;; Do this before calling region-beginning
2379 ;; and region-end, in case subprocess output
2380 ;; relocates them while we are in the minibuffer.
2382 ;; call-interactively recognizes region-beginning and
2383 ;; region-end specially, leaving them in the history.
2385 string
2386 current-prefix-arg
2387 current-prefix-arg
2388 shell-command-default-error-buffer
2389 t)))
2395 temporary-file-directory)))
2396 nil))
2397 exit-status)
2401 ;; Replace specified region with output from command.
2403 ;; Don't muck with mark unless REPLACE says we should.
2410 t)
2411 nil shell-command-switch command))
2412 ;; It is rude to delete a buffer which the command is not using.
2413 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2414 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2415 ;; (kill-buffer shell-buffer)))
2416 ;; Don't muck with mark unless REPLACE says we should.
2418 ;; No prefix argument: put the output in a temp buffer,
2419 ;; replacing its entire contents.
2424 ;; If the input is the same buffer as the output,
2425 ;; delete everything but the specified region,
2426 ;; then replace that region with the output.
2432 shell-file-name t
2435 t)
2436 nil shell-command-switch
2437 command)))
2438 ;; Clear the output buffer, then run the command with
2439 ;; output there.
2450 buffer)
2451 nil shell-command-switch command)))
2452 ;; Report the output.
2462 ;; There's some output, display it
2464 ;; No output; error?
2468 "some error output"
2474 output))
2477 exit-status))
2480 exit-status output))))
2481 ;; Don't kill: there might be useful info in the undo-log.
2482 ;; (kill-buffer buffer)
2483 ))))
2491 ;; Do no formatting while reading error file,
2492 ;; because that can run a shell command, and we
2493 ;; don't want that to cause an infinite recursion.
2495 ;; Put point after the inserted errors.
2500 exit-status))
2503 "Execute shell command COMMAND and return its output as a string."
2506 standard-output
2510 "Process files synchronously in a separate process.
2511 Similar to `call-process', but may invoke a file handler based on
2512 `default-directory'. The current working directory of the
2513 subprocess is `default-directory'.
2515 File names in INFILE and BUFFER are handled normally, but file
2516 names in ARGS should be relative to `default-directory', as they
2517 are passed to the process verbatim. \(This is a difference to
2518 `call-process' which does not support file handlers for INFILE
2519 and BUFFER.\)
2521 Some file handlers might not support all variants, for example
2522 they might behave as if DISPLAY was nil, regardless of the actual
2523 value passed."
2525 lc stderr-file)
2535 display args)
2541 "Whether a call of `process-file' changes remote files.
2543 Per default, this variable is always set to `t', meaning that a
2544 call of `process-file' could potentially change any file on a
2545 remote host. When set to `nil', a file handler could optimize
2546 its behaviour with respect to remote file attributes caching.
2548 This variable should never be changed by `setq'. Instead of, it
2552 "Start a program in a subprocess. Return the process object for it.
2554 Similar to `start-process', but may invoke a file handler based on
2555 `default-directory'. See Info node `(elisp)Magic File Names'.
2557 This handler ought to run PROGRAM, perhaps on the local host,
2558 perhaps on a remote host that corresponds to `default-directory'.
2559 In the latter case, the local part of `default-directory' becomes
2560 the working directory of the process.
2562 PROGRAM and PROGRAM-ARGS might be file names. They are not
2563 objects of file handler invocation. File handlers might not
2564 support pty association, if PROGRAM is nil."
2569 \f
2573 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2574 (define-key map [switch-frame] nil)
2575 (define-key map [?\C-u] 'universal-argument-more)
2576 (define-key map [?-] 'universal-argument-minus)
2577 (define-key map [?0] 'digit-argument)
2578 (define-key map [?1] 'digit-argument)
2579 (define-key map [?2] 'digit-argument)
2580 (define-key map [?3] 'digit-argument)
2581 (define-key map [?4] 'digit-argument)
2582 (define-key map [?5] 'digit-argument)
2583 (define-key map [?6] 'digit-argument)
2584 (define-key map [?7] 'digit-argument)
2585 (define-key map [?8] 'digit-argument)
2586 (define-key map [?9] 'digit-argument)
2587 (define-key map [kp-0] 'digit-argument)
2588 (define-key map [kp-1] 'digit-argument)
2589 (define-key map [kp-2] 'digit-argument)
2590 (define-key map [kp-3] 'digit-argument)
2591 (define-key map [kp-4] 'digit-argument)
2592 (define-key map [kp-5] 'digit-argument)
2593 (define-key map [kp-6] 'digit-argument)
2594 (define-key map [kp-7] 'digit-argument)
2595 (define-key map [kp-8] 'digit-argument)
2596 (define-key map [kp-9] 'digit-argument)
2597 (define-key map [kp-subtract] 'universal-argument-minus)
2598 map)
2601 (defvar universal-argument-num-events nil
2602 "Number of argument-specifying events read by `universal-argument'.
2603 `universal-argument-other-key' uses this to discard those events
2604 from (this-command-keys), and reread only the final command.")
2606 (defvar overriding-map-is-bound nil
2607 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2609 (defvar saved-overriding-map nil
2610 "The saved value of `overriding-terminal-local-map'.
2614 (defun ensure-overriding-map-is-bound ()
2615 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2616 (unless overriding-map-is-bound
2617 (setq saved-overriding-map overriding-terminal-local-map)
2618 (setq overriding-terminal-local-map universal-argument-map)
2619 (setq overriding-map-is-bound t)))
2621 (defun restore-overriding-map ()
2622 "Restore `overriding-terminal-local-map' to its saved value."
2623 (setq overriding-terminal-local-map saved-overriding-map)
2624 (setq overriding-map-is-bound nil))
2626 (defun universal-argument ()
2627 "Begin a numeric argument for the following command.
2632 multiplies the argument by 4 each time.
2634 which is different in effect from any particular numeric argument.
2636 (interactive)
2637 (setq prefix-arg (list 4))
2638 (setq universal-argument-num-events (length (this-command-keys)))
2639 (ensure-overriding-map-is-bound))
2641 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2642 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2643 (defun universal-argument-more (arg)
2644 (interactive "P")
2645 (if (consp arg)
2646 (setq prefix-arg (list (* 4 (car arg))))
2647 (if (eq arg '-)
2648 (setq prefix-arg (list -4))
2649 (setq prefix-arg arg)
2650 (restore-overriding-map)))
2651 (setq universal-argument-num-events (length (this-command-keys))))
2653 (defun negative-argument (arg)
2654 "Begin a negative numeric argument for the next command.
2656 (interactive "P")
2657 (cond ((integerp arg)
2658 (setq prefix-arg (- arg)))
2659 ((eq arg '-)
2660 (setq prefix-arg nil))
2661 (t
2662 (setq prefix-arg '-)))
2663 (setq universal-argument-num-events (length (this-command-keys)))
2664 (ensure-overriding-map-is-bound))
2666 (defun digit-argument (arg)
2667 "Part of the numeric argument for the next command.
2669 (interactive "P")
2670 (let* ((char (if (integerp last-command-event)
2671 last-command-event
2672 (get last-command-event 'ascii-character)))
2674 (cond ((integerp arg)
2675 (setq prefix-arg (+ (* arg 10)
2676 (if (< arg 0) (- digit) digit))))
2677 ((eq arg '-)
2678 ;; Treat -0 as just -, so that -01 will work.
2679 (setq prefix-arg (if (zerop digit) '- (- digit))))
2680 (t
2681 (setq prefix-arg digit))))
2682 (setq universal-argument-num-events (length (this-command-keys)))
2683 (ensure-overriding-map-is-bound))
2685 ;; For backward compatibility, minus with no modifiers is an ordinary
2686 ;; command if digits have already been entered.
2687 (defun universal-argument-minus (arg)
2688 (interactive "P")
2689 (if (integerp arg)
2690 (universal-argument-other-key arg)
2691 (negative-argument arg)))
2693 ;; Anything else terminates the argument and is left in the queue to be
2694 ;; executed as a command.
2695 (defun universal-argument-other-key (arg)
2696 (interactive "P")
2697 (setq prefix-arg arg)
2698 (let* ((key (this-command-keys))
2699 (keylist (listify-key-sequence key)))
2700 (setq unread-command-events
2701 (append (nthcdr universal-argument-num-events keylist)
2702 unread-command-events)))
2703 (reset-this-command-lengths)
2704 (restore-overriding-map))
2705 \f
2706 ;; This function is here rather than in subr.el because it uses CL.
2707 (defmacro with-wrapper-hook (var args &rest body)
2708 "Run BODY wrapped with the VAR hook.
2709 VAR is a special hook: its functions are called with a first argument
2711 the original function, or call it any number of times (including not calling
2712 it at all). This is similar to an `around' advice.
2713 VAR is normally a symbol (a variable) in which case it is treated like
2714 a hook, with a buffer-local and a global part. But it can also be an
2715 arbitrary expression.
2716 ARGS is a list of variables which will be passed as additional arguments
2717 to each function, after the initial argument, and which the first argument
2718 expects to receive when called."
2719 (declare (indent 2) (debug t))
2720 ;; We need those two gensyms because CL's lexical scoping is not available
2721 ;; for function arguments :-(
2722 (let ((funs (make-symbol "funs"))
2723 (global (make-symbol "global"))
2724 (argssym (make-symbol "args")))
2725 ;; Since the hook is a wrapper, the loop has to be done via
2726 ;; recursion: a given hook function will call its parameter in order to
2727 ;; continue looping.
2728 `(labels ((runrestofhook (,funs ,global ,argssym)
2729 ;; `funs' holds the functions left on the hook and `global'
2730 ;; holds the functions left on the global part of the hook
2731 ;; (in case the hook is local).
2732 (lexical-let ((funs ,funs)
2733 (global ,global))
2734 (if (consp funs)
2735 (if (eq t (car funs))
2736 (runrestofhook
2737 (append global (cdr funs)) nil ,argssym)
2738 (apply (car funs)
2739 (lambda (&rest ,argssym)
2740 (runrestofhook (cdr funs) global ,argssym))
2741 ,argssym))
2742 ;; Once there are no more functions on the hook, run
2743 ;; the original body.
2744 (apply (lambda ,args ,@body) ,argssym)))))
2745 (runrestofhook ,var
2746 ;; The global part of the hook, if any.
2747 ,(if (symbolp var)
2748 `(if (local-variable-p ',var)
2749 (default-value ',var)))
2750 (list ,@args)))))
2752 (defvar filter-buffer-substring-functions nil
2753 "Wrapper hook around `filter-buffer-substring'.
2754 The functions on this special hook are called with 4 arguments:
2755 NEXT-FUN BEG END DELETE
2756 NEXT-FUN is a function of 3 arguments (BEG END DELETE)
2757 that performs the default operation. The other 3 arguments are like
2758 the ones passed to `filter-buffer-substring'.")
2760 (defvar buffer-substring-filters nil
2761 "List of filter functions for `filter-buffer-substring'.
2762 Each function must accept a single argument, a string, and return
2763 a string. The buffer substring is passed to the first function
2764 in the list, and the return value of each function is passed to
2765 the next. The return value of the last function is used as the
2766 return value of `filter-buffer-substring'.
2768 If this variable is nil, no filtering is performed.")
2769 (make-obsolete-variable 'buffer-substring-filters
2770 'filter-buffer-substring-functions "24.1")
2772 (defun filter-buffer-substring (beg end &optional delete)
2773 "Return the buffer substring between BEG and END, after filtering.
2774 The filtering is performed by `filter-buffer-substring-functions'.
2776 If DELETE is non-nil, the text between BEG and END is deleted
2777 from the buffer.
2779 This function should be used instead of `buffer-substring',
2780 `buffer-substring-no-properties', or `delete-and-extract-region'
2781 when you want to allow filtering to take place. For example,
2782 major or minor modes can use `filter-buffer-substring-functions' to
2783 extract characters that are special to a buffer, and should not
2784 be copied into other buffers."
2785 (with-wrapper-hook filter-buffer-substring-functions (beg end delete)
2786 (cond
2787 ((or delete buffer-substring-filters)
2788 (save-excursion
2789 (goto-char beg)
2790 (let ((string (if delete (delete-and-extract-region beg end)
2791 (buffer-substring beg end))))
2792 (dolist (filter buffer-substring-filters)
2793 (setq string (funcall filter string)))
2794 string)))
2795 (t
2796 (buffer-substring beg end)))))
2799 ;;;; Window system cut and paste hooks.
2801 (defvar interprogram-cut-function nil
2802 "Function to call to make a killed region available to other programs.
2804 Most window systems provide some sort of facility for cutting and
2805 pasting text between the windows of different programs.
2806 This variable holds a function that Emacs calls whenever text
2807 is put in the kill ring, to make the new kill available to other
2808 programs.
2810 The function takes one or two arguments.
2811 The first argument, TEXT, is a string containing
2812 the text which should be made available.
2813 The second, optional, argument PUSH, has the same meaning as the
2814 similar argument to `x-set-cut-buffer', which see.")
2816 (defvar interprogram-paste-function nil
2817 "Function to call to get text cut from other programs.
2819 Most window systems provide some sort of facility for cutting and
2820 pasting text between the windows of different programs.
2821 This variable holds a function that Emacs calls to obtain
2822 text that other programs have provided for pasting.
2824 The function should be called with no arguments. If the function
2825 returns nil, then no other program has provided such text, and the top
2826 of the Emacs kill ring should be used. If the function returns a
2827 string, then the caller of the function \(usually `current-kill')
2828 should put this string in the kill ring as the latest kill.
2830 This function may also return a list of strings if the window
2831 system supports multiple selections. The first string will be
2832 used as the pasted text, but the other will be placed in the
2833 kill ring for easy access via `yank-pop'.
2835 Note that the function should return a string only if a program other
2836 than Emacs has provided a string for pasting; if Emacs provided the
2837 most recent string, the function should return nil. If it is
2838 difficult to tell whether Emacs or some other program provided the
2839 current string, it is probably good enough to return nil if the string
2840 is equal (according to `string=') to the last text Emacs provided.")
2841 \f
2844 ;;;; The kill ring data structure.
2846 (defvar kill-ring nil
2847 "List of killed text sequences.
2848 Since the kill ring is supposed to interact nicely with cut-and-paste
2849 facilities offered by window systems, use of this variable should
2850 interact nicely with `interprogram-cut-function' and
2851 `interprogram-paste-function'. The functions `kill-new',
2852 `kill-append', and `current-kill' are supposed to implement this
2853 interaction; you may want to use them instead of manipulating the kill
2854 ring directly.")
2856 (defcustom kill-ring-max 60
2857 "Maximum length of kill ring before oldest elements are thrown away."
2858 :type 'integer
2859 :group 'killing)
2861 (defvar kill-ring-yank-pointer nil
2862 "The tail of the kill ring whose car is the last thing yanked.")
2864 (defcustom save-interprogram-paste-before-kill nil
2865 "Save clipboard strings into kill ring before replacing them.
2866 When one selects something in another program to paste it into Emacs,
2867 but kills something in Emacs before actually pasting it,
2868 this selection is gone unless this variable is non-nil,
2869 in which case the other program's selection is saved in the `kill-ring'
2871 :type 'boolean
2872 :group 'killing
2873 :version "23.2")
2875 (defcustom kill-do-not-save-duplicates nil
2876 "Do not add a new string to `kill-ring' when it is the same as the last one."
2877 :type 'boolean
2878 :group 'killing
2879 :version "23.2")
2881 (defun kill-new (string &optional replace yank-handler)
2882 "Make STRING the latest kill in the kill ring.
2883 Set `kill-ring-yank-pointer' to point to it.
2884 If `interprogram-cut-function' is non-nil, apply it to STRING.
2885 Optional second argument REPLACE non-nil means that STRING will replace
2886 the front of the kill ring, rather than being added to the list.
2888 Optional third arguments YANK-HANDLER controls how the STRING is later
2889 inserted into a buffer; see `insert-for-yank' for details.
2890 When a yank handler is specified, STRING must be non-empty (the yank
2891 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2893 When `save-interprogram-paste-before-kill' and `interprogram-paste-function'
2894 are non-nil, saves the interprogram paste string(s) into `kill-ring' before
2895 STRING.
2897 When the yank handler has a non-nil PARAM element, the original STRING
2898 argument is not used by `insert-for-yank'. However, since Lisp code
2899 may access and use elements from the kill ring directly, the STRING
2901 (if (> (length string) 0)
2902 (if yank-handler
2903 (put-text-property 0 (length string)
2904 'yank-handler yank-handler string))
2905 (if yank-handler
2906 (signal 'args-out-of-range
2907 (list string "yank-handler specified for empty string"))))
2908 (unless (and kill-do-not-save-duplicates
2909 (equal string (car kill-ring)))
2910 (if (fboundp 'menu-bar-update-yank-menu)
2911 (menu-bar-update-yank-menu string (and replace (car kill-ring)))))
2912 (when save-interprogram-paste-before-kill
2913 (let ((interprogram-paste (and interprogram-paste-function
2914 (funcall interprogram-paste-function))))
2915 (when interprogram-paste
2916 (dolist (s (if (listp interprogram-paste)
2917 (nreverse interprogram-paste)
2918 (list interprogram-paste)))
2919 (unless (and kill-do-not-save-duplicates
2920 (equal s (car kill-ring)))
2921 (push s kill-ring))))))
2922 (unless (and kill-do-not-save-duplicates
2923 (equal string (car kill-ring)))
2924 (if (and replace kill-ring)
2925 (setcar kill-ring string)
2926 (push string kill-ring)
2927 (if (> (length kill-ring) kill-ring-max)
2928 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil))))
2929 (setq kill-ring-yank-pointer kill-ring)
2930 (if interprogram-cut-function
2931 (funcall interprogram-cut-function string (not replace))))
2933 (defun kill-append (string before-p &optional yank-handler)
2934 "Append STRING to the end of the latest kill in the kill ring.
2935 If BEFORE-P is non-nil, prepend STRING to the kill.
2936 Optional third argument YANK-HANDLER, if non-nil, specifies the
2937 yank-handler text property to be set on the combined kill ring
2938 string. If the specified yank-handler arg differs from the
2939 yank-handler property of the latest kill string, this function
2940 adds the combined string to the kill ring as a new element,
2941 instead of replacing the last kill with it.
2942 If `interprogram-cut-function' is set, pass the resulting kill to it."
2943 (let* ((cur (car kill-ring)))
2944 (kill-new (if before-p (concat string cur) (concat cur string))
2945 (or (= (length cur) 0)
2946 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2947 yank-handler)))
2949 (defcustom yank-pop-change-selection nil
2950 "If non-nil, rotating the kill ring changes the window system selection."
2951 :type 'boolean
2952 :group 'killing
2953 :version "23.1")
2955 (defun current-kill (n &optional do-not-move)
2956 "Rotate the yanking point by N places, and then return that kill.
2957 If N is zero, `interprogram-paste-function' is set, and calling
2958 it returns a string or list of strings, then that string (or
2959 list) is added to the front of the kill ring and the string (or
2960 first string in the list) is returned as the latest kill.
2962 If N is not zero, and if `yank-pop-change-selection' is
2963 non-nil, use `interprogram-cut-function' to transfer the
2964 kill at the new yank point into the window system selection.
2966 If optional arg DO-NOT-MOVE is non-nil, then don't actually
2967 move the yanking point; just return the Nth kill forward."
2969 (let ((interprogram-paste (and (= n 0)
2970 interprogram-paste-function
2971 (funcall interprogram-paste-function))))
2972 (if interprogram-paste
2973 (progn
2974 ;; Disable the interprogram cut function when we add the new
2975 ;; text to the kill ring, so Emacs doesn't try to own the
2976 ;; selection, with identical text.
2977 (let ((interprogram-cut-function nil))
2978 (if (listp interprogram-paste)
2979 (mapc 'kill-new (nreverse interprogram-paste))
2980 (kill-new interprogram-paste)))
2981 (car kill-ring))
2982 (or kill-ring (error "Kill ring is empty"))
2983 (let ((ARGth-kill-element
2984 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2985 (length kill-ring))
2986 kill-ring)))
2987 (unless do-not-move
2988 (setq kill-ring-yank-pointer ARGth-kill-element)
2989 (when (and yank-pop-change-selection
2990 (> n 0)
2991 interprogram-cut-function)
2992 (funcall interprogram-cut-function (car ARGth-kill-element))))
2993 (car ARGth-kill-element)))))
2997 ;;;; Commands for manipulating the kill ring.
2999 (defcustom kill-read-only-ok nil
3000 "Non-nil means don't signal an error for killing read-only text."
3001 :type 'boolean
3002 :group 'killing)
3004 (put 'text-read-only 'error-conditions
3005 '(text-read-only buffer-read-only error))
3006 (put 'text-read-only 'error-message (purecopy "Text is read-only"))
3008 (defun kill-region (beg end &optional yank-handler)
3010 This deletes the text from the buffer and saves it in the kill ring.
3014 If you want to append the killed region to the last killed text,
3017 If the buffer is read-only, Emacs will beep and refrain from deleting
3018 the text, but put the text in the kill ring anyway. This means that
3019 you can use the killing commands to copy text from a read-only buffer.
3021 This is the primitive for programs to kill text (as opposed to deleting it).
3022 Supply two arguments, character positions indicating the stretch of text
3023 to be killed.
3025 If the previous command was also a kill command,
3026 the text killed this time appends to the text killed last time
3027 to make one entry in the kill ring.
3029 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
3030 specifies the yank-handler text property to be set on the killed
3031 text. See `insert-for-yank'."
3032 ;; Pass point first, then mark, because the order matters
3033 ;; when calling kill-append.
3034 (interactive (list (point) (mark)))
3035 (unless (and beg end)
3036 (error "The mark is not set now, so there is no region"))
3037 (condition-case nil
3038 (let ((string (filter-buffer-substring beg end t)))
3039 (when string ;STRING is nil if BEG = END
3040 ;; Add that string to the kill ring, one way or another.
3041 (if (eq last-command 'kill-region)
3042 (kill-append string (< end beg) yank-handler)
3043 (kill-new string nil yank-handler)))
3044 (when (or string (eq last-command 'kill-region))
3045 (setq this-command 'kill-region))
3046 nil)
3047 ((buffer-read-only text-read-only)
3048 ;; The code above failed because the buffer, or some of the characters
3049 ;; in the region, are read-only.
3050 ;; We should beep, in case the user just isn't aware of this.
3051 ;; However, there's no harm in putting
3052 ;; the region's text in the kill ring, anyway.
3053 (copy-region-as-kill beg end)
3054 ;; Set this-command now, so it will be set even if we get an error.
3055 (setq this-command 'kill-region)
3056 ;; This should barf, if appropriate, and give us the correct error.
3057 (if kill-read-only-ok
3058 (progn (message "Read only text copied to kill ring") nil)
3059 ;; Signal an error if the buffer is read-only.
3060 (barf-if-buffer-read-only)
3061 ;; If the buffer isn't read-only, the text is.
3062 (signal 'text-read-only (list (current-buffer)))))))
3064 ;; copy-region-as-kill no longer sets this-command, because it's confusing
3065 ;; to get two copies of the text when the user accidentally types M-w and
3066 ;; then corrects it with the intended C-w.
3067 (defun copy-region-as-kill (beg end)
3068 "Save the region as if killed, but don't kill it.
3069 In Transient Mark mode, deactivate the mark.
3070 If `interprogram-cut-function' is non-nil, also save the text for a window
3071 system cut and paste.
3073 This command's old key binding has been given to `kill-ring-save'."
3074 (interactive "r")
3075 (if (eq last-command 'kill-region)
3076 (kill-append (filter-buffer-substring beg end) (< end beg))
3077 (kill-new (filter-buffer-substring beg end)))
3078 (setq deactivate-mark t)
3079 nil)
3081 (defun kill-ring-save (beg end)
3082 "Save the region as if killed, but don't kill it.
3083 In Transient Mark mode, deactivate the mark.
3084 If `interprogram-cut-function' is non-nil, also save the text for a window
3085 system cut and paste.
3087 If you want to append the killed line to the last killed text,
3090 This command is similar to `copy-region-as-kill', except that it gives
3091 visual feedback indicating the extent of the region being copied."
3092 (interactive "r")
3093 (copy-region-as-kill beg end)
3094 ;; This use of called-interactively-p is correct
3095 ;; because the code it controls just gives the user visual feedback.
3096 (if (called-interactively-p 'interactive)
3097 (let ((other-end (if (= (point) beg) end beg))
3098 (opoint (point))
3099 ;; Inhibit quitting so we can make a quit here
3100 ;; look like a C-g typed as a command.
3101 (inhibit-quit t))
3102 (if (pos-visible-in-window-p other-end (selected-window))
3103 ;; Swap point-and-mark quickly so as to show the region that
3104 ;; was selected. Don't do it if the region is highlighted.
3105 (unless (and (region-active-p)
3106 (face-background 'region))
3107 ;; Swap point and mark.
3108 (set-marker (mark-marker) (point) (current-buffer))
3109 (goto-char other-end)
3110 (sit-for blink-matching-delay)
3111 ;; Swap back.
3112 (set-marker (mark-marker) other-end (current-buffer))
3113 (goto-char opoint)
3114 ;; If user quit, deactivate the mark
3115 ;; as C-g would as a command.
3116 (and quit-flag mark-active
3117 (deactivate-mark)))
3118 (let* ((killed-text (current-kill 0))
3119 (message-len (min (length killed-text) 40)))
3120 (if (= (point) beg)
3121 ;; Don't say "killed"; that is misleading.
3123 (substring killed-text (- message-len)))
3125 (substring killed-text 0 message-len))))))))
3127 (defun append-next-kill (&optional interactive)
3128 "Cause following command, if it kills, to append to previous kill.
3129 The argument is used for internal purposes; do not supply one."
3130 (interactive "p")
3131 ;; We don't use (interactive-p), since that breaks kbd macros.
3132 (if interactive
3133 (progn
3134 (setq this-command 'kill-region)
3135 (message "If the next command is a kill, it will append"))
3136 (setq last-command 'kill-region)))
3137 \f
3138 ;; Yanking.
3140 ;; This is actually used in subr.el but defcustom does not work there.
3141 (defcustom yank-excluded-properties
3142 '(read-only invisible intangible field mouse-face help-echo local-map keymap
3143 yank-handler follow-link fontified)
3144 "Text properties to discard when yanking.
3145 The value should be a list of text properties to discard or t,
3146 which means to discard all text properties."
3147 :type '(choice (const :tag "All" t) (repeat symbol))
3148 :group 'killing
3149 :version "22.1")
3151 (defvar yank-window-start nil)
3152 (defvar yank-undo-function nil
3153 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
3154 Function is called with two parameters, START and END corresponding to
3155 the value of the mark and point; it is guaranteed that START <= END.
3156 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
3158 (defun yank-pop (&optional arg)
3159 "Replace just-yanked stretch of killed text with a different stretch.
3160 This command is allowed only immediately after a `yank' or a `yank-pop'.
3161 At such a time, the region contains a stretch of reinserted
3162 previously-killed text. `yank-pop' deletes that text and inserts in its
3163 place a different stretch of killed text.
3165 With no argument, the previous kill is inserted.
3166 With argument N, insert the Nth previous kill.
3167 If N is negative, this is a more recent kill.
3169 The sequence of kills wraps around, so that after the oldest one
3170 comes the newest one.
3172 When this command inserts killed text into the buffer, it honors
3173 `yank-excluded-properties' and `yank-handler' as described in the
3174 doc string for `insert-for-yank-1', which see."
3175 (interactive "*p")
3176 (if (not (eq last-command 'yank))
3177 (error "Previous command was not a yank"))
3178 (setq this-command 'yank)
3179 (unless arg (setq arg 1))
3180 (let ((inhibit-read-only t)
3181 (before (< (point) (mark t))))
3182 (if before
3183 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3184 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3185 (setq yank-undo-function nil)
3186 (set-marker (mark-marker) (point) (current-buffer))
3187 (insert-for-yank (current-kill arg))
3188 ;; Set the window start back where it was in the yank command,
3189 ;; if possible.
3190 (set-window-start (selected-window) yank-window-start t)
3191 (if before
3192 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3193 ;; It is cleaner to avoid activation, even though the command
3194 ;; loop would deactivate the mark because we inserted text.
3195 (goto-char (prog1 (mark t)
3196 (set-marker (mark-marker) (point) (current-buffer))))))
3197 nil)
3199 (defun yank (&optional arg)
3201 More precisely, reinsert the stretch of killed text most recently
3202 killed OR yanked. Put point at end, and set mark at beginning.
3203 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3204 With argument N, reinsert the Nth most recently killed stretch of killed
3205 text.
3207 When this command inserts killed text into the buffer, it honors
3208 `yank-excluded-properties' and `yank-handler' as described in the
3209 doc string for `insert-for-yank-1', which see.
3212 (interactive "*P")
3213 (setq yank-window-start (window-start))
3214 ;; If we don't get all the way thru, make last-command indicate that
3215 ;; for the following command.
3216 (setq this-command t)
3217 (push-mark (point))
3218 (insert-for-yank (current-kill (cond
3219 ((listp arg) 0)
3220 ((eq arg '-) -2)
3221 (t (1- arg)))))
3222 (if (consp arg)
3223 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3224 ;; It is cleaner to avoid activation, even though the command
3225 ;; loop would deactivate the mark because we inserted text.
3226 (goto-char (prog1 (mark t)
3227 (set-marker (mark-marker) (point) (current-buffer)))))
3228 ;; If we do get all the way thru, make this-command indicate that.
3229 (if (eq this-command t)
3230 (setq this-command 'yank))
3231 nil)
3233 (defun rotate-yank-pointer (arg)
3234 "Rotate the yanking point in the kill ring.
3235 With ARG, rotate that many kills forward (or backward, if negative)."
3236 (interactive "p")
3237 (current-kill arg))
3238 \f
3239 ;; Some kill commands.
3241 ;; Internal subroutine of delete-char
3242 (defun kill-forward-chars (arg)
3243 (if (listp arg) (setq arg (car arg)))
3244 (if (eq arg '-) (setq arg -1))
3245 (kill-region (point) (+ (point) arg)))
3247 ;; Internal subroutine of backward-delete-char
3248 (defun kill-backward-chars (arg)
3249 (if (listp arg) (setq arg (car arg)))
3250 (if (eq arg '-) (setq arg -1))
3251 (kill-region (point) (- (point) arg)))
3253 (defcustom backward-delete-char-untabify-method 'untabify
3254 "The method for untabifying when deleting backward.
3255 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3256 `hungry' -- delete all whitespace, both tabs and spaces;
3257 `all' -- delete all whitespace, including tabs, spaces and newlines;
3258 nil -- just delete one character."
3259 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3260 :version "20.3"
3261 :group 'killing)
3263 (defun backward-delete-char-untabify (arg &optional killp)
3264 "Delete characters backward, changing tabs into spaces.
3265 The exact behavior depends on `backward-delete-char-untabify-method'.
3266 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3267 Interactively, ARG is the prefix arg (default 1)
3268 and KILLP is t if a prefix arg was specified."
3270 (when (eq backward-delete-char-untabify-method 'untabify)
3271 (let ((count arg))
3272 (save-excursion
3273 (while (and (> count 0) (not (bobp)))
3275 (let ((col (current-column)))
3276 (forward-char -1)
3277 (setq col (- col (current-column)))
3278 (insert-char ?\s col)
3279 (delete-char 1)))
3280 (forward-char -1)
3281 (setq count (1- count))))))
3282 (delete-backward-char
3284 ((eq backward-delete-char-untabify-method 'all)
3286 (if skip
3287 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3288 (point)))))
3289 (+ arg (if (zerop wh) 0 (1- wh))))
3290 arg))
3291 killp))
3293 (defun zap-to-char (arg char)
3294 "Kill up to and including ARGth occurrence of CHAR.
3295 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3296 Goes backward if ARG is negative; error if CHAR not found."
3298 ;; Avoid "obsolete" warnings for translation-table-for-input.
3299 (with-no-warnings
3300 (if (char-table-p translation-table-for-input)
3301 (setq char (or (aref translation-table-for-input char) char))))
3302 (kill-region (point) (progn
3303 (search-forward (char-to-string char) nil nil arg)
3304 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3305 (point))))
3307 ;; kill-line and its subroutines.
3309 (defcustom kill-whole-line nil
3310 "If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3311 :type 'boolean
3312 :group 'killing)
3314 (defun kill-line (&optional arg)
3315 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3316 With prefix argument ARG, kill that many lines from point.
3317 Negative arguments kill lines backward.
3318 With zero argument, kills the text before point on the current line.
3321 a number counts as a prefix arg.
3323 To kill a whole line, when point is not at the beginning, type \
3326 If `kill-whole-line' is non-nil, then this command kills the whole line
3327 including its terminating newline, when used at the beginning of a line
3328 with no argument. As a consequence, you can always kill a whole line
3331 If you want to append the killed line to the last killed text,
3334 If the buffer is read-only, Emacs will beep and refrain from deleting
3335 the line, but put the line in the kill ring anyway. This means that
3336 you can use this command to copy text from a read-only buffer.
3337 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3338 even beep.)"
3339 (interactive "P")
3340 (kill-region (point)
3341 ;; It is better to move point to the other end of the kill
3342 ;; before killing. That way, in a read-only buffer, point
3343 ;; moves across the text that is copied to the kill ring.
3344 ;; The choice has no effect on undo now that undo records
3345 ;; the value of point from before the command was run.
3346 (progn
3347 (if arg
3348 (forward-visible-line (prefix-numeric-value arg))
3349 (if (eobp)
3350 (signal 'end-of-buffer nil))
3351 (let ((end
3352 (save-excursion
3353 (end-of-visible-line) (point))))
3354 (if (or (save-excursion
3355 ;; If trailing whitespace is visible,
3356 ;; don't treat it as nothing.
3357 (unless show-trailing-whitespace
3359 (= (point) end))
3360 (and kill-whole-line (bolp)))
3361 (forward-visible-line 1)
3362 (goto-char end))))
3363 (point))))
3365 (defun kill-whole-line (&optional arg)
3366 "Kill current line.
3367 With prefix ARG, kill that many lines starting from the current line.
3368 If ARG is negative, kill backward. Also kill the preceding newline.
3370 If ARG is zero, kill current line but exclude the trailing newline."
3371 (interactive "p")
3372 (or arg (setq arg 1))
3373 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3374 (signal 'end-of-buffer nil))
3375 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3376 (signal 'beginning-of-buffer nil))
3377 (unless (eq last-command 'kill-region)
3378 (kill-new "")
3379 (setq last-command 'kill-region))
3380 (cond ((zerop arg)
3381 ;; We need to kill in two steps, because the previous command
3382 ;; could have been a kill command, in which case the text
3383 ;; before point needs to be prepended to the current kill
3384 ;; ring entry and the text after point appended. Also, we
3385 ;; need to use save-excursion to avoid copying the same text
3386 ;; twice to the kill ring in read-only buffers.
3387 (save-excursion
3388 (kill-region (point) (progn (forward-visible-line 0) (point))))
3389 (kill-region (point) (progn (end-of-visible-line) (point))))
3390 ((< arg 0)
3391 (save-excursion
3392 (kill-region (point) (progn (end-of-visible-line) (point))))
3393 (kill-region (point)
3394 (progn (forward-visible-line (1+ arg))
3395 (unless (bobp) (backward-char))
3396 (point))))
3397 (t
3398 (save-excursion
3399 (kill-region (point) (progn (forward-visible-line 0) (point))))
3400 (kill-region (point)
3401 (progn (forward-visible-line arg) (point))))))
3403 (defun forward-visible-line (arg)
3404 "Move forward by ARG lines, ignoring currently invisible newlines only.
3405 If ARG is negative, move backward -ARG lines.
3406 If ARG is zero, move to the beginning of the current line."
3407 (condition-case nil
3408 (if (> arg 0)
3409 (progn
3410 (while (> arg 0)
3411 (or (zerop (forward-line 1))
3412 (signal 'end-of-buffer nil))
3413 ;; If the newline we just skipped is invisible,
3414 ;; don't count it.
3415 (let ((prop
3416 (get-char-property (1- (point)) 'invisible)))
3417 (if (if (eq buffer-invisibility-spec t)
3418 prop
3419 (or (memq prop buffer-invisibility-spec)
3420 (assq prop buffer-invisibility-spec)))
3421 (setq arg (1+ arg))))
3422 (setq arg (1- arg)))
3423 ;; If invisible text follows, and it is a number of complete lines,
3424 ;; skip it.
3425 (let ((opoint (point)))
3426 (while (and (not (eobp))
3427 (let ((prop
3428 (get-char-property (point) 'invisible)))
3429 (if (eq buffer-invisibility-spec t)
3430 prop
3431 (or (memq prop buffer-invisibility-spec)
3432 (assq prop buffer-invisibility-spec)))))
3433 (goto-char
3434 (if (get-text-property (point) 'invisible)
3435 (or (next-single-property-change (point) 'invisible)
3436 (point-max))
3437 (next-overlay-change (point)))))
3438 (unless (bolp)
3439 (goto-char opoint))))
3440 (let ((first t))
3441 (while (or first (<= arg 0))
3442 (if first
3443 (beginning-of-line)
3444 (or (zerop (forward-line -1))
3445 (signal 'beginning-of-buffer nil)))
3446 ;; If the newline we just moved to is invisible,
3447 ;; don't count it.
3448 (unless (bobp)
3449 (let ((prop
3450 (get-char-property (1- (point)) 'invisible)))
3451 (unless (if (eq buffer-invisibility-spec t)
3452 prop
3453 (or (memq prop buffer-invisibility-spec)
3454 (assq prop buffer-invisibility-spec)))
3455 (setq arg (1+ arg)))))
3456 (setq first nil))
3457 ;; If invisible text follows, and it is a number of complete lines,
3458 ;; skip it.
3459 (let ((opoint (point)))
3460 (while (and (not (bobp))
3461 (let ((prop
3462 (get-char-property (1- (point)) 'invisible)))
3463 (if (eq buffer-invisibility-spec t)
3464 prop
3465 (or (memq prop buffer-invisibility-spec)
3466 (assq prop buffer-invisibility-spec)))))
3467 (goto-char
3468 (if (get-text-property (1- (point)) 'invisible)
3469 (or (previous-single-property-change (point) 'invisible)
3470 (point-min))
3471 (previous-overlay-change (point)))))
3472 (unless (bolp)
3473 (goto-char opoint)))))
3474 ((beginning-of-buffer end-of-buffer)
3475 nil)))
3477 (defun end-of-visible-line ()
3478 "Move to end of current visible line."
3479 (end-of-line)
3480 ;; If the following character is currently invisible,
3481 ;; skip all characters with that same `invisible' property value,
3482 ;; then find the next newline.
3483 (while (and (not (eobp))
3484 (save-excursion
3486 (let ((prop
3487 (get-char-property (point) 'invisible)))
3488 (if (eq buffer-invisibility-spec t)
3489 prop
3490 (or (memq prop buffer-invisibility-spec)
3491 (assq prop buffer-invisibility-spec))))))
3493 (if (get-text-property (point) 'invisible)
3494 (goto-char (next-single-property-change (point) 'invisible))
3495 (goto-char (next-overlay-change (point))))
3496 (end-of-line)))
3497 \f
3498 (defun insert-buffer (buffer)
3499 "Insert after point the contents of BUFFER.
3500 Puts mark after the inserted text.
3501 BUFFER may be a buffer or a buffer name.
3503 This function is meant for the user to run interactively.
3504 Don't call it from programs: use `insert-buffer-substring' instead!"
3505 (interactive
3506 (list
3507 (progn
3508 (barf-if-buffer-read-only)
3509 (read-buffer "Insert buffer: "
3510 (if (eq (selected-window) (next-window (selected-window)))
3511 (other-buffer (current-buffer))
3512 (window-buffer (next-window (selected-window))))
3513 t))))
3514 (push-mark
3515 (save-excursion
3516 (insert-buffer-substring (get-buffer buffer))
3517 (point)))
3518 nil)
3520 (defun append-to-buffer (buffer start end)
3521 "Append to specified buffer the text of the region.
3522 It is inserted into that buffer before its point.
3524 When calling from a program, give three arguments:
3525 BUFFER (or buffer name), START and END.
3526 START and END specify the portion of the current buffer to be copied."
3527 (interactive
3528 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3529 (region-beginning) (region-end)))
3530 (let* ((oldbuf (current-buffer))
3531 (append-to (get-buffer-create buffer))
3532 (windows (get-buffer-window-list append-to t t))
3533 point)
3534 (save-excursion
3535 (with-current-buffer append-to
3536 (setq point (point))
3537 (barf-if-buffer-read-only)
3538 (insert-buffer-substring oldbuf start end)
3539 (dolist (window windows)
3540 (when (= (window-point window) point)
3541 (set-window-point window (point))))))))
3543 (defun prepend-to-buffer (buffer start end)
3544 "Prepend to specified buffer the text of the region.
3545 It is inserted into that buffer after its point.
3547 When calling from a program, give three arguments:
3548 BUFFER (or buffer name), START and END.
3549 START and END specify the portion of the current buffer to be copied."
3551 (let ((oldbuf (current-buffer)))
3552 (with-current-buffer (get-buffer-create buffer)
3553 (barf-if-buffer-read-only)
3554 (save-excursion
3555 (insert-buffer-substring oldbuf start end)))))
3557 (defun copy-to-buffer (buffer start end)
3558 "Copy to specified buffer the text of the region.
3559 It is inserted into that buffer, replacing existing text there.
3561 When calling from a program, give three arguments:
3562 BUFFER (or buffer name), START and END.
3563 START and END specify the portion of the current buffer to be copied."
3565 (let ((oldbuf (current-buffer)))
3566 (with-current-buffer (get-buffer-create buffer)
3567 (barf-if-buffer-read-only)
3568 (erase-buffer)
3569 (save-excursion
3570 (insert-buffer-substring oldbuf start end)))))
3571 \f
3572 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3573 (put 'mark-inactive 'error-message (purecopy "The mark is not active now"))
3575 (defvar activate-mark-hook nil
3576 "Hook run when the mark becomes active.
3577 It is also run at the end of a command, if the mark is active and
3578 it is possible that the region may have changed.")
3580 (defvar deactivate-mark-hook nil
3581 "Hook run when the mark becomes inactive.")
3583 (defun mark (&optional force)
3584 "Return this buffer's mark value as integer, or nil if never set.
3586 In Transient Mark mode, this function signals an error if
3587 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3588 or the argument FORCE is non-nil, it disregards whether the mark
3589 is active, and returns an integer or nil in the usual way.
3591 If you are using this in an editing command, you are most likely making
3592 a mistake; see the documentation of `set-mark'."
3593 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3594 (marker-position (mark-marker))
3595 (signal 'mark-inactive nil)))
3597 (defcustom select-active-regions nil
3598 "If non-nil, an active region automatically becomes the window selection."
3599 :type 'boolean
3600 :group 'killing
3601 :version "23.1")
3603 (declare-function x-selection-owner-p "xselect.c" (&optional selection))
3605 ;; Many places set mark-active directly, and several of them failed to also
3606 ;; run deactivate-mark-hook. This shorthand should simplify.
3607 (defsubst deactivate-mark (&optional force)
3608 "Deactivate the mark by setting `mark-active' to nil.
3609 Unless FORCE is non-nil, this function does nothing if Transient
3610 Mark mode is disabled.
3611 This function also runs `deactivate-mark-hook'."
3612 (when (or transient-mark-mode force)
3613 ;; Copy the latest region into the primary selection, if desired.
3614 (and select-active-regions
3615 mark-active
3616 (display-selections-p)
3617 (x-selection-owner-p 'PRIMARY)
3618 (x-set-selection 'PRIMARY (buffer-substring-no-properties
3619 (region-beginning) (region-end))))
3620 (if (and (null force)
3621 (or (eq transient-mark-mode 'lambda)
3622 (and (eq (car-safe transient-mark-mode) 'only)
3623 (null (cdr transient-mark-mode)))))
3624 ;; When deactivating a temporary region, don't change
3625 ;; `mark-active' or run `deactivate-mark-hook'.
3626 (setq transient-mark-mode nil)
3627 (if (eq (car-safe transient-mark-mode) 'only)
3628 (setq transient-mark-mode (cdr transient-mark-mode)))
3629 (setq mark-active nil)
3630 (run-hooks 'deactivate-mark-hook))))
3632 (defun activate-mark ()
3633 "Activate the mark."
3634 (when (mark t)
3635 (setq mark-active t)
3636 (unless transient-mark-mode
3637 (setq transient-mark-mode 'lambda))
3638 (when (and select-active-regions
3639 (display-selections-p))
3640 (x-set-selection 'PRIMARY (current-buffer)))))
3642 (defun set-mark (pos)
3643 "Set this buffer's mark to POS. Don't use this function!
3644 That is to say, don't use this function unless you want
3645 the user to see that the mark has moved, and you want the previous
3646 mark position to be lost.
3648 Normally, when a new mark is set, the old one should go on the stack.
3649 This is why most applications should use `push-mark', not `set-mark'.
3651 Novice Emacs Lisp programmers often try to use the mark for the wrong
3652 purposes. The mark saves a location for the user's convenience.
3653 Most editing commands should not alter the mark.
3654 To remember a location for internal use in the Lisp program,
3655 store it in a Lisp variable. Example:
3657 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3659 (if pos
3660 (progn
3661 (setq mark-active t)
3662 (run-hooks 'activate-mark-hook)
3663 (when (and select-active-regions
3664 (display-selections-p))
3665 (x-set-selection 'PRIMARY (current-buffer)))
3666 (set-marker (mark-marker) pos (current-buffer)))
3667 ;; Normally we never clear mark-active except in Transient Mark mode.
3668 ;; But when we actually clear out the mark value too, we must
3669 ;; clear mark-active in any mode.
3670 (deactivate-mark t)
3671 (set-marker (mark-marker) nil)))
3673 (defcustom use-empty-active-region nil
3675 If nil, region-aware commands treat empty regions as inactive.
3676 If non-nil, region-aware commands treat the region as active as
3677 long as the mark is active, even if the region is empty.
3679 Region-aware commands are those that act on the region if it is
3680 active and Transient Mark mode is enabled, and on the text near
3681 point otherwise."
3682 :type 'boolean
3683 :version "23.1"
3684 :group 'editing-basics)
3686 (defun use-region-p ()
3687 "Return t if the region is active and it is appropriate to act on it.
3688 This is used by commands that act specially on the region under
3689 Transient Mark mode.
3691 The return value is t provided Transient Mark mode is enabled and
3692 the mark is active; and, when `use-empty-active-region' is
3693 non-nil, provided the region is empty. Otherwise, the return
3694 value is nil.
3696 For some commands, it may be appropriate to ignore the value of
3697 `use-empty-active-region'; in that case, use `region-active-p'."
3698 (and (region-active-p)
3699 (or use-empty-active-region (> (region-end) (region-beginning)))))
3701 (defun region-active-p ()
3702 "Return t if Transient Mark mode is enabled and the mark is active.
3704 Some commands act specially on the region when Transient Mark
3705 mode is enabled. Usually, such commands should use
3706 `use-region-p' instead of this function, because `use-region-p'
3707 also checks the value of `use-empty-active-region'."
3708 (and transient-mark-mode mark-active))
3710 (defvar mark-ring nil
3711 "The list of former marks of the current buffer, most recent first.")
3712 (make-variable-buffer-local 'mark-ring)
3713 (put 'mark-ring 'permanent-local t)
3715 (defcustom mark-ring-max 16
3716 "Maximum size of mark ring. Start discarding off end if gets this big."
3717 :type 'integer
3718 :group 'editing-basics)
3720 (defvar global-mark-ring nil
3721 "The list of saved global marks, most recent first.")
3723 (defcustom global-mark-ring-max 16
3724 "Maximum size of global mark ring. \
3725 Start discarding off end if gets this big."
3726 :type 'integer
3727 :group 'editing-basics)
3729 (defun pop-to-mark-command ()
3730 "Jump to mark, and pop a new position for mark off the ring.
3731 \(Does not affect global mark ring\)."
3732 (interactive)
3733 (if (null (mark t))
3734 (error "No mark set in this buffer")
3735 (if (= (point) (mark t))
3736 (message "Mark popped"))
3737 (goto-char (mark t))
3738 (pop-mark)))
3740 (defun push-mark-command (arg &optional nomsg)
3741 "Set mark at where point is.
3742 If no prefix ARG and mark is already set there, just activate it.
3743 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3744 (interactive "P")
3745 (let ((mark (marker-position (mark-marker))))
3746 (if (or arg (null mark) (/= mark (point)))
3747 (push-mark nil nomsg t)
3748 (setq mark-active t)
3749 (run-hooks 'activate-mark-hook)
3750 (unless nomsg
3751 (message "Mark activated")))))
3753 (defcustom set-mark-command-repeat-pop nil
3756 will pop the mark twice, and
3758 will pop the mark three times.
3762 :type 'boolean
3763 :group 'editing-basics)
3765 (defcustom set-mark-default-inactive nil
3766 "If non-nil, setting the mark does not activate it.
3768 behave the same whether or not `transient-mark-mode' is enabled."
3769 :type 'boolean
3770 :group 'editing-basics
3771 :version "23.1")
3773 (defun set-mark-command (arg)
3774 "Set the mark where point is, or jump to the mark.
3775 Setting the mark also alters the region, which is the text
3776 between point and mark; this is the closest equivalent in
3779 With no prefix argument, set the mark at point, and push the
3780 old mark position on local mark ring. Also push the old mark on
3781 global mark ring, if the previous mark was set in another buffer.
3783 When Transient Mark Mode is off, immediately repeating this
3784 command activates `transient-mark-mode' temporarily.
3787 jump to the mark, and set the mark from
3788 position popped off the local mark ring \(this does not affect the global
3790 mark ring \(see `pop-global-mark'\).
3792 If `set-mark-command-repeat-pop' is non-nil, repeating
3794 off the local (or global) mark ring and jumps there.
3797 argument, unconditionally set mark where point is, even if
3798 `set-mark-command-repeat-pop' is non-nil.
3800 Novice Emacs Lisp programmers often try to use the mark for the wrong
3801 purposes. See the documentation of `set-mark' for more information."
3802 (interactive "P")
3803 (cond ((eq transient-mark-mode 'lambda)
3804 (setq transient-mark-mode nil))
3805 ((eq (car-safe transient-mark-mode) 'only)
3806 (deactivate-mark)))
3807 (cond
3808 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3809 (push-mark-command nil))
3810 ((not (eq this-command 'set-mark-command))
3811 (if arg
3812 (pop-to-mark-command)
3813 (push-mark-command t)))
3814 ((and set-mark-command-repeat-pop
3815 (eq last-command 'pop-to-mark-command))
3816 (setq this-command 'pop-to-mark-command)
3817 (pop-to-mark-command))
3818 ((and set-mark-command-repeat-pop
3819 (eq last-command 'pop-global-mark)
3820 (not arg))
3821 (setq this-command 'pop-global-mark)
3822 (pop-global-mark))
3823 (arg
3824 (setq this-command 'pop-to-mark-command)
3825 (pop-to-mark-command))
3826 ((eq last-command 'set-mark-command)
3827 (if (region-active-p)
3828 (progn
3829 (deactivate-mark)
3830 (message "Mark deactivated"))
3831 (activate-mark)
3832 (message "Mark activated")))
3833 (t
3834 (push-mark-command nil)
3835 (if set-mark-default-inactive (deactivate-mark)))))
3837 (defun push-mark (&optional location nomsg activate)
3838 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3839 If the last global mark pushed was not in the current buffer,
3840 also push LOCATION on the global mark ring.
3841 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3843 Novice Emacs Lisp programmers often try to use the mark for the wrong
3844 purposes. See the documentation of `set-mark' for more information.
3846 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3847 (unless (null (mark t))
3848 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3849 (when (> (length mark-ring) mark-ring-max)
3850 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3851 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3852 (set-marker (mark-marker) (or location (point)) (current-buffer))
3853 ;; Now push the mark on the global mark ring.
3854 (if (and global-mark-ring
3855 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3856 ;; The last global mark pushed was in this same buffer.
3857 ;; Don't push another one.
3858 nil
3859 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3860 (when (> (length global-mark-ring) global-mark-ring-max)
3861 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3862 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3863 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3864 (message "Mark set"))
3865 (if (or activate (not transient-mark-mode))
3866 (set-mark (mark t)))
3867 nil)
3869 (defun pop-mark ()
3870 "Pop off mark ring into the buffer's actual mark.
3871 Does not set point. Does nothing if mark ring is empty."
3872 (when mark-ring
3873 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3874 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3875 (move-marker (car mark-ring) nil)
3876 (if (null (mark t)) (ding))
3877 (setq mark-ring (cdr mark-ring)))
3878 (deactivate-mark))
3880 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3881 (defun exchange-point-and-mark (&optional arg)
3882 "Put the mark where point is now, and point where the mark is now.
3883 This command works even when the mark is not active,
3884 and it reactivates the mark.
3886 If Transient Mark mode is on, a prefix ARG deactivates the mark
3887 if it is active, and otherwise avoids reactivating it. If
3888 Transient Mark mode is off, a prefix ARG enables Transient Mark
3889 mode temporarily."
3890 (interactive "P")
3891 (let ((omark (mark t))
3892 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3893 (if (null omark)
3894 (error "No mark set in this buffer"))
3895 (deactivate-mark)
3896 (set-mark (point))
3897 (goto-char omark)
3898 (if set-mark-default-inactive (deactivate-mark))
3899 (cond (temp-highlight
3900 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3901 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3902 (not (or arg (region-active-p))))
3903 (deactivate-mark))
3904 (t (activate-mark)))
3905 nil))
3907 (defcustom shift-select-mode t
3908 "When non-nil, shifted motion keys activate the mark momentarily.
3910 While the mark is activated in this way, any shift-translated point
3911 motion key extends the region, and if Transient Mark mode was off, it
3912 is temporarily turned on. Furthermore, the mark will be deactivated
3913 by any subsequent point motion key that was not shift-translated, or
3914 by any action that normally deactivates the mark in Transient Mark mode.
3916 See `this-command-keys-shift-translated' for the meaning of
3917 shift-translation."
3918 :type 'boolean
3919 :group 'editing-basics)
3921 (defun handle-shift-selection ()
3922 "Activate/deactivate mark depending on invocation thru shift translation.
3923 This function is called by `call-interactively' when a command
3924 with a `^' character in its `interactive' spec is invoked, before
3925 running the command itself.
3927 If `shift-select-mode' is enabled and the command was invoked
3928 through shift translation, set the mark and activate the region
3929 temporarily, unless it was already set in this way. See
3930 `this-command-keys-shift-translated' for the meaning of shift
3931 translation.
3933 Otherwise, if the region has been activated temporarily,
3934 deactivate it, and restore the variable `transient-mark-mode' to
3935 its earlier value."
3936 (cond ((and shift-select-mode this-command-keys-shift-translated)
3937 (unless (and mark-active
3938 (eq (car-safe transient-mark-mode) 'only))
3939 (setq transient-mark-mode
3940 (cons 'only
3941 (unless (eq transient-mark-mode 'lambda)
3942 transient-mark-mode)))
3943 (push-mark nil nil t)))
3944 ((eq (car-safe transient-mark-mode) 'only)
3945 (setq transient-mark-mode (cdr transient-mark-mode))
3946 (deactivate-mark))))
3948 (define-minor-mode transient-mark-mode
3949 "Toggle Transient Mark mode.
3950 With ARG, turn Transient Mark mode on if ARG is positive, off otherwise.
3952 In Transient Mark mode, when the mark is active, the region is highlighted.
3954 So do certain other operations that set the mark
3955 but whose main purpose is something else--for example,
3961 Many commands change their behavior when Transient Mark mode is in effect
3962 and the mark is active, by acting on the region instead of their usual
3963 default part of the buffer's text. Examples of such commands include
3968 commands which are sensitive to the Transient Mark mode."
3969 :global t
3970 :init-value (not noninteractive)
3971 :initialize 'custom-initialize-delay
3972 :group 'editing-basics)
3974 ;; The variable transient-mark-mode is ugly: it can take on special
3975 ;; values. Document these here.
3976 (defvar transient-mark-mode t
3977 "*Non-nil if Transient Mark mode is enabled.
3978 See the command `transient-mark-mode' for a description of this minor mode.
3980 Non-nil also enables highlighting of the region whenever the mark is active.
3981 The variable `highlight-nonselected-windows' controls whether to highlight
3982 all windows or just the selected window.
3984 If the value is `lambda', that enables Transient Mark mode temporarily.
3985 After any subsequent action that would normally deactivate the mark
3986 \(such as buffer modification), Transient Mark mode is turned off.
3988 If the value is (only . OLDVAL), that enables Transient Mark mode
3989 temporarily. After any subsequent point motion command that is not
3990 shift-translated, or any other action that would normally deactivate
3991 the mark (such as buffer modification), the value of
3992 `transient-mark-mode' is set to OLDVAL.")
3994 (defvar widen-automatically t
3995 "Non-nil means it is ok for commands to call `widen' when they want to.
3996 Some commands will do this in order to go to positions outside
3997 the current accessible part of the buffer.
3999 If `widen-automatically' is nil, these commands will do something else
4000 as a fallback, and won't change the buffer bounds.")
4002 (defvar non-essential nil
4003 "Whether the currently executing code is performing an essential task.
4004 This variable should be non-nil only when running code which should not
4005 disturb the user. E.g. it can be used to prevent Tramp from prompting the
4006 user for a password when we are simply scanning a set of files in the
4007 background or displaying possible completions before the user even asked
4008 for it.")
4010 (defun pop-global-mark ()
4011 "Pop off global mark ring and jump to the top location."
4012 (interactive)
4013 ;; Pop entries which refer to non-existent buffers.
4014 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
4015 (setq global-mark-ring (cdr global-mark-ring)))
4016 (or global-mark-ring
4017 (error "No global mark set"))
4018 (let* ((marker (car global-mark-ring))
4019 (buffer (marker-buffer marker))
4020 (position (marker-position marker)))
4021 (setq global-mark-ring (nconc (cdr global-mark-ring)
4022 (list (car global-mark-ring))))
4023 (set-buffer buffer)
4024 (or (and (>= position (point-min))
4025 (<= position (point-max)))
4026 (if widen-automatically
4027 (widen)
4028 (error "Global mark position is outside accessible part of buffer")))
4029 (goto-char position)
4030 (switch-to-buffer buffer)))
4031 \f
4032 (defcustom next-line-add-newlines nil
4033 "If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
4034 :type 'boolean
4035 :version "21.1"
4036 :group 'editing-basics)
4038 (defun next-line (&optional arg try-vscroll)
4039 "Move cursor vertically down ARG lines.
4040 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4041 If there is no character in the target line exactly under the current column,
4042 the cursor is positioned after the character in that line which spans this
4043 column, or at the end of the line if it is not long enough.
4044 If there is no line in the buffer after this one, behavior depends on the
4045 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
4046 to create a line, and moves the cursor to that line. Otherwise it moves the
4047 cursor to the end of the buffer.
4049 If the variable `line-move-visual' is non-nil, this command moves
4050 by display lines. Otherwise, it moves by buffer lines, without
4051 taking variable-width characters or continued lines into account.
4054 a semipermanent goal column for this command.
4055 Then instead of trying to move exactly vertically (or as close as possible),
4056 this command moves to the specified goal column (or as close as possible).
4057 The goal column is stored in the variable `goal-column', which is nil
4058 when there is no goal column.
4060 If you are thinking of using this in a Lisp program, consider
4061 using `forward-line' instead. It is usually easier to use
4062 and more reliable (no dependence on goal column, etc.)."
4064 (or arg (setq arg 1))
4065 (if (and next-line-add-newlines (= arg 1))
4066 (if (save-excursion (end-of-line) (eobp))
4067 ;; When adding a newline, don't expand an abbrev.
4068 (let ((abbrev-mode nil))
4069 (end-of-line)
4071 (line-move arg nil nil try-vscroll))
4072 (if (called-interactively-p 'interactive)
4073 (condition-case err
4074 (line-move arg nil nil try-vscroll)
4075 ((beginning-of-buffer end-of-buffer)
4076 (signal (car err) (cdr err))))
4077 (line-move arg nil nil try-vscroll)))
4078 nil)
4080 (defun previous-line (&optional arg try-vscroll)
4081 "Move cursor vertically up ARG lines.
4082 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
4083 If there is no character in the target line exactly over the current column,
4084 the cursor is positioned after the character in that line which spans this
4085 column, or at the end of the line if it is not long enough.
4087 If the variable `line-move-visual' is non-nil, this command moves
4088 by display lines. Otherwise, it moves by buffer lines, without
4089 taking variable-width characters or continued lines into account.
4092 a semipermanent goal column for this command.
4093 Then instead of trying to move exactly vertically (or as close as possible),
4094 this command moves to the specified goal column (or as close as possible).
4095 The goal column is stored in the variable `goal-column', which is nil
4096 when there is no goal column.
4098 If you are thinking of using this in a Lisp program, consider using
4099 `forward-line' with a negative argument instead. It is usually easier
4100 to use and more reliable (no dependence on goal column, etc.)."
4102 (or arg (setq arg 1))
4103 (if (called-interactively-p 'interactive)
4104 (condition-case err
4105 (line-move (- arg) nil nil try-vscroll)
4106 ((beginning-of-buffer end-of-buffer)
4107 (signal (car err) (cdr err))))
4108 (line-move (- arg) nil nil try-vscroll))
4109 nil)
4111 (defcustom track-eol nil
4112 "Non-nil means vertical motion starting at end of line keeps to ends of lines.
4113 This means moving to the end of each line moved onto.
4114 The beginning of a blank line does not count as the end of a line.
4115 This has no effect when `line-move-visual' is non-nil."
4116 :type 'boolean
4117 :group 'editing-basics)
4119 (defcustom goal-column nil
4121 :type '(choice integer
4122 (const :tag "None" nil))
4123 :group 'editing-basics)
4124 (make-variable-buffer-local 'goal-column)
4126 (defvar temporary-goal-column 0
4127 "Current goal column for vertical motion.
4128 It is the column where point was at the start of the current run
4129 of vertical motion commands.
4131 When moving by visual lines via `line-move-visual', it is a cons
4132 cell (COL . HSCROLL), where COL is the x-position, in pixels,
4133 divided by the default column width, and HSCROLL is the number of
4134 columns by which window is scrolled from left margin.
4136 When the `track-eol' feature is doing its job, the value is
4137 `most-positive-fixnum'.")
4139 (defcustom line-move-ignore-invisible t
4141 Outline mode sets this."
4142 :type 'boolean
4143 :group 'editing-basics)
4145 (defcustom line-move-visual t
4146 "When non-nil, `line-move' moves point by visual lines.
4147 This movement is based on where the cursor is displayed on the
4148 screen, instead of relying on buffer contents alone. It takes
4149 into account variable-width characters and line continuation."
4150 :type 'boolean
4151 :group 'editing-basics)
4153 ;; Returns non-nil if partial move was done.
4154 (defun line-move-partial (arg noerror to-end)
4155 (if (< arg 0)
4156 ;; Move backward (up).
4157 ;; If already vscrolled, reduce vscroll
4158 (let ((vs (window-vscroll nil t)))
4159 (when (> vs (frame-char-height))
4160 (set-window-vscroll nil (- vs (frame-char-height)) t)))
4162 ;; Move forward (down).
4163 (let* ((lh (window-line-height -1))
4164 (vpos (nth 1 lh))
4165 (ypos (nth 2 lh))
4166 (rbot (nth 3 lh))
4167 py vs)
4168 (when (or (null lh)
4169 (>= rbot (frame-char-height))
4170 (<= ypos (- (frame-char-height))))
4171 (unless lh
4172 (let ((wend (pos-visible-in-window-p t nil t)))
4173 (setq rbot (nth 3 wend)
4174 vpos (nth 5 wend))))
4175 (cond
4176 ;; If last line of window is fully visible, move forward.
4177 ((or (null rbot) (= rbot 0))
4178 nil)
4179 ;; If cursor is not in the bottom scroll margin, move forward.
4180 ((and (> vpos 0)
4181 (< (setq py
4182 (or (nth 1 (window-line-height))
4183 (let ((ppos (posn-at-point)))
4184 (cdr (or (posn-actual-col-row ppos)
4185 (posn-col-row ppos))))))
4186 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
4187 nil)
4188 ;; When already vscrolled, we vscroll some more if we can,
4189 ;; or clear vscroll and move forward at end of tall image.
4190 ((> (setq vs (window-vscroll nil t)) 0)
4191 (when (> rbot 0)
4192 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
4193 ;; If cursor just entered the bottom scroll margin, move forward,
4194 ;; but also vscroll one line so redisplay wont recenter.
4195 ((and (> vpos 0)
4196 (= py (min (- (window-text-height) scroll-margin 1)
4197 (1- vpos))))
4198 (set-window-vscroll nil (frame-char-height) t)
4199 (line-move-1 arg noerror to-end)
4200 t)
4201 ;; If there are lines above the last line, scroll-up one line.
4202 ((> vpos 0)
4203 (scroll-up 1)
4204 t)
4205 ;; Finally, start vscroll.
4206 (t
4207 (set-window-vscroll nil (frame-char-height) t)))))))
4210 ;; This is like line-move-1 except that it also performs
4211 ;; vertical scrolling of tall images if appropriate.
4212 ;; That is not really a clean thing to do, since it mixes
4213 ;; scrolling with cursor motion. But so far we don't have
4214 ;; a cleaner solution to the problem of making C-n do something
4215 ;; useful given a tall image.
4216 (defun line-move (arg &optional noerror to-end try-vscroll)
4217 (unless (and auto-window-vscroll try-vscroll
4218 ;; Only vscroll for single line moves
4219 (= (abs arg) 1)
4220 ;; But don't vscroll in a keyboard macro.
4221 (not defining-kbd-macro)
4222 (not executing-kbd-macro)
4223 (line-move-partial arg noerror to-end))
4224 (set-window-vscroll nil 0 t)
4225 (if line-move-visual
4226 (line-move-visual arg noerror)
4227 (line-move-1 arg noerror to-end))))
4229 ;; Display-based alternative to line-move-1.
4230 ;; Arg says how many lines to move. The value is t if we can move the
4231 ;; specified number of lines.
4232 (defun line-move-visual (arg &optional noerror)
4233 (let ((opoint (point))
4234 (hscroll (window-hscroll))
4235 target-hscroll)
4236 ;; Check if the previous command was a line-motion command, or if
4237 ;; we were called from some other command.
4238 (if (and (consp temporary-goal-column)
4239 (memq last-command `(next-line previous-line ,this-command)))
4240 ;; If so, there's no need to reset `temporary-goal-column',
4241 ;; but we may need to hscroll.
4242 (if (or (/= (cdr temporary-goal-column) hscroll)
4243 (> (cdr temporary-goal-column) 0))
4244 (setq target-hscroll (cdr temporary-goal-column)))
4245 ;; Otherwise, we should reset `temporary-goal-column'.
4246 (let ((posn (posn-at-point)))
4247 (cond
4248 ;; Handle the `overflow-newline-into-fringe' case:
4249 ((eq (nth 1 posn) 'right-fringe)
4250 (setq temporary-goal-column (cons (- (window-width) 1) hscroll)))
4251 ((car (posn-x-y posn))
4252 (setq temporary-goal-column
4253 (cons (/ (float (car (posn-x-y posn)))
4254 (frame-char-width)) hscroll))))))
4255 (if target-hscroll
4256 (set-window-hscroll (selected-window) target-hscroll))
4257 (or (and (= (vertical-motion
4258 (cons (or goal-column
4259 (if (consp temporary-goal-column)
4260 (truncate (car temporary-goal-column))
4261 temporary-goal-column))
4262 arg))
4263 arg)
4264 (or (>= arg 0)
4265 (/= (point) opoint)
4266 ;; If the goal column lies on a display string,
4267 ;; `vertical-motion' advances the cursor to the end
4268 ;; of the string. For arg < 0, this can cause the
4269 ;; cursor to get stuck. (Bug#3020).
4270 (= (vertical-motion arg) arg)))
4271 (unless noerror
4272 (signal (if (< arg 0) 'beginning-of-buffer 'end-of-buffer)
4273 nil)))))
4275 ;; This is the guts of next-line and previous-line.
4276 ;; Arg says how many lines to move.
4277 ;; The value is t if we can move the specified number of lines.
4278 (defun line-move-1 (arg &optional noerror to-end)
4279 ;; Don't run any point-motion hooks, and disregard intangibility,
4280 ;; for intermediate positions.
4281 (let ((inhibit-point-motion-hooks t)
4282 (opoint (point))
4283 (orig-arg arg))
4284 (if (consp temporary-goal-column)
4285 (setq temporary-goal-column (+ (car temporary-goal-column)
4286 (cdr temporary-goal-column))))
4287 (unwind-protect
4288 (progn
4289 (if (not (memq last-command '(next-line previous-line)))
4290 (setq temporary-goal-column
4291 (if (and track-eol (eolp)
4292 ;; Don't count beg of empty line as end of line
4293 ;; unless we just did explicit end-of-line.
4294 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4295 most-positive-fixnum
4296 (current-column))))
4298 (if (not (or (integerp selective-display)
4299 line-move-ignore-invisible))
4300 ;; Use just newline characters.
4301 ;; Set ARG to 0 if we move as many lines as requested.
4302 (or (if (> arg 0)
4303 (progn (if (> arg 1) (forward-line (1- arg)))
4304 ;; This way of moving forward ARG lines
4305 ;; verifies that we have a newline after the last one.
4306 ;; It doesn't get confused by intangible text.
4307 (end-of-line)
4308 (if (zerop (forward-line 1))
4309 (setq arg 0)))
4310 (and (zerop (forward-line arg))
4311 (bolp)
4312 (setq arg 0)))
4313 (unless noerror
4314 (signal (if (< arg 0)
4315 'beginning-of-buffer
4316 'end-of-buffer)
4317 nil)))
4318 ;; Move by arg lines, but ignore invisible ones.
4319 (let (done)
4320 (while (and (> arg 0) (not done))
4321 ;; If the following character is currently invisible,
4322 ;; skip all characters with that same `invisible' property value.
4323 (while (and (not (eobp)) (invisible-p (point)))
4324 (goto-char (next-char-property-change (point))))
4325 ;; Move a line.
4326 ;; We don't use `end-of-line', since we want to escape
4327 ;; from field boundaries ocurring exactly at point.
4328 (goto-char (constrain-to-field
4329 (let ((inhibit-field-text-motion t))
4330 (line-end-position))
4331 (point) t t
4332 'inhibit-line-move-field-capture))
4333 ;; If there's no invisibility here, move over the newline.
4334 (cond
4335 ((eobp)
4336 (if (not noerror)
4337 (signal 'end-of-buffer nil)
4338 (setq done t)))
4339 ((and (> arg 1) ;; Use vertical-motion for last move
4340 (not (integerp selective-display))
4341 (not (invisible-p (point))))
4342 ;; We avoid vertical-motion when possible
4343 ;; because that has to fontify.
4344 (forward-line 1))
4345 ;; Otherwise move a more sophisticated way.
4346 ((zerop (vertical-motion 1))
4347 (if (not noerror)
4348 (signal 'end-of-buffer nil)
4349 (setq done t))))
4350 (unless done
4351 (setq arg (1- arg))))
4352 ;; The logic of this is the same as the loop above,
4353 ;; it just goes in the other direction.
4354 (while (and (< arg 0) (not done))
4355 ;; For completely consistency with the forward-motion
4356 ;; case, we should call beginning-of-line here.
4357 ;; However, if point is inside a field and on a
4358 ;; continued line, the call to (vertical-motion -1)
4359 ;; below won't move us back far enough; then we return
4360 ;; to the same column in line-move-finish, and point
4361 ;; gets stuck -- cyd
4362 (forward-line 0)
4363 (cond
4364 ((bobp)
4365 (if (not noerror)
4366 (signal 'beginning-of-buffer nil)
4367 (setq done t)))
4368 ((and (< arg -1) ;; Use vertical-motion for last move
4369 (not (integerp selective-display))
4370 (not (invisible-p (1- (point)))))
4371 (forward-line -1))
4372 ((zerop (vertical-motion -1))
4373 (if (not noerror)
4374 (signal 'beginning-of-buffer nil)
4375 (setq done t))))
4376 (unless done
4377 (setq arg (1+ arg))
4378 (while (and ;; Don't move over previous invis lines
4379 ;; if our target is the middle of this line.
4380 (or (zerop (or goal-column temporary-goal-column))
4381 (< arg 0))
4382 (not (bobp)) (invisible-p (1- (point))))
4383 (goto-char (previous-char-property-change (point))))))))
4384 ;; This is the value the function returns.
4385 (= arg 0))
4387 (cond ((> arg 0)
4388 ;; If we did not move down as far as desired, at least go
4389 ;; to end of line. Be sure to call point-entered and
4390 ;; point-left-hooks.
4391 (let* ((npoint (prog1 (line-end-position)
4392 (goto-char opoint)))
4393 (inhibit-point-motion-hooks nil))
4394 (goto-char npoint)))
4395 ((< arg 0)
4396 ;; If we did not move up as far as desired,
4397 ;; at least go to beginning of line.
4398 (let* ((npoint (prog1 (line-beginning-position)
4399 (goto-char opoint)))
4400 (inhibit-point-motion-hooks nil))
4401 (goto-char npoint)))
4402 (t
4403 (line-move-finish (or goal-column temporary-goal-column)
4404 opoint (> orig-arg 0)))))))
4406 (defun line-move-finish (column opoint forward)
4407 (let ((repeat t))
4408 (while repeat
4409 ;; Set REPEAT to t to repeat the whole thing.
4410 (setq repeat nil)
4412 (let (new
4413 (old (point))
4414 (line-beg (save-excursion (beginning-of-line) (point)))
4415 (line-end
4416 ;; Compute the end of the line
4417 ;; ignoring effectively invisible newlines.
4418 (save-excursion
4419 ;; Like end-of-line but ignores fields.
4421 (while (and (not (eobp)) (invisible-p (point)))
4422 (goto-char (next-char-property-change (point)))
4424 (point))))
4426 ;; Move to the desired column.
4427 (line-move-to-column (truncate column))
4429 ;; Corner case: suppose we start out in a field boundary in
4430 ;; the middle of a continued line. When we get to
4431 ;; line-move-finish, point is at the start of a new *screen*
4432 ;; line but the same text line; then line-move-to-column would
4433 ;; move us backwards. Test using C-n with point on the "x" in
4434 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4435 (and forward
4436 (< (point) old)
4437 (goto-char old))
4439 (setq new (point))
4441 ;; Process intangibility within a line.
4442 ;; With inhibit-point-motion-hooks bound to nil, a call to
4443 ;; goto-char moves point past intangible text.
4445 ;; However, inhibit-point-motion-hooks controls both the
4446 ;; intangibility and the point-entered/point-left hooks. The
4447 ;; following hack avoids calling the point-* hooks
4448 ;; unnecessarily. Note that we move *forward* past intangible
4449 ;; text when the initial and final points are the same.
4450 (goto-char new)
4451 (let ((inhibit-point-motion-hooks nil))
4452 (goto-char new)
4454 ;; If intangibility moves us to a different (later) place
4455 ;; in the same line, use that as the destination.
4456 (if (<= (point) line-end)
4457 (setq new (point))
4458 ;; If that position is "too late",
4459 ;; try the previous allowable position.
4460 ;; See if it is ok.
4461 (backward-char)
4462 (if (if forward
4463 ;; If going forward, don't accept the previous
4464 ;; allowable position if it is before the target line.
4465 (< line-beg (point))
4466 ;; If going backward, don't accept the previous
4467 ;; allowable position if it is still after the target line.
4468 (<= (point) line-end))
4469 (setq new (point))
4470 ;; As a last resort, use the end of the line.
4471 (setq new line-end))))
4473 ;; Now move to the updated destination, processing fields
4474 ;; as well as intangibility.
4475 (goto-char opoint)
4476 (let ((inhibit-point-motion-hooks nil))
4477 (goto-char
4478 ;; Ignore field boundaries if the initial and final
4479 ;; positions have the same `field' property, even if the
4480 ;; fields are non-contiguous. This seems to be "nicer"
4481 ;; behavior in many situations.
4482 (if (eq (get-char-property new 'field)
4483 (get-char-property opoint 'field))
4484 new
4485 (constrain-to-field new opoint t t
4486 'inhibit-line-move-field-capture))))
4488 ;; If all this moved us to a different line,
4489 ;; retry everything within that new line.
4490 (when (or (< (point) line-beg) (> (point) line-end))
4491 ;; Repeat the intangibility and field processing.
4492 (setq repeat t))))))
4494 (defun line-move-to-column (col)
4495 "Try to find column COL, considering invisibility.
4496 This function works only in certain cases,
4497 because what we really need is for `move-to-column'
4498 and `current-column' to be able to ignore invisible text."
4499 (if (zerop col)
4500 (beginning-of-line)
4501 (move-to-column col))
4503 (when (and line-move-ignore-invisible
4504 (not (bolp)) (invisible-p (1- (point))))
4505 (let ((normal-location (point))
4506 (normal-column (current-column)))
4507 ;; If the following character is currently invisible,
4508 ;; skip all characters with that same `invisible' property value.
4509 (while (and (not (eobp))
4510 (invisible-p (point)))
4511 (goto-char (next-char-property-change (point))))
4512 ;; Have we advanced to a larger column position?
4513 (if (> (current-column) normal-column)
4514 ;; We have made some progress towards the desired column.
4515 ;; See if we can make any further progress.
4516 (line-move-to-column (+ (current-column) (- col normal-column)))
4517 ;; Otherwise, go to the place we originally found
4518 ;; and move back over invisible text.
4519 ;; that will get us to the same place on the screen
4520 ;; but with a more reasonable buffer position.
4521 (goto-char normal-location)
4522 (let ((line-beg (save-excursion (beginning-of-line) (point))))
4523 (while (and (not (bolp)) (invisible-p (1- (point))))
4524 (goto-char (previous-char-property-change (point) line-beg))))))))
4526 (defun move-end-of-line (arg)
4527 "Move point to end of current line as displayed.
4528 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4529 If point reaches the beginning or end of buffer, it stops there.
4531 To ignore the effects of the `intangible' text or overlay
4532 property, bind `inhibit-point-motion-hooks' to t.
4533 If there is an image in the current line, this function
4534 disregards newlines that are part of the text on which the image
4535 rests."
4536 (interactive "^p")
4537 (or arg (setq arg 1))
4538 (let (done)
4539 (while (not done)
4540 (let ((newpos
4541 (save-excursion
4542 (let ((goal-column 0)
4543 (line-move-visual nil))
4544 (and (line-move arg t)
4545 ;; With bidi reordering, we may not be at bol,
4546 ;; so make sure we are.
4548 (not (bobp))
4549 (progn
4550 (while (and (not (bobp)) (invisible-p (1- (point))))
4551 (goto-char (previous-single-char-property-change
4552 (point) 'invisible)))
4553 (backward-char 1)))
4554 (point)))))
4555 (goto-char newpos)
4556 (if (and (> (point) newpos)
4558 (backward-char 1)
4559 (if (and (> (point) newpos) (not (eobp))
4561 ;; If we skipped something intangible and now we're not
4562 ;; really at eol, keep going.
4563 (setq arg 1)
4564 (setq done t)))))))
4566 (defun move-beginning-of-line (arg)
4567 "Move point to beginning of current line as displayed.
4568 \(If there's an image in the line, this disregards newlines
4569 which are part of the text that the image rests on.)
4571 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4572 If point reaches the beginning or end of buffer, it stops there.
4573 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4574 (interactive "^p")
4575 (or arg (setq arg 1))
4577 (let ((orig (point))
4578 first-vis first-vis-field-value)
4580 ;; Move by lines, if ARG is not 1 (the default).
4581 (if (/= arg 1)
4582 (let ((line-move-visual nil))
4583 (line-move (1- arg) t)))
4585 ;; Move to beginning-of-line, ignoring fields and invisibles.
4587 (while (and (not (bobp)) (invisible-p (1- (point))))
4588 (goto-char (previous-char-property-change (point)))
4591 ;; Now find first visible char in the line
4592 (while (and (not (eobp)) (invisible-p (point)))
4593 (goto-char (next-char-property-change (point))))
4594 (setq first-vis (point))
4596 ;; See if fields would stop us from reaching FIRST-VIS.
4597 (setq first-vis-field-value
4598 (constrain-to-field first-vis orig (/= arg 1) t nil))
4600 (goto-char (if (/= first-vis-field-value first-vis)
4601 ;; If yes, obey them.
4602 first-vis-field-value
4603 ;; Otherwise, move to START with attention to fields.
4604 ;; (It is possible that fields never matter in this case.)
4605 (constrain-to-field (point) orig
4606 (/= arg 1) t nil)))))
4609 ;; Many people have said they rarely use this feature, and often type
4610 ;; it by accident. Maybe it shouldn't even be on a key.
4611 (put 'set-goal-column 'disabled t)
4613 (defun set-goal-column (arg)
4615 Those commands will move to this position in the line moved to
4616 rather than trying to keep the same horizontal position.
4617 With a non-nil argument ARG, clears out the goal column
4619 The goal column is stored in the variable `goal-column'."
4620 (interactive "P")
4621 (if arg
4622 (progn
4623 (setq goal-column nil)
4624 (message "No goal column"))
4625 (setq goal-column (current-column))
4626 ;; The older method below can be erroneous if `set-goal-column' is bound
4627 ;; to a sequence containing %
4628 ;;(message (substitute-command-keys
4630 ;;goal-column)
4631 (message "%s"
4632 (concat
4633 (format "Goal column %d " goal-column)
4634 (substitute-command-keys
4637 )
4638 nil)
4639 \f
4640 ;;; Editing based on visual lines, as opposed to logical lines.
4642 (defun end-of-visual-line (&optional n)
4643 "Move point to end of current visual line.
4644 With argument N not nil or 1, move forward N - 1 visual lines first.
4645 If point reaches the beginning or end of buffer, it stops there.
4646 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4647 (interactive "^p")
4648 (or n (setq n 1))
4649 (if (/= n 1)
4650 (let ((line-move-visual t))
4651 (line-move (1- n) t)))
4652 ;; Unlike `move-beginning-of-line', `move-end-of-line' doesn't
4653 ;; constrain to field boundaries, so we don't either.
4654 (vertical-motion (cons (window-width) 0)))
4656 (defun beginning-of-visual-line (&optional n)
4657 "Move point to beginning of current visual line.
4658 With argument N not nil or 1, move forward N - 1 visual lines first.
4659 If point reaches the beginning or end of buffer, it stops there.
4660 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4661 (interactive "^p")
4662 (or n (setq n 1))
4663 (let ((opoint (point)))
4664 (if (/= n 1)
4665 (let ((line-move-visual t))
4666 (line-move (1- n) t)))
4667 (vertical-motion 0)
4668 ;; Constrain to field boundaries, like `move-beginning-of-line'.
4669 (goto-char (constrain-to-field (point) opoint (/= n 1)))))
4671 (defun kill-visual-line (&optional arg)
4672 "Kill the rest of the visual line.
4673 With prefix argument ARG, kill that many visual lines from point.
4674 If ARG is negative, kill visual lines backward.
4675 If ARG is zero, kill the text before point on the current visual
4676 line.
4678 If you want to append the killed line to the last killed text,
4681 If the buffer is read-only, Emacs will beep and refrain from deleting
4682 the line, but put the line in the kill ring anyway. This means that
4683 you can use this command to copy text from a read-only buffer.
4684 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4685 even beep.)"
4686 (interactive "P")
4687 ;; Like in `kill-line', it's better to move point to the other end
4688 ;; of the kill before killing.
4689 (let ((opoint (point))
4690 (kill-whole-line (and kill-whole-line (bolp))))
4691 (if arg
4692 (vertical-motion (prefix-numeric-value arg))
4693 (end-of-visual-line 1)
4694 (if (= (point) opoint)
4695 (vertical-motion 1)
4696 ;; Skip any trailing whitespace at the end of the visual line.
4697 ;; We used to do this only if `show-trailing-whitespace' is
4698 ;; nil, but that's wrong; the correct thing would be to check
4699 ;; whether the trailing whitespace is highlighted. But, it's
4700 ;; OK to just do this unconditionally.
4703 (1+ (point))
4704 (point)))))
4706 (defun next-logical-line (&optional arg try-vscroll)
4707 "Move cursor vertically down ARG lines.
4708 This is identical to `next-line', except that it always moves
4709 by logical lines instead of visual lines, ignoring the value of
4710 the variable `line-move-visual'."
4712 (let ((line-move-visual nil))
4713 (with-no-warnings
4714 (next-line arg try-vscroll))))
4716 (defun previous-logical-line (&optional arg try-vscroll)
4717 "Move cursor vertically up ARG lines.
4718 This is identical to `previous-line', except that it always moves
4719 by logical lines instead of visual lines, ignoring the value of
4720 the variable `line-move-visual'."
4722 (let ((line-move-visual nil))
4723 (with-no-warnings
4724 (previous-line arg try-vscroll))))
4726 (defgroup visual-line nil
4727 "Editing based on visual lines."
4728 :group 'convenience
4729 :version "23.1")
4731 (defvar visual-line-mode-map
4732 (let ((map (make-sparse-keymap)))
4733 (define-key map [remap kill-line] 'kill-visual-line)
4734 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4735 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4736 ;; These keybindings interfere with xterm function keys. Are
4737 ;; there any other suitable bindings?
4738 ;; (define-key map "\M-[" 'previous-logical-line)
4739 ;; (define-key map "\M-]" 'next-logical-line)
4740 map))
4742 (defcustom visual-line-fringe-indicators '(nil nil)
4743 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4744 The value should be a list of the form (LEFT RIGHT), where LEFT
4745 and RIGHT are symbols representing the bitmaps to display, to
4746 indicate wrapped lines, in the left and right fringes respectively.
4747 See also `fringe-indicator-alist'.
4748 The default is not to display fringe indicators for wrapped lines.
4749 This variable does not affect fringe indicators displayed for
4750 other purposes."
4751 :type '(list (choice (const :tag "Hide left indicator" nil)
4752 (const :tag "Left curly arrow" left-curly-arrow)
4753 (symbol :tag "Other bitmap"))
4754 (choice (const :tag "Hide right indicator" nil)
4755 (const :tag "Right curly arrow" right-curly-arrow)
4756 (symbol :tag "Other bitmap")))
4757 :set (lambda (symbol value)
4758 (dolist (buf (buffer-list))
4759 (with-current-buffer buf
4760 (when (and (boundp 'visual-line-mode)
4761 (symbol-value 'visual-line-mode))
4762 (setq fringe-indicator-alist
4763 (cons (cons 'continuation value)
4764 (assq-delete-all
4765 'continuation
4766 (copy-tree fringe-indicator-alist)))))))
4767 (set-default symbol value)))
4769 (defvar visual-line--saved-state nil)
4771 (define-minor-mode visual-line-mode
4772 "Redefine simple editing commands to act on visual lines, not logical lines.
4773 This also turns on `word-wrap' in the buffer."
4774 :keymap visual-line-mode-map
4775 :group 'visual-line
4776 :lighter " Wrap"
4777 (if visual-line-mode
4778 (progn
4779 (set (make-local-variable 'visual-line--saved-state) nil)
4780 ;; Save the local values of some variables, to be restored if
4781 ;; visual-line-mode is turned off.
4782 (dolist (var '(line-move-visual truncate-lines
4783 truncate-partial-width-windows
4784 word-wrap fringe-indicator-alist))
4785 (if (local-variable-p var)
4786 (push (cons var (symbol-value var))
4787 visual-line--saved-state)))
4788 (set (make-local-variable 'line-move-visual) t)
4789 (set (make-local-variable 'truncate-partial-width-windows) nil)
4790 (setq truncate-lines nil
4791 word-wrap t
4792 fringe-indicator-alist
4793 (cons (cons 'continuation visual-line-fringe-indicators)
4794 fringe-indicator-alist)))
4795 (kill-local-variable 'line-move-visual)
4796 (kill-local-variable 'word-wrap)
4797 (kill-local-variable 'truncate-lines)
4798 (kill-local-variable 'truncate-partial-width-windows)
4799 (kill-local-variable 'fringe-indicator-alist)
4800 (dolist (saved visual-line--saved-state)
4801 (set (make-local-variable (car saved)) (cdr saved)))
4802 (kill-local-variable 'visual-line--saved-state)))
4804 (defun turn-on-visual-line-mode ()
4805 (visual-line-mode 1))
4807 (define-globalized-minor-mode global-visual-line-mode
4808 visual-line-mode turn-on-visual-line-mode
4809 :lighter " vl")
4811 \f
4812 (defun transpose-chars (arg)
4813 "Interchange characters around point, moving forward one character.
4814 With prefix arg ARG, effect is to take character before point
4815 and drag it forward past ARG other characters (backward if ARG negative).
4816 If no argument and at end of line, the previous two chars are exchanged."
4817 (interactive "*P")
4818 (and (null arg) (eolp) (forward-char -1))
4819 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4821 (defun transpose-words (arg)
4822 "Interchange words around point, leaving point at end of them.
4823 With prefix arg ARG, effect is to take word before or around point
4824 and drag it forward past ARG other words (backward if ARG negative).
4825 If ARG is zero, the words around or after point and around or after mark
4826 are interchanged."
4827 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4828 (interactive "*p")
4829 (transpose-subr 'forward-word arg))
4831 (defun transpose-sexps (arg)
4833 Does not work on a sexp that point is in the middle of
4834 if it is a list or string."
4835 (interactive "*p")
4836 (transpose-subr
4837 (lambda (arg)
4838 ;; Here we should try to simulate the behavior of
4839 ;; (cons (progn (forward-sexp x) (point))
4840 ;; (progn (forward-sexp (- x)) (point)))
4841 ;; Except that we don't want to rely on the second forward-sexp
4842 ;; putting us back to where we want to be, since forward-sexp-function
4843 ;; might do funny things like infix-precedence.
4844 (if (if (> arg 0)
4846 (and (not (bobp))
4848 ;; Jumping over a symbol. We might be inside it, mind you.
4849 (progn (funcall (if (> arg 0)
4850 'skip-syntax-backward 'skip-syntax-forward)
4851 "w_")
4852 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4853 ;; Otherwise, we're between sexps. Take a step back before jumping
4854 ;; to make sure we'll obey the same precedence no matter which direction
4855 ;; we're going.
4856 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4857 (cons (save-excursion (forward-sexp arg) (point))
4858 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4859 (not (zerop (funcall (if (> arg 0)
4860 'skip-syntax-forward
4861 'skip-syntax-backward)
4862 ".")))))
4863 (point)))))
4864 arg 'special))
4866 (defun transpose-lines (arg)
4867 "Exchange current line and previous line, leaving point after both.
4868 With argument ARG, takes previous line and moves it past ARG lines.
4869 With argument 0, interchanges line point is in with line mark is in."
4870 (interactive "*p")
4871 (transpose-subr (function
4872 (lambda (arg)
4873 (if (> arg 0)
4874 (progn
4875 ;; Move forward over ARG lines,
4876 ;; but create newlines if necessary.
4877 (setq arg (forward-line arg))
4879 (setq arg (1+ arg)))
4880 (if (> arg 0)
4881 (newline arg)))
4882 (forward-line arg))))
4883 arg))
4885 ;; FIXME seems to leave point BEFORE the current object when ARG = 0,
4886 ;; which seems inconsistent with the ARG /= 0 case.
4887 ;; FIXME document SPECIAL.
4888 (defun transpose-subr (mover arg &optional special)
4889 "Subroutine to do the work of transposing objects.
4890 Works for lines, sentences, paragraphs, etc. MOVER is a function that
4891 moves forward by units of the given object (e.g. forward-sentence,
4892 forward-paragraph). If ARG is zero, exchanges the current object
4893 with the one containing mark. If ARG is an integer, moves the
4894 current object past ARG following (if ARG is positive) or
4895 preceding (if ARG is negative) objects, leaving point after the
4896 current object."
4897 (let ((aux (if special mover
4898 (lambda (x)
4899 (cons (progn (funcall mover x) (point))
4900 (progn (funcall mover (- x)) (point))))))
4901 pos1 pos2)
4902 (cond
4903 ((= arg 0)
4904 (save-excursion
4905 (setq pos1 (funcall aux 1))
4906 (goto-char (or (mark) (error "No mark set in this buffer")))
4907 (setq pos2 (funcall aux 1))
4908 (transpose-subr-1 pos1 pos2))
4909 (exchange-point-and-mark))
4910 ((> arg 0)
4911 (setq pos1 (funcall aux -1))
4912 (setq pos2 (funcall aux arg))
4913 (transpose-subr-1 pos1 pos2)
4914 (goto-char (car pos2)))
4915 (t
4916 (setq pos1 (funcall aux -1))
4917 (goto-char (car pos1))
4918 (setq pos2 (funcall aux arg))
4919 (transpose-subr-1 pos1 pos2)))))
4921 (defun transpose-subr-1 (pos1 pos2)
4922 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4923 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4924 (when (> (car pos1) (car pos2))
4925 (let ((swap pos1))
4926 (setq pos1 pos2 pos2 swap)))
4927 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
4928 (atomic-change-group
4929 (let (word2)
4930 ;; FIXME: We first delete the two pieces of text, so markers that
4931 ;; used to point to after the text end up pointing to before it :-(
4932 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
4933 (goto-char (car pos2))
4934 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
4935 (goto-char (car pos1))
4936 (insert word2))))
4937 \f
4938 (defun backward-word (&optional arg)
4939 "Move backward until encountering the beginning of a word.
4940 With argument ARG, do this that many times."
4941 (interactive "^p")
4942 (forward-word (- (or arg 1))))
4944 (defun mark-word (&optional arg allow-extend)
4945 "Set mark ARG words away from point.
4947 move to with the same argument.
4948 Interactively, if this command is repeated
4949 or (in Transient Mark mode) if the mark is active,
4950 it marks the next ARG words after the ones already marked."
4952 (cond ((and allow-extend
4953 (or (and (eq last-command this-command) (mark t))
4954 (region-active-p)))
4955 (setq arg (if arg (prefix-numeric-value arg)
4956 (if (< (mark) (point)) -1 1)))
4957 (set-mark
4958 (save-excursion
4959 (goto-char (mark))
4960 (forward-word arg)
4961 (point))))
4962 (t
4963 (push-mark
4964 (save-excursion
4965 (forward-word (prefix-numeric-value arg))
4966 (point))
4967 nil t))))
4969 (defun kill-word (arg)
4970 "Kill characters forward until encountering the end of a word.
4971 With argument ARG, do this that many times."
4972 (interactive "p")
4973 (kill-region (point) (progn (forward-word arg) (point))))
4975 (defun backward-kill-word (arg)
4976 "Kill characters backward until encountering the beginning of a word.
4977 With argument ARG, do this that many times."
4978 (interactive "p")
4979 (kill-word (- arg)))
4981 (defun current-word (&optional strict really-word)
4982 "Return the symbol or word that point is on (or a nearby one) as a string.
4983 The return value includes no text properties.
4984 If optional arg STRICT is non-nil, return nil unless point is within
4985 or adjacent to a symbol or word. In all cases the value can be nil
4986 if there is no word nearby.
4987 The function, belying its name, normally finds a symbol.
4988 If optional arg REALLY-WORD is non-nil, it finds just a word."
4989 (save-excursion
4990 (let* ((oldpoint (point)) (start (point)) (end (point))
4991 (syntaxes (if really-word "w" "w_"))
4992 (not-syntaxes (concat "^" syntaxes)))
4993 (skip-syntax-backward syntaxes) (setq start (point))
4994 (goto-char oldpoint)
4995 (skip-syntax-forward syntaxes) (setq end (point))
4996 (when (and (eq start oldpoint) (eq end oldpoint)
4997 ;; Point is neither within nor adjacent to a word.
4998 (not strict))
4999 ;; Look for preceding word in same line.
5000 (skip-syntax-backward not-syntaxes
5001 (save-excursion (beginning-of-line)
5002 (point)))
5003 (if (bolp)
5004 ;; No preceding word in same line.
5005 ;; Look for following word in same line.
5006 (progn
5007 (skip-syntax-forward not-syntaxes
5008 (save-excursion (end-of-line)
5009 (point)))
5010 (setq start (point))
5011 (skip-syntax-forward syntaxes)
5012 (setq end (point)))
5013 (setq end (point))
5014 (skip-syntax-backward syntaxes)
5015 (setq start (point))))
5016 ;; If we found something nonempty, return it as a string.
5017 (unless (= start end)
5018 (buffer-substring-no-properties start end)))))
5019 \f
5020 (defcustom fill-prefix nil
5021 "String for filling to insert at front of new line, or nil for none."
5022 :type '(choice (const :tag "None" nil)
5023 string)
5024 :group 'fill)
5025 (make-variable-buffer-local 'fill-prefix)
5026 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
5028 (defcustom auto-fill-inhibit-regexp nil
5029 "Regexp to match lines which should not be auto-filled."
5030 :type '(choice (const :tag "None" nil)
5031 regexp)
5032 :group 'fill)
5034 ;; This function is used as the auto-fill-function of a buffer
5035 ;; when Auto-Fill mode is enabled.
5036 ;; It returns t if it really did any work.
5037 ;; (Actually some major modes use a different auto-fill function,
5038 ;; but this one is the default one.)
5039 (defun do-auto-fill ()
5040 (let (fc justify give-up
5041 (fill-prefix fill-prefix))
5042 (if (or (not (setq justify (current-justification)))
5043 (null (setq fc (current-fill-column)))
5044 (and (eq justify 'left)
5045 (<= (current-column) fc))
5046 (and auto-fill-inhibit-regexp
5047 (save-excursion (beginning-of-line)
5048 (looking-at auto-fill-inhibit-regexp))))
5049 nil ;; Auto-filling not required
5050 (if (memq justify '(full center right))
5051 (save-excursion (unjustify-current-line)))
5053 ;; Choose a fill-prefix automatically.
5054 (when (and adaptive-fill-mode
5055 (or (null fill-prefix) (string= fill-prefix "")))
5056 (let ((prefix
5057 (fill-context-prefix
5058 (save-excursion (backward-paragraph 1) (point))
5059 (save-excursion (forward-paragraph 1) (point)))))
5060 (and prefix (not (equal prefix ""))
5061 ;; Use auto-indentation rather than a guessed empty prefix.
5062 (not (and fill-indent-according-to-mode
5064 (setq fill-prefix prefix))))
5066 (while (and (not give-up) (> (current-column) fc))
5067 ;; Determine where to split the line.
5068 (let* (after-prefix
5069 (fill-point
5070 (save-excursion
5071 (beginning-of-line)
5072 (setq after-prefix (point))
5073 (and fill-prefix
5074 (looking-at (regexp-quote fill-prefix))
5075 (setq after-prefix (match-end 0)))
5076 (move-to-column (1+ fc))
5077 (fill-move-to-break-point after-prefix)
5078 (point))))
5080 ;; See whether the place we found is any good.
5081 (if (save-excursion
5082 (goto-char fill-point)
5083 (or (bolp)
5084 ;; There is no use breaking at end of line.
5085 (save-excursion (skip-chars-forward " ") (eolp))
5086 ;; It is futile to split at the end of the prefix
5087 ;; since we would just insert the prefix again.
5088 (and after-prefix (<= (point) after-prefix))
5089 ;; Don't split right after a comment starter
5090 ;; since we would just make another comment starter.
5091 (and comment-start-skip
5092 (let ((limit (point)))
5093 (beginning-of-line)
5094 (and (re-search-forward comment-start-skip
5095 limit t)
5096 (eq (point) limit))))))
5097 ;; No good place to break => stop trying.
5098 (setq give-up t)
5099 ;; Ok, we have a useful place to break the line. Do it.
5100 (let ((prev-column (current-column)))
5101 ;; If point is at the fill-point, do not `save-excursion'.
5102 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
5103 ;; point will end up before it rather than after it.
5104 (if (save-excursion
5106 (= (point) fill-point))
5107 (default-indent-new-line t)
5108 (save-excursion
5109 (goto-char fill-point)
5110 (default-indent-new-line t)))
5111 ;; Now do justification, if required
5112 (if (not (eq justify 'left))
5113 (save-excursion
5114 (end-of-line 0)
5115 (justify-current-line justify nil t)))
5116 ;; If making the new line didn't reduce the hpos of
5117 ;; the end of the line, then give up now;
5118 ;; trying again will not help.
5119 (if (>= (current-column) prev-column)
5120 (setq give-up t))))))
5121 ;; Justify last line.
5122 (justify-current-line justify t t)
5123 t)))
5125 (defvar comment-line-break-function 'comment-indent-new-line
5126 "*Mode-specific function which line breaks and continues a comment.
5127 This function is called during auto-filling when a comment syntax
5128 is defined.
5129 The function should take a single optional argument, which is a flag
5130 indicating whether it should use soft newlines.")
5132 (defun default-indent-new-line (&optional soft)
5133 "Break line at point and indent.
5134 If a comment syntax is defined, call `comment-indent-new-line'.
5136 The inserted newline is marked hard if variable `use-hard-newlines' is true,
5137 unless optional argument SOFT is non-nil."
5138 (interactive)
5139 (if comment-start
5140 (funcall comment-line-break-function soft)
5141 ;; Insert the newline before removing empty space so that markers
5142 ;; get preserved better.
5144 (save-excursion (forward-char -1) (delete-horizontal-space))
5145 (delete-horizontal-space)
5147 (if (and fill-prefix (not adaptive-fill-mode))
5148 ;; Blindly trust a non-adaptive fill-prefix.
5149 (progn
5150 (indent-to-left-margin)
5151 (insert-before-markers-and-inherit fill-prefix))
5153 (cond
5154 ;; If there's an adaptive prefix, use it unless we're inside
5155 ;; a comment and the prefix is not a comment starter.
5156 (fill-prefix
5157 (indent-to-left-margin)
5158 (insert-and-inherit fill-prefix))
5159 ;; If we're not inside a comment, just try to indent.
5160 (t (indent-according-to-mode))))))
5162 (defvar normal-auto-fill-function 'do-auto-fill
5163 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
5164 Some major modes set this.")
5166 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
5167 ;; `functions' and `hooks' are usually unsafe to set, but setting
5168 ;; auto-fill-function to nil in a file-local setting is safe and
5169 ;; can be useful to prevent auto-filling.
5170 (put 'auto-fill-function 'safe-local-variable 'null)
5171 ;; FIXME: turn into a proper minor mode.
5172 ;; Add a global minor mode version of it.
5173 (define-minor-mode auto-fill-mode
5174 "Toggle Auto Fill mode.
5175 With ARG, turn Auto Fill mode on if and only if ARG is positive.
5176 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
5177 automatically breaks the line at a previous space.
5179 The value of `normal-auto-fill-function' specifies the function to use
5180 for `auto-fill-function' when turning Auto Fill mode on."
5181 :variable (eq auto-fill-function normal-auto-fill-function))
5183 ;; This holds a document string used to document auto-fill-mode.
5184 (defun auto-fill-function ()
5185 "Automatically break line at a previous space, in insertion of text."
5186 nil)
5188 (defun turn-on-auto-fill ()
5189 "Unconditionally turn on Auto Fill mode."
5190 (auto-fill-mode 1))
5192 (defun turn-off-auto-fill ()
5193 "Unconditionally turn off Auto Fill mode."
5194 (auto-fill-mode -1))
5196 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
5198 (defun set-fill-column (arg)
5199 "Set `fill-column' to specified argument.
5202 (interactive
5203 (list (or current-prefix-arg
5204 ;; We used to use current-column silently, but C-x f is too easily
5205 ;; typed as a typo for C-x C-f, so we turned it into an error and
5206 ;; now an interactive prompt.
5207 (read-number "Set fill-column to: " (current-column)))))
5208 (if (consp arg)
5209 (setq arg (current-column)))
5210 (if (not (integerp arg))
5211 ;; Disallow missing argument; it's probably a typo for C-x C-f.
5212 (error "set-fill-column requires an explicit argument")
5213 (message "Fill column set to %d (was %d)" arg fill-column)
5214 (setq fill-column arg)))
5215 \f
5216 (defun set-selective-display (arg)
5217 "Set `selective-display' to ARG; clear it if no arg.
5218 When the value of `selective-display' is a number > 0,
5219 lines whose indentation is >= that value are not displayed.
5220 The variable `selective-display' has a separate value for each buffer."
5221 (interactive "P")
5222 (if (eq selective-display t)
5223 (error "selective-display already in use for marked lines"))
5224 (let ((current-vpos
5225 (save-restriction
5226 (narrow-to-region (point-min) (point))
5227 (goto-char (window-start))
5228 (vertical-motion (window-height)))))
5229 (setq selective-display
5230 (and arg (prefix-numeric-value arg)))
5231 (recenter current-vpos))
5232 (set-window-start (selected-window) (window-start (selected-window)))
5233 (princ "selective-display set to " t)
5234 (prin1 selective-display t)
5235 (princ "." t))
5237 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5239 (defun toggle-truncate-lines (&optional arg)
5240 "Toggle whether to fold or truncate long lines for the current buffer.
5241 With prefix argument ARG, truncate long lines if ARG is positive,
5242 otherwise don't truncate them. Note that in side-by-side windows,
5243 this command has no effect if `truncate-partial-width-windows'
5244 is non-nil."
5245 (interactive "P")
5246 (setq truncate-lines
5247 (if (null arg)
5248 (not truncate-lines)
5249 (> (prefix-numeric-value arg) 0)))
5250 (force-mode-line-update)
5251 (unless truncate-lines
5252 (let ((buffer (current-buffer)))
5253 (walk-windows (lambda (window)
5254 (if (eq buffer (window-buffer window))
5255 (set-window-hscroll window 0)))
5256 nil t)))
5257 (message "Truncate long lines %s"
5258 (if truncate-lines "enabled" "disabled")))
5260 (defun toggle-word-wrap (&optional arg)
5261 "Toggle whether to use word-wrapping for continuation lines.
5262 With prefix argument ARG, wrap continuation lines at word boundaries
5263 if ARG is positive, otherwise wrap them at the right screen edge.
5264 This command toggles the value of `word-wrap'. It has no effect
5265 if long lines are truncated."
5266 (interactive "P")
5267 (setq word-wrap
5268 (if (null arg)
5269 (not word-wrap)
5270 (> (prefix-numeric-value arg) 0)))
5271 (force-mode-line-update)
5272 (message "Word wrapping %s"
5273 (if word-wrap "enabled" "disabled")))
5275 (defvar overwrite-mode-textual (purecopy " Ovwrt")
5276 "The string displayed in the mode line when in overwrite mode.")
5277 (defvar overwrite-mode-binary (purecopy " Bin Ovwrt")
5278 "The string displayed in the mode line when in binary overwrite mode.")
5280 (define-minor-mode overwrite-mode
5281 "Toggle overwrite mode.
5282 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5283 otherwise turn it off. In overwrite mode, printing characters typed
5284 in replace existing text on a one-for-one basis, rather than pushing
5285 it to the right. At the end of a line, such characters extend the line.
5286 Before a tab, such characters insert until the tab is filled in.
5288 is supposed to make it easier to insert characters when necessary."
5289 :variable (eq overwrite-mode 'overwrite-mode-textual))
5291 (define-minor-mode binary-overwrite-mode
5292 "Toggle binary overwrite mode.
5293 With prefix argument ARG, turn binary overwrite mode on if ARG is
5294 positive, otherwise turn it off. In binary overwrite mode, printing
5295 characters typed in replace existing text. Newlines are not treated
5296 specially, so typing at the end of a line joins the line to the next,
5297 with the typed character between them. Typing before a tab character
5299 replaces the text at the cursor, just as ordinary typing characters do.
5301 Note that binary overwrite mode is not its own minor mode; it is a
5302 specialization of overwrite mode, entered by setting the
5303 `overwrite-mode' variable to `overwrite-mode-binary'."
5304 :variable (eq overwrite-mode 'overwrite-mode-binary))
5306 (define-minor-mode line-number-mode
5307 "Toggle Line Number mode.
5308 With ARG, turn Line Number mode on if ARG is positive, otherwise
5309 turn it off. When Line Number mode is enabled, the line number
5310 appears in the mode line.
5312 Line numbers do not appear for very large buffers and buffers
5313 with very long lines; see variables `line-number-display-limit'
5314 and `line-number-display-limit-width'."
5315 :init-value t :global t :group 'mode-line)
5317 (define-minor-mode column-number-mode
5318 "Toggle Column Number mode.
5319 With ARG, turn Column Number mode on if ARG is positive,
5320 otherwise turn it off. When Column Number mode is enabled, the
5321 column number appears in the mode line."
5322 :global t :group 'mode-line)
5324 (define-minor-mode size-indication-mode
5325 "Toggle Size Indication mode.
5326 With ARG, turn Size Indication mode on if ARG is positive,
5327 otherwise turn it off. When Size Indication mode is enabled, the
5328 size of the accessible part of the buffer appears in the mode line."
5329 :global t :group 'mode-line)
5331 (define-minor-mode auto-save-mode
5332 "Toggle auto-saving of contents of current buffer.
5333 With prefix argument ARG, turn auto-saving on if positive, else off."
5334 :variable ((and buffer-auto-save-file-name
5335 ;; If auto-save is off because buffer has shrunk,
5336 ;; then toggling should turn it on.
5337 (>= buffer-saved-size 0))
5338 . (lambda (val)
5339 (setq buffer-auto-save-file-name
5340 (cond
5341 ((null val) nil)
5342 ((and buffer-file-name auto-save-visited-file-name
5343 (not buffer-read-only))
5344 buffer-file-name)
5345 (t (make-auto-save-file-name))))))
5346 ;; If -1 was stored here, to temporarily turn off saving,
5347 ;; turn it back on.
5348 (and (< buffer-saved-size 0)
5349 (setq buffer-saved-size 0)))
5350 \f
5351 (defgroup paren-blinking nil
5352 "Blinking matching of parens and expressions."
5353 :prefix "blink-matching-"
5354 :group 'paren-matching)
5356 (defcustom blink-matching-paren t
5357 "Non-nil means show matching open-paren when close-paren is inserted."
5358 :type 'boolean
5359 :group 'paren-blinking)
5361 (defcustom blink-matching-paren-on-screen t
5362 "Non-nil means show matching open-paren when it is on screen.
5363 If nil, don't show it (but the open-paren can still be shown
5364 when it is off screen).
5366 This variable has no effect if `blink-matching-paren' is nil.
5367 \(In that case, the open-paren is never shown.)
5368 It is also ignored if `show-paren-mode' is enabled."
5369 :type 'boolean
5370 :group 'paren-blinking)
5372 (defcustom blink-matching-paren-distance (* 100 1024)
5373 "If non-nil, maximum distance to search backwards for matching open-paren.
5374 If nil, search stops at the beginning of the accessible portion of the buffer."
5375 :version "23.2" ; 25->100k
5376 :type '(choice (const nil) integer)
5377 :group 'paren-blinking)
5379 (defcustom blink-matching-delay 1
5380 "Time in seconds to delay after showing a matching paren."
5381 :type 'number
5382 :group 'paren-blinking)
5384 (defcustom blink-matching-paren-dont-ignore-comments nil
5385 "If nil, `blink-matching-paren' ignores comments.
5386 More precisely, when looking for the matching parenthesis,
5387 it skips the contents of comments that end before point."
5388 :type 'boolean
5389 :group 'paren-blinking)
5391 (defun blink-matching-open ()
5392 "Move cursor momentarily to the beginning of the sexp before point."
5393 (interactive)
5394 (when (and (> (point) (point-min))
5395 blink-matching-paren
5396 ;; Verify an even number of quoting characters precede the close.
5397 (= 1 (logand 1 (- (point)
5398 (save-excursion
5399 (forward-char -1)
5401 (point))))))
5402 (let* ((oldpos (point))
5403 (message-log-max nil) ; Don't log messages about paren matching.
5404 (atdollar (eq (syntax-class (syntax-after (1- oldpos))) 8))
5405 (isdollar)
5406 (blinkpos
5407 (save-excursion
5408 (save-restriction
5409 (if blink-matching-paren-distance
5410 (narrow-to-region
5411 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5412 (- (point) blink-matching-paren-distance))
5413 oldpos))
5414 (let ((parse-sexp-ignore-comments
5415 (and parse-sexp-ignore-comments
5416 (not blink-matching-paren-dont-ignore-comments))))
5417 (condition-case ()
5418 (scan-sexps oldpos -1)
5419 (error nil))))))
5420 (matching-paren
5421 (and blinkpos
5422 ;; Not syntax '$'.
5423 (not (setq isdollar
5424 (eq (syntax-class (syntax-after blinkpos)) 8)))
5425 (let ((syntax (syntax-after blinkpos)))
5426 (and (consp syntax)
5427 (eq (syntax-class syntax) 4)
5428 (cdr syntax))))))
5429 (cond
5430 ;; isdollar is for:
5431 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00871.html
5432 ((not (or (and isdollar blinkpos)
5433 (and atdollar (not blinkpos)) ; see below
5434 (eq matching-paren (char-before oldpos))
5435 ;; The cdr might hold a new paren-class info rather than
5436 ;; a matching-char info, in which case the two CDRs
5437 ;; should match.
5438 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
5439 (if (minibufferp)
5440 (minibuffer-message " [Mismatched parentheses]")
5441 (message "Mismatched parentheses")))
5442 ((not blinkpos)
5443 (or blink-matching-paren-distance
5444 ;; Don't complain when `$' with no blinkpos, because it
5445 ;; could just be the first one typed in the buffer.
5446 atdollar
5447 (if (minibufferp)
5448 (minibuffer-message " [Unmatched parenthesis]")
5449 (message "Unmatched parenthesis"))))
5450 ((pos-visible-in-window-p blinkpos)
5451 ;; Matching open within window, temporarily move to blinkpos but only
5452 ;; if `blink-matching-paren-on-screen' is non-nil.
5453 (and blink-matching-paren-on-screen
5454 (not show-paren-mode)
5455 (save-excursion
5456 (goto-char blinkpos)
5457 (sit-for blink-matching-delay))))
5458 (t
5459 (save-excursion
5460 (goto-char blinkpos)
5461 (let ((open-paren-line-string
5462 ;; Show what precedes the open in its line, if anything.
5463 (cond
5465 (buffer-substring (line-beginning-position)
5466 (1+ blinkpos)))
5467 ;; Show what follows the open in its line, if anything.
5468 ((save-excursion
5469 (forward-char 1)
5471 (not (eolp)))
5472 (buffer-substring blinkpos
5473 (line-end-position)))
5474 ;; Otherwise show the previous nonblank line,
5475 ;; if there is one.
5477 (concat
5478 (buffer-substring (progn
5480 (line-beginning-position))
5481 (progn (end-of-line)
5483 (point)))
5484 ;; Replace the newline and other whitespace with `...'.
5485 "..."
5486 (buffer-substring blinkpos (1+ blinkpos))))
5487 ;; There is nothing to show except the char itself.
5488 (t (buffer-substring blinkpos (1+ blinkpos))))))
5489 (message "Matches %s"
5490 (substring-no-properties open-paren-line-string)))))))))
5492 (setq blink-paren-function 'blink-matching-open)
5493 \f
5494 ;; This executes C-g typed while Emacs is waiting for a command.
5495 ;; Quitting out of a program does not go through here;
5496 ;; that happens in the QUIT macro at the C code level.
5497 (defun keyboard-quit ()
5498 "Signal a `quit' condition.
5499 During execution of Lisp code, this character causes a quit directly.
5500 At top-level, as an editor command, this simply beeps."
5501 (interactive)
5502 (deactivate-mark)
5503 (if (fboundp 'kmacro-keyboard-quit)
5504 (kmacro-keyboard-quit))
5505 (setq defining-kbd-macro nil)
5506 (signal 'quit nil))
5508 (defvar buffer-quit-function nil
5511 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5513 (defun keyboard-escape-quit ()
5515 This command can exit an interactive command such as `query-replace',
5516 can clear out a prefix argument or a region,
5517 can get out of the minibuffer or other recursive edit,
5518 cancel the use of the current buffer (for special-purpose buffers),
5519 or go back to just one window (by deleting all but the selected window)."
5520 (interactive)
5521 (cond ((eq last-command 'mode-exited) nil)
5522 ((region-active-p)
5523 (deactivate-mark))
5524 ((> (minibuffer-depth) 0)
5525 (abort-recursive-edit))
5526 (current-prefix-arg
5527 nil)
5528 ((> (recursion-depth) 0)
5529 (exit-recursive-edit))
5530 (buffer-quit-function
5531 (funcall buffer-quit-function))
5532 ((not (one-window-p t))
5533 (delete-other-windows))
5535 (bury-buffer))))
5537 (defun play-sound-file (file &optional volume device)
5538 "Play sound stored in FILE.
5539 VOLUME and DEVICE correspond to the keywords of the sound
5540 specification for `play-sound'."
5541 (interactive "fPlay sound file: ")
5542 (let ((sound (list :file file)))
5543 (if volume
5544 (plist-put sound :volume volume))
5545 (if device
5546 (plist-put sound :device device))
5547 (push 'sound sound)
5548 (play-sound sound)))
5550 \f
5551 (defcustom read-mail-command 'rmail
5552 "Your preference for a mail reading package.
5553 This is used by some keybindings which support reading mail.
5554 See also `mail-user-agent' concerning sending mail."
5557 (function-item :tag "Emacs interface to MH"
5559 (function :tag "Other"))
5560 :version "21.1"
5561 :group 'mail)
5563 (defcustom mail-user-agent 'message-user-agent
5564 "Your preference for a mail composition package.
5565 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5566 outgoing email message. This variable lets you specify which
5567 mail-sending package you prefer.
5569 Valid values include:
5571 `message-user-agent' -- use the Message package.
5572 See Info node `(message)'.
5573 `sendmail-user-agent' -- use the Mail package.
5574 See Info node `(emacs)Sending Mail'.
5575 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5576 See Info node `(mh-e)'.
5577 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5578 paraphernalia, particularly the Gcc: header for
5579 archiving.
5581 Additional valid symbols may be available; check with the author of
5582 your package for details. The function should return non-nil if it
5583 succeeds.
5585 See also `read-mail-command' concerning reading mail."
5586 :type '(radio (function-item :tag "Message package"
5588 message-user-agent)
5589 (function-item :tag "Mail package"
5591 sendmail-user-agent)
5592 (function-item :tag "Emacs interface to MH"
5594 mh-e-user-agent)
5595 (function-item :tag "Message with full Gnus features"
5597 gnus-user-agent)
5598 (function :tag "Other"))
5599 :version "23.2" ; sendmail->message
5600 :group 'mail)
5602 (defcustom compose-mail-user-agent-warnings t
5603 "If non-nil, `compose-mail' warns about changes in `mail-user-agent'.
5604 If the value of `mail-user-agent' is the default, and the user
5605 appears to have customizations applying to the old default,
5606 `compose-mail' issues a warning."
5607 :type 'boolean
5608 :version "23.2"
5609 :group 'mail)
5611 (define-mail-user-agent 'sendmail-user-agent
5612 'sendmail-user-agent-compose
5613 'mail-send-and-exit)
5615 (defun rfc822-goto-eoh ()
5616 ;; Go to header delimiter line in a mail message, following RFC822 rules
5617 (goto-char (point-min))
5618 (when (re-search-forward
5620 (goto-char (match-beginning 0))))
5622 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
5623 switch-function yank-action
5624 send-actions)
5625 (if switch-function
5626 (let ((special-display-buffer-names nil)
5627 (special-display-regexps nil)
5628 (same-window-buffer-names nil)
5629 (same-window-regexps nil))
5630 (funcall switch-function "*mail*")))
5631 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5632 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5633 (body (cdr (assoc-string "body" other-headers t))))
5634 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5635 continue
5636 (error "Message aborted"))
5637 (save-excursion
5638 (rfc822-goto-eoh)
5639 (while other-headers
5640 (unless (member-ignore-case (car (car other-headers))
5641 '("in-reply-to" "cc" "body"))
5642 (insert (car (car other-headers)) ": "
5643 (cdr (car other-headers))
5645 (setq other-headers (cdr other-headers)))
5646 (when body
5647 (forward-line 1)
5648 (insert body))
5649 t)))
5651 (defun compose-mail (&optional to subject other-headers continue
5652 switch-function yank-action send-actions)
5653 "Start composing a mail message to send.
5654 This uses the user's chosen mail composition package
5655 as selected with the variable `mail-user-agent'.
5656 The optional arguments TO and SUBJECT specify recipients
5657 and the initial Subject field, respectively.
5659 OTHER-HEADERS is an alist specifying additional
5660 header fields. Elements look like (HEADER . VALUE) where both
5661 HEADER and VALUE are strings.
5663 CONTINUE, if non-nil, says to continue editing a message already
5664 being composed. Interactively, CONTINUE is the prefix argument.
5666 SWITCH-FUNCTION, if non-nil, is a function to use to
5667 switch to and display the buffer used for mail composition.
5669 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5670 to insert the raw text of the message being replied to.
5671 It has the form (FUNCTION . ARGS). The user agent will apply
5672 FUNCTION to ARGS, to insert the raw text of the original message.
5673 \(The user agent will also run `mail-citation-hook', *after* the
5674 original text has been inserted in this way.)
5676 SEND-ACTIONS is a list of actions to call when the message is sent.
5677 Each action has the form (FUNCTION . ARGS)."
5678 (interactive
5679 (list nil nil nil current-prefix-arg))
5681 ;; In Emacs 23.2, the default value of `mail-user-agent' changed
5682 ;; from sendmail-user-agent to message-user-agent. Some users may
5683 ;; encounter incompatibilities. This hack tries to detect problems
5684 ;; and warn about them.
5685 (and compose-mail-user-agent-warnings
5686 (eq mail-user-agent 'message-user-agent)
5687 (let (warn-vars)
5688 (dolist (var '(mail-mode-hook mail-send-hook mail-setup-hook
5689 mail-yank-hooks mail-archive-file-name
5690 mail-default-reply-to mail-mailing-lists
5691 mail-self-blind))
5692 (and (boundp var)
5693 (symbol-value var)
5694 (push var warn-vars)))
5695 (when warn-vars
5696 (display-warning 'mail
5697 (format "\
5698 The default mail mode is now Message mode.
5699 You have the following Mail mode variable%s customized:
5701 To disable this warning, set `compose-mail-user-agent-warnings' to nil."
5702 (if (> (length warn-vars) 1) "s" "")
5703 (mapconcat 'symbol-name
5704 warn-vars " "))))))
5706 (let ((function (get mail-user-agent 'composefunc)))
5707 (funcall function to subject other-headers continue
5708 switch-function yank-action send-actions)))
5710 (defun compose-mail-other-window (&optional to subject other-headers continue
5711 yank-action send-actions)
5713 (interactive
5714 (list nil nil nil current-prefix-arg))
5715 (compose-mail to subject other-headers continue
5716 'switch-to-buffer-other-window yank-action send-actions))
5719 (defun compose-mail-other-frame (&optional to subject other-headers continue
5720 yank-action send-actions)
5722 (interactive
5723 (list nil nil nil current-prefix-arg))
5724 (compose-mail to subject other-headers continue
5725 'switch-to-buffer-other-frame yank-action send-actions))
5726 \f
5727 (defvar set-variable-value-history nil
5728 "History of values entered with `set-variable'.
5730 Maximum length of the history list is determined by the value
5731 of `history-length', which see.")
5733 (defun set-variable (variable value &optional make-local)
5734 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5735 VARIABLE should be a user option variable name, a Lisp variable
5736 meant to be customized by users. You should enter VALUE in Lisp syntax,
5737 so if you want VALUE to be a string, you must surround it with doublequotes.
5738 VALUE is used literally, not evaluated.
5740 If VARIABLE has a `variable-interactive' property, that is used as if
5741 it were the arg to `interactive' (which see) to interactively read VALUE.
5743 If VARIABLE has been defined with `defcustom', then the type information
5744 in the definition is used to check that VALUE is valid.
5746 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5747 (interactive
5748 (let* ((default-var (variable-at-point))
5749 (var (if (user-variable-p default-var)
5750 (read-variable (format "Set variable (default %s): " default-var)
5751 default-var)
5752 (read-variable "Set variable: ")))
5753 (minibuffer-help-form '(describe-variable var))
5754 (prop (get var 'variable-interactive))
5755 (obsolete (car (get var 'byte-obsolete-variable)))
5756 (prompt (format "Set %s %s to value: " var
5757 (cond ((local-variable-p var)
5758 "(buffer-local)")
5759 ((or current-prefix-arg
5760 (local-variable-if-set-p var))
5761 "buffer-locally")
5762 (t "globally"))))
5763 (val (progn
5764 (when obsolete
5765 (message (concat "`%S' is obsolete; "
5766 (if (symbolp obsolete) "use `%S' instead" "%s"))
5767 var obsolete)
5768 (sit-for 3))
5769 (if prop
5770 ;; Use VAR's `variable-interactive' property
5771 ;; as an interactive spec for prompting.
5772 (call-interactively `(lambda (arg)
5773 (interactive ,prop)
5774 arg))
5775 (read
5776 (read-string prompt nil
5777 'set-variable-value-history
5778 (format "%S" (symbol-value var))))))))
5779 (list var val current-prefix-arg)))
5781 (and (custom-variable-p variable)
5782 (not (get variable 'custom-type))
5783 (custom-load-symbol variable))
5784 (let ((type (get variable 'custom-type)))
5785 (when type
5786 ;; Match with custom type.
5787 (require 'cus-edit)
5788 (setq type (widget-convert type))
5789 (unless (widget-apply type :match value)
5790 (error "Value `%S' does not match type %S of %S"
5791 value (car type) variable))))
5793 (if make-local
5794 (make-local-variable variable))
5796 (set variable value)
5798 ;; Force a thorough redisplay for the case that the variable
5799 ;; has an effect on the display, like `tab-width' has.
5800 (force-mode-line-update))
5801 \f
5802 ;; Define the major mode for lists of completions.
5804 (defvar completion-list-mode-map
5805 (let ((map (make-sparse-keymap)))
5806 (define-key map [mouse-2] 'mouse-choose-completion)
5807 (define-key map [follow-link] 'mouse-face)
5808 (define-key map [down-mouse-2] nil)
5809 (define-key map "\C-m" 'choose-completion)
5810 (define-key map "\e\e\e" 'delete-completion-window)
5811 (define-key map [left] 'previous-completion)
5812 (define-key map [right] 'next-completion)
5813 (define-key map "q" 'quit-window)
5814 map)
5815 "Local map for completion list buffers.")
5817 ;; Completion mode is suitable only for specially formatted data.
5818 (put 'completion-list-mode 'mode-class 'special)
5820 (defvar completion-reference-buffer nil
5821 "Record the buffer that was current when the completion list was requested.
5822 This is a local variable in the completion list buffer.
5823 Initial value is nil to avoid some compiler warnings.")
5825 (defvar completion-no-auto-exit nil
5826 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5827 This also applies to other functions such as `choose-completion'.")
5829 (defvar completion-base-position nil
5830 "Position of the base of the text corresponding to the shown completions.
5831 This variable is used in the *Completions* buffers.
5832 Its value is a list of the form (START END) where START is the place
5833 where the completion should be inserted and END (if non-nil) is the end
5834 of the text to replace. If END is nil, point is used instead.")
5836 (defvar completion-base-size nil
5837 "Number of chars before point not involved in completion.
5838 This is a local variable in the completion list buffer.
5839 It refers to the chars in the minibuffer if completing in the
5840 minibuffer, or in `completion-reference-buffer' otherwise.
5841 Only characters in the field at point are included.
5843 If nil, Emacs determines which part of the tail end of the
5844 buffer's text is involved in completion by comparing the text
5845 directly.")
5846 (make-obsolete-variable 'completion-base-size 'completion-base-position "23.2")
5848 (defun delete-completion-window ()
5849 "Delete the completion list window.
5850 Go to the window from which completion was requested."
5851 (interactive)
5852 (let ((buf completion-reference-buffer))
5853 (if (one-window-p t)
5854 (if (window-dedicated-p (selected-window))
5855 (delete-frame (selected-frame)))
5856 (delete-window (selected-window))
5857 (if (get-buffer-window buf)
5858 (select-window (get-buffer-window buf))))))
5860 (defun previous-completion (n)
5861 "Move to the previous item in the completion list."
5862 (interactive "p")
5863 (next-completion (- n)))
5865 (defun next-completion (n)
5866 "Move to the next item in the completion list.
5867 With prefix argument N, move N items (negative N means move backward)."
5868 (interactive "p")
5869 (let ((beg (point-min)) (end (point-max)))
5870 (while (and (> n 0) (not (eobp)))
5871 ;; If in a completion, move to the end of it.
5872 (when (get-text-property (point) 'mouse-face)
5873 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5874 ;; Move to start of next one.
5875 (unless (get-text-property (point) 'mouse-face)
5876 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5877 (setq n (1- n)))
5878 (while (and (< n 0) (not (bobp)))
5879 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5880 ;; If in a completion, move to the start of it.
5881 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5882 (goto-char (previous-single-property-change
5883 (point) 'mouse-face nil beg)))
5884 ;; Move to end of the previous completion.
5885 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5886 (goto-char (previous-single-property-change
5887 (point) 'mouse-face nil beg)))
5888 ;; Move to the start of that one.
5889 (goto-char (previous-single-property-change
5890 (point) 'mouse-face nil beg))
5891 (setq n (1+ n))))))
5893 (defun choose-completion (&optional event)
5894 "Choose the completion at point."
5895 (interactive (list last-nonmenu-event))
5896 ;; In case this is run via the mouse, give temporary modes such as
5897 ;; isearch a chance to turn off.
5898 (run-hooks 'mouse-leave-buffer-hook)
5899 (let (buffer base-size base-position choice)
5900 (with-current-buffer (window-buffer (posn-window (event-start event)))
5901 (setq buffer completion-reference-buffer)
5902 (setq base-size completion-base-size)
5903 (setq base-position completion-base-position)
5904 (save-excursion
5905 (goto-char (posn-point (event-start event)))
5906 (let (beg end)
5907 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
5908 (setq end (point) beg (1+ (point))))
5909 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
5910 (setq end (1- (point)) beg (point)))
5911 (if (null beg)
5912 (error "No completion here"))
5913 (setq beg (previous-single-property-change beg 'mouse-face))
5914 (setq end (or (next-single-property-change end 'mouse-face)
5915 (point-max)))
5916 (setq choice (buffer-substring-no-properties beg end)))))
5918 (let ((owindow (selected-window)))
5919 (select-window (posn-window (event-start event)))
5920 (if (and (one-window-p t 'selected-frame)
5921 (window-dedicated-p (selected-window)))
5922 ;; This is a special buffer's frame
5923 (iconify-frame (selected-frame))
5924 (or (window-dedicated-p (selected-window))
5925 (bury-buffer)))
5926 (select-window
5927 (or (and (buffer-live-p buffer)
5928 (get-buffer-window buffer 0))
5929 owindow)))
5931 (choose-completion-string
5932 choice buffer
5933 (or base-position
5934 (when base-size
5935 ;; Someone's using old completion code that doesn't know
5936 ;; about base-position yet.
5937 (list (+ base-size (with-current-buffer buffer (field-beginning)))))
5938 ;; If all else fails, just guess.
5939 (with-current-buffer buffer
5940 (list (choose-completion-guess-base-position choice)))))))
5942 ;; Delete the longest partial match for STRING
5943 ;; that can be found before POINT.
5944 (defun choose-completion-guess-base-position (string)
5945 (save-excursion
5946 (let ((opoint (point))
5947 len)
5948 ;; Try moving back by the length of the string.
5949 (goto-char (max (- (point) (length string))
5950 (minibuffer-prompt-end)))
5951 ;; See how far back we were actually able to move. That is the
5952 ;; upper bound on how much we can match and delete.
5953 (setq len (- opoint (point)))
5954 (if completion-ignore-case
5955 (setq string (downcase string)))
5956 (while (and (> len 0)
5957 (let ((tail (buffer-substring (point) opoint)))
5958 (if completion-ignore-case
5959 (setq tail (downcase tail)))
5960 (not (string= tail (substring string 0 len)))))
5961 (setq len (1- len))
5962 (forward-char 1))
5963 (point))))
5965 (defun choose-completion-delete-max-match (string)
5966 (delete-region (choose-completion-guess-base-position string) (point)))
5967 (make-obsolete 'choose-completion-delete-max-match
5968 'choose-completion-guess-base-position "23.2")
5970 (defvar choose-completion-string-functions nil
5971 "Functions that may override the normal insertion of a completion choice.
5972 These functions are called in order with four arguments:
5973 CHOICE - the string to insert in the buffer,
5974 BUFFER - the buffer in which the choice should be inserted,
5975 MINI-P - non-nil if BUFFER is a minibuffer, and
5976 BASE-SIZE - the number of characters in BUFFER before
5977 the string being completed.
5979 If a function in the list returns non-nil, that function is supposed
5980 to have inserted the CHOICE in the BUFFER, and possibly exited
5981 the minibuffer; no further functions will be called.
5983 If all functions in the list return nil, that means to use
5984 the default method of inserting the completion in BUFFER.")
5986 (defun choose-completion-string (choice &optional buffer base-position)
5987 "Switch to BUFFER and insert the completion choice CHOICE.
5988 BASE-POSITION, says where to insert the completion."
5990 ;; If BUFFER is the minibuffer, exit the minibuffer
5991 ;; unless it is reading a file name and CHOICE is a directory,
5992 ;; or completion-no-auto-exit is non-nil.
5994 ;; Some older code may call us passing `base-size' instead of
5995 ;; `base-position'. It's difficult to make any use of `base-size',
5996 ;; so we just ignore it.
5997 (unless (consp base-position)
5998 (message "Obsolete `base-size' passed to choose-completion-string")
5999 (setq base-position nil))
6001 (let* ((buffer (or buffer completion-reference-buffer))
6002 (mini-p (minibufferp buffer)))
6003 ;; If BUFFER is a minibuffer, barf unless it's the currently
6004 ;; active minibuffer.
6005 (if (and mini-p
6006 (or (not (active-minibuffer-window))
6007 (not (equal buffer
6008 (window-buffer (active-minibuffer-window))))))
6009 (error "Minibuffer is not active for completion")
6010 ;; Set buffer so buffer-local choose-completion-string-functions works.
6011 (set-buffer buffer)
6012 (unless (run-hook-with-args-until-success
6013 'choose-completion-string-functions
6014 ;; The fourth arg used to be `mini-p' but was useless
6015 ;; (since minibufferp can be used on the `buffer' arg)
6016 ;; and indeed unused. The last used to be `base-size', so we
6017 ;; keep it to try and avoid breaking old code.
6018 choice buffer base-position nil)
6019 ;; Insert the completion into the buffer where it was requested.
6020 (delete-region (or (car base-position) (point))
6021 (or (cadr base-position) (point)))
6022 (insert choice)
6023 (remove-text-properties (- (point) (length choice)) (point)
6024 '(mouse-face nil))
6025 ;; Update point in the window that BUFFER is showing in.
6026 (let ((window (get-buffer-window buffer t)))
6027 (set-window-point window (point)))
6028 ;; If completing for the minibuffer, exit it with this choice.
6029 (and (not completion-no-auto-exit)
6030 (minibufferp buffer)
6031 minibuffer-completion-table
6032 ;; If this is reading a file name, and the file name chosen
6033 ;; is a directory, don't exit the minibuffer.
6034 (let* ((result (buffer-substring (field-beginning) (point)))
6035 (bounds
6036 (completion-boundaries result minibuffer-completion-table
6037 minibuffer-completion-predicate
6038 "")))
6039 (if (eq (car bounds) (length result))
6040 ;; The completion chosen leads to a new set of completions
6041 ;; (e.g. it's a directory): don't exit the minibuffer yet.
6042 (let ((mini (active-minibuffer-window)))
6043 (select-window mini)
6044 (when minibuffer-auto-raise
6045 (raise-frame (window-frame mini))))
6046 (exit-minibuffer))))))))
6048 (define-derived-mode completion-list-mode nil "Completion List"
6049 "Major mode for buffers showing lists of possible completions.
6051 to select the completion near point.
6053 with the mouse.
6056 (set (make-local-variable 'completion-base-size) nil))
6058 (defun completion-list-mode-finish ()
6059 "Finish setup of the completions buffer.
6060 Called from `temp-buffer-show-hook'."
6061 (when (eq major-mode 'completion-list-mode)
6062 (toggle-read-only 1)))
6064 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
6067 ;; Variables and faces used in `completion-setup-function'.
6069 (defcustom completion-show-help t
6070 "Non-nil means show help message in *Completions* buffer."
6071 :type 'boolean
6072 :version "22.1"
6073 :group 'completion)
6075 ;; This function goes in completion-setup-hook, so that it is called
6076 ;; after the text of the completion list buffer is written.
6077 (defun completion-setup-function ()
6078 (let* ((mainbuf (current-buffer))
6079 (base-dir
6080 ;; When reading a file name in the minibuffer,
6081 ;; try and find the right default-directory to set in the
6082 ;; completion list buffer.
6083 ;; FIXME: Why do we do that, actually? --Stef
6084 (if minibuffer-completing-file-name
6085 (file-name-as-directory
6086 (expand-file-name
6087 (substring (minibuffer-completion-contents)
6088 0 (or completion-base-size 0)))))))
6089 (with-current-buffer standard-output
6090 (let ((base-size completion-base-size) ;Read before killing localvars.
6091 (base-position completion-base-position))
6092 (completion-list-mode)
6093 (set (make-local-variable 'completion-base-size) base-size)
6094 (set (make-local-variable 'completion-base-position) base-position))
6095 (set (make-local-variable 'completion-reference-buffer) mainbuf)
6096 (if base-dir (setq default-directory base-dir))
6097 ;; Maybe insert help string.
6098 (when completion-show-help
6099 (goto-char (point-min))
6100 (if (display-mouse-p)
6101 (insert (substitute-command-keys
6103 (insert (substitute-command-keys
6107 (add-hook 'completion-setup-hook 'completion-setup-function)
6109 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
6110 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
6112 (defun switch-to-completions ()
6113 "Select the completion list window."
6114 (interactive)
6115 (let ((window (or (get-buffer-window "*Completions*" 0)
6116 ;; Make sure we have a completions window.
6117 (progn (minibuffer-completion-help)
6118 (get-buffer-window "*Completions*" 0)))))
6119 (when window
6120 (select-window window)
6121 ;; In the new buffer, go to the first completion.
6122 ;; FIXME: Perhaps this should be done in `minibuffer-completion-help'.
6123 (when (bobp)
6124 (next-completion 1)))))
6125 \f
6126 ;;; Support keyboard commands to turn on various modifiers.
6128 ;; These functions -- which are not commands -- each add one modifier
6129 ;; to the following event.
6131 (defun event-apply-alt-modifier (ignore-prompt)
6134 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
6135 (defun event-apply-super-modifier (ignore-prompt)
6138 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
6139 (defun event-apply-hyper-modifier (ignore-prompt)
6142 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
6143 (defun event-apply-shift-modifier (ignore-prompt)
6146 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
6147 (defun event-apply-control-modifier (ignore-prompt)
6150 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
6151 (defun event-apply-meta-modifier (ignore-prompt)
6154 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
6156 (defun event-apply-modifier (event symbol lshiftby prefix)
6157 "Apply a modifier flag to event EVENT.
6158 SYMBOL is the name of this modifier, as a symbol.
6159 LSHIFTBY is the numeric value of this modifier, in keyboard events.
6160 PREFIX is the string that represents this modifier in an event type symbol."
6161 (if (numberp event)
6162 (cond ((eq symbol 'control)
6163 (if (and (<= (downcase event) ?z)
6164 (>= (downcase event) ?a))
6165 (- (downcase event) ?a -1)
6166 (if (and (<= (downcase event) ?Z)
6167 (>= (downcase event) ?A))
6168 (- (downcase event) ?A -1)
6169 (logior (lsh 1 lshiftby) event))))
6170 ((eq symbol 'shift)
6171 (if (and (<= (downcase event) ?z)
6172 (>= (downcase event) ?a))
6173 (upcase event)
6174 (logior (lsh 1 lshiftby) event)))
6175 (t
6176 (logior (lsh 1 lshiftby) event)))
6177 (if (memq symbol (event-modifiers event))
6178 event
6179 (let ((event-type (if (symbolp event) event (car event))))
6180 (setq event-type (intern (concat prefix (symbol-name event-type))))
6181 (if (symbolp event)
6182 event-type
6183 (cons event-type (cdr event)))))))
6185 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
6186 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
6187 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
6188 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
6189 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
6190 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
6191 \f
6192 ;;;; Keypad support.
6194 ;; Make the keypad keys act like ordinary typing keys. If people add
6195 ;; bindings for the function key symbols, then those bindings will
6196 ;; override these, so this shouldn't interfere with any existing
6197 ;; bindings.
6199 ;; Also tell read-char how to handle these keys.
6200 (mapc
6201 (lambda (keypad-normal)
6202 (let ((keypad (nth 0 keypad-normal))
6203 (normal (nth 1 keypad-normal)))
6204 (put keypad 'ascii-character normal)
6205 (define-key function-key-map (vector keypad) (vector normal))))
6206 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
6207 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
6208 (kp-space ?\s)
6211 (kp-multiply ?*)
6212 (kp-add ?+)
6213 (kp-separator ?,)
6214 (kp-subtract ?-)
6215 (kp-decimal ?.)
6216 (kp-divide ?/)
6217 (kp-equal ?=)
6218 ;; Do the same for various keys that are represented as symbols under
6219 ;; GUIs but naturally correspond to characters.
6220 (backspace 127)
6221 (delete 127)
6224 (clear ?\C-l)
6225 (return ?\C-m)
6226 (escape ?\e)
6227 ))
6228 \f
6229 ;;;;
6230 ;;;; forking a twin copy of a buffer.
6231 ;;;;
6233 (defvar clone-buffer-hook nil
6234 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
6236 (defvar clone-indirect-buffer-hook nil
6237 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
6239 (defun clone-process (process &optional newname)
6240 "Create a twin copy of PROCESS.
6241 If NEWNAME is nil, it defaults to PROCESS' name;
6242 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
6243 If PROCESS is associated with a buffer, the new process will be associated
6244 with the current buffer instead.
6245 Returns nil if PROCESS has already terminated."
6246 (setq newname (or newname (process-name process)))
6248 (setq newname (substring newname 0 (match-beginning 0))))
6249 (when (memq (process-status process) '(run stop open))
6250 (let* ((process-connection-type (process-tty-name process))
6251 (new-process
6252 (if (memq (process-status process) '(open))
6253 (let ((args (process-contact process t)))
6254 (setq args (plist-put args :name newname))
6255 (setq args (plist-put args :buffer
6256 (if (process-buffer process)
6257 (current-buffer))))
6258 (apply 'make-network-process args))
6259 (apply 'start-process newname
6260 (if (process-buffer process) (current-buffer))
6261 (process-command process)))))
6262 (set-process-query-on-exit-flag
6263 new-process (process-query-on-exit-flag process))
6264 (set-process-inherit-coding-system-flag
6265 new-process (process-inherit-coding-system-flag process))
6266 (set-process-filter new-process (process-filter process))
6267 (set-process-sentinel new-process (process-sentinel process))
6268 (set-process-plist new-process (copy-sequence (process-plist process)))
6269 new-process)))
6271 ;; things to maybe add (currently partly covered by `funcall mode'):
6272 ;; - syntax-table
6273 ;; - overlays
6274 (defun clone-buffer (&optional newname display-flag)
6275 "Create and return a twin copy of the current buffer.
6276 Unlike an indirect buffer, the new buffer can be edited
6277 independently of the old one (if it is not read-only).
6278 NEWNAME is the name of the new buffer. It may be modified by
6279 adding or incrementing <N> at the end as necessary to create a
6280 unique buffer name. If nil, it defaults to the name of the
6281 current buffer, with the proper suffix. If DISPLAY-FLAG is
6282 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
6283 clone a file-visiting buffer, or a buffer whose major mode symbol
6284 has a non-nil `no-clone' property, results in an error.
6286 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
6287 current buffer with appropriate suffix. However, if a prefix
6288 argument is given, then the command prompts for NEWNAME in the
6289 minibuffer.
6291 This runs the normal hook `clone-buffer-hook' in the new buffer
6292 after it has been set up properly in other respects."
6293 (interactive
6294 (progn
6295 (if buffer-file-name
6296 (error "Cannot clone a file-visiting buffer"))
6297 (if (get major-mode 'no-clone)
6298 (error "Cannot clone a buffer in %s mode" mode-name))
6299 (list (if current-prefix-arg
6300 (read-buffer "Name of new cloned buffer: " (current-buffer)))
6301 t)))
6302 (if buffer-file-name
6303 (error "Cannot clone a file-visiting buffer"))
6304 (if (get major-mode 'no-clone)
6305 (error "Cannot clone a buffer in %s mode" mode-name))
6306 (setq newname (or newname (buffer-name)))
6308 (setq newname (substring newname 0 (match-beginning 0))))
6309 (let ((buf (current-buffer))
6310 (ptmin (point-min))
6311 (ptmax (point-max))
6312 (pt (point))
6313 (mk (if mark-active (mark t)))
6314 (modified (buffer-modified-p))
6315 (mode major-mode)
6316 (lvars (buffer-local-variables))
6317 (process (get-buffer-process (current-buffer)))
6318 (new (generate-new-buffer (or newname (buffer-name)))))
6319 (save-restriction
6320 (widen)
6321 (with-current-buffer new
6322 (insert-buffer-substring buf)))
6323 (with-current-buffer new
6324 (narrow-to-region ptmin ptmax)
6325 (goto-char pt)
6326 (if mk (set-mark mk))
6327 (set-buffer-modified-p modified)
6329 ;; Clone the old buffer's process, if any.
6330 (when process (clone-process process))
6332 ;; Now set up the major mode.
6333 (funcall mode)
6335 ;; Set up other local variables.
6336 (mapc (lambda (v)
6337 (condition-case () ;in case var is read-only
6338 (if (symbolp v)
6339 (makunbound v)
6340 (set (make-local-variable (car v)) (cdr v)))
6341 (error nil)))
6342 lvars)
6344 ;; Run any hooks (typically set up by the major mode
6345 ;; for cloning to work properly).
6346 (run-hooks 'clone-buffer-hook))
6347 (if display-flag
6348 ;; Presumably the current buffer is shown in the selected frame, so
6349 ;; we want to display the clone elsewhere.
6350 (let ((same-window-regexps nil)
6351 (same-window-buffer-names))
6352 (pop-to-buffer new)))
6353 new))
6356 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6357 "Create an indirect buffer that is a twin copy of the current buffer.
6359 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6360 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6361 or if not called with a prefix arg, NEWNAME defaults to the current
6362 buffer's name. The name is modified by adding a `<N>' suffix to it
6363 or by incrementing the N in an existing suffix. Trying to clone a
6364 buffer whose major mode symbol has a non-nil `no-clone-indirect'
6365 property results in an error.
6367 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6368 This is always done when called interactively.
6370 Optional third arg NORECORD non-nil means do not put this buffer at the
6371 front of the list of recently selected ones."
6372 (interactive
6373 (progn
6374 (if (get major-mode 'no-clone-indirect)
6375 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6376 (list (if current-prefix-arg
6377 (read-buffer "Name of indirect buffer: " (current-buffer)))
6378 t)))
6379 (if (get major-mode 'no-clone-indirect)
6380 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6381 (setq newname (or newname (buffer-name)))
6383 (setq newname (substring newname 0 (match-beginning 0))))
6384 (let* ((name (generate-new-buffer-name newname))
6385 (buffer (make-indirect-buffer (current-buffer) name t)))
6386 (with-current-buffer buffer
6387 (run-hooks 'clone-indirect-buffer-hook))
6388 (when display-flag
6389 (pop-to-buffer buffer norecord))
6390 buffer))
6393 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6394 "Like `clone-indirect-buffer' but display in another window."
6395 (interactive
6396 (progn
6397 (if (get major-mode 'no-clone-indirect)
6398 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6399 (list (if current-prefix-arg
6400 (read-buffer "Name of indirect buffer: " (current-buffer)))
6401 t)))
6402 (let ((pop-up-windows t))
6403 (clone-indirect-buffer newname display-flag norecord)))
6405 \f
6406 ;;; Handling of Backspace and Delete keys.
6408 (defcustom normal-erase-is-backspace 'maybe
6409 "Set the default behavior of the Delete and Backspace keys.
6411 If set to t, Delete key deletes forward and Backspace key deletes
6412 backward.
6414 If set to nil, both Delete and Backspace keys delete backward.
6416 If set to 'maybe (which is the default), Emacs automatically
6417 selects a behavior. On window systems, the behavior depends on
6418 the keyboard used. If the keyboard has both a Backspace key and
6419 a Delete key, and both are mapped to their usual meanings, the
6420 option's default value is set to t, so that Backspace can be used
6421 to delete backward, and Delete can be used to delete forward.
6423 If not running under a window system, customizing this option
6424 accomplishes a similar effect by mapping C-h, which is usually
6425 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6426 via `keyboard-translate'. The former functionality of C-h is
6427 available on the F1 key. You should probably not use this
6428 setting if you don't have both Backspace, Delete and F1 keys.
6430 Setting this variable with setq doesn't take effect. Programmatically,
6431 call `normal-erase-is-backspace-mode' (which see) instead."
6432 :type '(choice (const :tag "Off" nil)
6433 (const :tag "Maybe" maybe)
6434 (other :tag "On" t))
6435 :group 'editing-basics
6436 :version "21.1"
6437 :set (lambda (symbol value)
6438 ;; The fboundp is because of a problem with :set when
6439 ;; dumping Emacs. It doesn't really matter.
6440 (if (fboundp 'normal-erase-is-backspace-mode)
6441 (normal-erase-is-backspace-mode (or value 0))
6442 (set-default symbol value))))
6444 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6445 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6446 (unless frame (setq frame (selected-frame)))
6447 (with-selected-frame frame
6448 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6449 (normal-erase-is-backspace-mode
6450 (if (if (eq normal-erase-is-backspace 'maybe)
6451 (and (not noninteractive)
6452 (or (memq system-type '(ms-dos windows-nt))
6453 (and (memq window-system '(x))
6454 (fboundp 'x-backspace-delete-keys-p)
6455 (x-backspace-delete-keys-p))
6456 ;; If the terminal Emacs is running on has erase char
6457 ;; set to ^H, use the Backspace key for deleting
6458 ;; backward, and the Delete key for deleting forward.
6459 (and (null window-system)
6460 (eq tty-erase-char ?\^H))))
6461 normal-erase-is-backspace)
6462 1 0)))))
6464 (define-minor-mode normal-erase-is-backspace-mode
6465 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6467 With numeric ARG, turn the mode on if and only if ARG is positive.
6469 On window systems, when this mode is on, Delete is mapped to C-d
6470 and Backspace is mapped to DEL; when this mode is off, both
6471 Delete and Backspace are mapped to DEL. (The remapping goes via
6472 `local-function-key-map', so binding Delete or Backspace in the
6473 global or local keymap will override that.)
6475 In addition, on window systems, the bindings of C-Delete, M-Delete,
6476 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6477 the global keymap in accordance with the functionality of Delete and
6478 Backspace. For example, if Delete is remapped to C-d, which deletes
6479 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6480 to DEL, which deletes backward, C-Delete is bound to
6481 `backward-kill-word'.
6483 If not running on a window system, a similar effect is accomplished by
6484 remapping C-h (normally produced by the Backspace key) and DEL via
6485 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6486 to C-d; if it's off, the keys are not remapped.
6488 When not running on a window system, and this mode is turned on, the
6489 former functionality of C-h is available on the F1 key. You should
6490 probably not turn on this mode on a text-only terminal if you don't
6491 have both Backspace, Delete and F1 keys.
6493 See also `normal-erase-is-backspace'."
6494 :variable (eq (terminal-parameter
6495 nil 'normal-erase-is-backspace) 1)
6496 (let ((enabled (eq 1 (terminal-parameter
6497 nil 'normal-erase-is-backspace))))
6499 (cond ((or (memq window-system '(x w32 ns pc))
6500 (memq system-type '(ms-dos windows-nt)))
6501 (let* ((bindings
6502 `(([M-delete] [M-backspace])
6503 ([C-M-delete] [C-M-backspace])
6504 ([?\e C-delete] [?\e C-backspace])))
6505 (old-state (lookup-key local-function-key-map [delete])))
6507 (if enabled
6508 (progn
6509 (define-key local-function-key-map [delete] [?\C-d])
6510 (define-key local-function-key-map [kp-delete] [?\C-d])
6511 (define-key local-function-key-map [backspace] [?\C-?])
6512 (dolist (b bindings)
6513 ;; Not sure if input-decode-map is really right, but
6514 ;; keyboard-translate-table (used below) only works
6515 ;; for integer events, and key-translation-table is
6516 ;; global (like the global-map, used earlier).
6517 (define-key input-decode-map (car b) nil)
6518 (define-key input-decode-map (cadr b) nil)))
6519 (define-key local-function-key-map [delete] [?\C-?])
6520 (define-key local-function-key-map [kp-delete] [?\C-?])
6521 (define-key local-function-key-map [backspace] [?\C-?])
6522 (dolist (b bindings)
6523 (define-key input-decode-map (car b) (cadr b))
6524 (define-key input-decode-map (cadr b) (car b))))))
6525 (t
6526 (if enabled
6527 (progn
6528 (keyboard-translate ?\C-h ?\C-?)
6529 (keyboard-translate ?\C-? ?\C-d))
6530 (keyboard-translate ?\C-h ?\C-h)
6531 (keyboard-translate ?\C-? ?\C-?))))
6533 (if (called-interactively-p 'interactive)
6534 (message "Delete key deletes %s"
6535 (if (eq 1 (terminal-parameter nil 'normal-erase-is-backspace))
6536 "forward" "backward")))))
6537 \f
6538 (defvar vis-mode-saved-buffer-invisibility-spec nil
6539 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6541 (define-minor-mode visible-mode
6542 "Toggle Visible mode.
6543 With argument ARG turn Visible mode on if ARG is positive, otherwise
6544 turn it off.
6546 Enabling Visible mode makes all invisible text temporarily visible.
6547 Disabling Visible mode turns off that effect. Visible mode works by
6548 saving the value of `buffer-invisibility-spec' and setting it to nil."
6549 :lighter " Vis"
6550 :group 'editing-basics
6551 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6552 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6553 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6554 (when visible-mode
6555 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6556 buffer-invisibility-spec)
6557 (setq buffer-invisibility-spec nil)))
6558 \f
6559 ;; Partial application of functions (similar to "currying").
6560 ;; This function is here rather than in subr.el because it uses CL.
6561 (defun apply-partially (fun &rest args)
6562 "Return a function that is a partial application of FUN to ARGS.
6563 ARGS is a list of the first N arguments to pass to FUN.
6564 The result is a new function which does the same as FUN, except that
6565 the first N arguments are fixed at the values with which this function
6566 was called."
6567 (lexical-let ((fun fun) (args1 args))
6568 (lambda (&rest args2) (apply fun (append args1 args2)))))
6569 \f
6570 ;; Minibuffer prompt stuff.
6572 ;(defun minibuffer-prompt-modification (start end)
6573 ; (error "You cannot modify the prompt"))
6574 ;
6575 ;
6576 ;(defun minibuffer-prompt-insertion (start end)
6577 ; (let ((inhibit-modification-hooks t))
6578 ; (delete-region start end)
6579 ; ;; Discard undo information for the text insertion itself
6580 ; ;; and for the text deletion.above.
6581 ; (when (consp buffer-undo-list)
6582 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6583 ; (message "You cannot modify the prompt")))
6584 ;
6585 ;
6586 ;(setq minibuffer-prompt-properties
6587 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6588 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6589 ;
6591 \f
6592 ;;;; Problematic external packages.
6594 ;; rms says this should be done by specifying symbols that define
6595 ;; versions together with bad values. This is therefore not as
6596 ;; flexible as it could be. See the thread:
6597 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6598 (defconst bad-packages-alist
6599 ;; Not sure exactly which semantic versions have problems.
6600 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6602 "The version of `semantic' loaded does not work in Emacs 22.
6603 It can cause constant high CPU load.
6604 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6605 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6606 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6607 ;; provided the `CUA-mode' feature. Since this is no longer true,
6608 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6609 (CUA-mode t nil
6610 "CUA-mode is now part of the standard GNU Emacs distribution,
6611 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6613 You have loaded an older version of CUA-mode which does not work
6614 correctly with this version of Emacs. You should remove the old
6615 version and use the one distributed with Emacs."))
6616 "Alist of packages known to cause problems in this version of Emacs.
6617 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6618 PACKAGE is either a regular expression to match file names, or a
6619 symbol (a feature name); see the documentation of
6620 `after-load-alist', to which this variable adds functions.
6621 SYMBOL is either the name of a string variable, or `t'. Upon
6622 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6623 warning using STRING as the message.")
6625 (defun bad-package-check (package)
6626 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6627 (condition-case nil
6628 (let* ((list (assoc package bad-packages-alist))
6629 (symbol (nth 1 list)))
6630 (and list
6631 (boundp symbol)
6632 (or (eq symbol t)
6633 (and (stringp (setq symbol (eval symbol)))
6634 (string-match-p (nth 2 list) symbol)))
6635 (display-warning package (nth 3 list) :warning)))
6636 (error nil)))
6638 (mapc (lambda (elem)
6639 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6640 bad-packages-alist)
6643 (provide 'simple)
6645 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
6646 ;;; simple.el ends here