| blob | 3e38d59a6924ee6592d119b12d58acf89f642f94 |
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
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:
38 "*Idle time delay before updating various things on the screen.
39 Various Emacs features that update auxiliary information when point moves
40 wait this many seconds after Emacs becomes idle before doing an update."
46 "Killing and yanking commands."
50 "Highlight (un)matching of parens and expressions."
54 "Search LIST for a valid buffer to display in FRAME.
55 Return nil when all buffers in LIST are undesirable for display,
56 otherwise return the first suitable buffer in LIST.
58 Buffers not visible in windows are preferred to visible buffers,
59 unless VISIBLE-OK is non-nil.
60 If the optional argument FRAME is nil, it defaults to the selected frame.
61 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
62 ;; This logic is more or less copied from other-buffer.
65 found buf)
78 "Return the last non-hidden displayable buffer in the buffer list.
79 If BUFFER is non-nil, last-buffer will ignore that buffer.
80 Buffers not visible in windows are preferred to visible buffers,
81 unless optional argument VISIBLE-OK is non-nil.
82 If the optional third argument FRAME is non-nil, use that frame's
83 buffer list instead of the selected frame's buffer list.
84 If no other buffer exists, the buffer `*scratch*' is returned."
87 buffer visible-ok frame)
92 "Switch to the next buffer in cyclic order."
99 "Switch to the previous buffer in cyclic order."
103 \f
104 ;;; next-error support framework
107 "`next-error' support framework."
113 "Face used to highlight next error locus."
118 "*Highlighting of locations in selected source buffers.
119 If a number, highlight the locus in `next-error' face for the given time
120 in seconds, or until the next command is executed.
121 If t, highlight the locus until the next command is executed, or until
122 some other locus replaces it.
123 If nil, don't highlight the locus in the source buffer.
124 If `fringe-arrow', indicate the locus by the fringe arrow."
133 "*Highlighting of locations in `next-error-no-select'.
134 If number, highlight the locus in `next-error' face for given time in seconds.
135 If t, highlight the locus indefinitely until some other locus replaces it.
136 If nil, don't highlight the locus in the source buffer.
137 If `fringe-arrow', indicate the locus by the fringe arrow."
146 "*Display the line in the visited source file recentered as specified.
147 If non-nil, the value is passed directly to `recenter'."
155 "*List of hook functions run by `next-error' after visiting source file."
166 "The most recent `next-error' buffer.
167 A buffer becomes most recent when its compilation, grep, or
172 "Function to use to find the next error in the current buffer.
173 The function is called with 2 parameters:
174 ARG is an integer specifying by how many errors to move.
175 RESET is a boolean which, if non-nil, says to go back to the beginning
176 of the errors before moving.
177 Major modes providing compile-like functionality should set this variable
178 to indicate to `next-error' that this is a candidate buffer and how
184 &optional avoid-current
185 extra-test-inclusive
186 extra-test-exclusive)
187 "Test if BUFFER is a `next-error' capable buffer.
189 If AVOID-CURRENT is non-nil, treat the current buffer
190 as an absolute last resort only.
192 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
193 that normally would not qualify. If it returns t, the buffer
194 in question is treated as usable.
196 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
197 that would normally be considered usable. If it returns nil,
198 that buffer is rejected."
203 ;; Optionally reject some buffers.
206 t)
207 ;; Optionally accept some other buffers.
212 extra-test-inclusive
213 extra-test-exclusive)
214 "Return a `next-error' capable buffer.
216 If AVOID-CURRENT is non-nil, treat the current buffer
217 as an absolute last resort only.
219 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
220 that normally would not qualify. If it returns t, the buffer
221 in question is treated as usable.
223 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
224 that would normally be considered usable. If it returns nil,
225 that buffer is rejected."
227 ;; 1. If one window on the selected frame displays such buffer, return it.
233 avoid-current
234 extra-test-inclusive extra-test-exclusive)
239 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
242 extra-test-inclusive extra-test-exclusive))
243 next-error-last-buffer)
244 ;; 3. If the current buffer is acceptable, choose it.
246 extra-test-inclusive extra-test-exclusive)
248 ;; 4. Look for any acceptable buffer.
253 extra-test-inclusive extra-test-exclusive)))
256 ;; 5. Use the current buffer as a last resort if it qualifies,
257 ;; even despite AVOID-CURRENT.
260 extra-test-inclusive extra-test-exclusive)
264 ;; 6. Give up.
268 "Visit next `next-error' message and corresponding source code.
270 If all the error messages parsed so far have been processed already,
271 the message buffer is checked for new ones.
273 A prefix ARG specifies how many error messages to move;
274 negative means move back to previous error messages.
276 and start at the first error.
278 The RESET argument specifies that we should restart from the beginning.
281 compilation, grep, or occur buffer. It can also operate on any
283 more generally, on any buffer in Compilation mode or with
284 Compilation Minor mode enabled, or any buffer in which
285 `next-error-function' is bound to an appropriate function.
286 To specify use of a particular buffer for error messages, type
288 in the current frame.
291 runs `next-error-hook' with `run-hooks', and stays with that buffer
292 until you use it in some other buffer which uses Compilation mode
293 or Compilation Minor mode.
295 See variables `compilation-parse-errors-function' and
296 \`compilation-error-regexp-alist' for customization ideas."
300 ;; we know here that next-error-function is a valid symbol we can funcall
308 "Visit the source code corresponding to the `next-error' message at point."
310 ;; we know here that next-error-function is a valid symbol we can funcall
321 "Visit previous `next-error' message and corresponding source code.
323 Prefix arg N says how many error messages to move backwards (or
324 forwards, if negative).
331 "Restart at the first error.
332 Visit corresponding source code.
333 With prefix arg N, visit the source code of the Nth error.
339 "Move point to the next error in the `next-error' buffer and highlight match.
340 Prefix arg N says how many error messages to move forwards (or
341 backwards, if negative).
343 select the source buffer."
350 "Move point to the previous error in the `next-error' buffer and highlight match.
351 Prefix arg N says how many error messages to move backwards (or
352 forwards, if negative).
354 select the source buffer."
358 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
362 "Minor mode for compilation, occur and diff modes.
363 When turned on, cursor motion in the compilation, grep, occur or diff
364 buffer causes automatic display of the corresponding source code
365 location."
372 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
373 ;;; for the *Compilation* *grep* and *Occur* buffers.
383 \f
384 ;;;
387 "Major mode not specialized for anything in particular.
388 Other major modes are defined by comparison with this one."
394 ;; Special major modes to view specially formatted data rather than files.
406 map))
410 "Parent major mode from which special major modes should inherit."
413 ;; Making and deleting lines.
418 "Insert a newline, and move to left margin of the new line if it's blank.
419 If `use-hard-newlines' is non-nil, the newline is marked with the
420 text-property `hard'.
421 With ARG, insert that many newlines.
422 Call `auto-fill-function' if the current column number is greater
423 than the value of `fill-column' and ARG is nil."
426 ;; Inserting a newline at the end of a line produces better redisplay in
427 ;; try_window_id than inserting at the beginning of a line, and the textual
428 ;; result is the same. So, if we're at beginning of line, pretend to be at
429 ;; the end of the previous line.
432 ;; Make sure no functions want to be told about
433 ;; the range of the changes.
436 ;; Make sure there are no markers here.
439 ;; Make sure no text properties want to know
440 ;; where the change was.
445 ;; Make sure the newline before point isn't intangible.
447 ;; Make sure the newline before point isn't read-only.
449 ;; Make sure the newline before point isn't invisible.
451 ;; Make sure the newline before point has the same
452 ;; properties as the char before it (if any).
459 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
460 ;; Set last-command-char to tell self-insert what to insert.
462 ;; Don't auto-fill if we have a numeric argument.
463 ;; Also not if flag is true (it would fill wrong line);
464 ;; there is no need to since we're at BOL.
468 ;; If we get an error in self-insert-command, put point at right place.
470 ;; Even if we did *not* get an error, keep that forward-char;
471 ;; all further processing should apply to the newline that the user
472 ;; thinks he inserted.
474 ;; Mark the newline(s) `hard'.
478 ;; If the newline leaves the previous line blank,
479 ;; and we have a left margin, delete that from the blank line.
487 ;; Indent the line after the newline, except in one case:
488 ;; when we added the newline at the beginning of a line
489 ;; which starts a page.
492 nil)
497 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
503 "Insert a newline and leave point before it.
504 If there is a fill prefix and/or a `left-margin', insert them
505 on the new line if the line would have been blank.
506 With arg N, insert N newlines."
511 ;; Don't expand an abbrev before point.
525 "Split current line, moving portion beyond point vertically down.
526 If the current line starts with `fill-prefix', insert it on the new
527 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
529 When called from Lisp code, ARG may be a prefix string to copy."
534 ;; What prefix should we check for (nil means don't).
538 ;; Does this line start with it?
549 "Join this line to previous and fix up whitespace at join.
550 If there is a fill prefix, delete it from the beginning of this line.
551 With argument, join this line to following line."
558 ;; If the second line started with the fill prefix,
559 ;; delete the prefix.
571 "On blank line, delete all surrounding blank lines, leaving just one.
572 On isolated blank line, delete that one.
573 On nonblank line, delete any immediately following blank lines."
579 ;; Set singleblank if there is just one blank line here.
586 ;; Delete preceding blank lines, and this one too if it's the only one.
595 ;; Delete following blank lines, unless the current line is blank
596 ;; and there are no following blank lines.
605 ;; Handle the special case where point is followed by newline and eob.
606 ;; Delete the line, leaving point at eob.
611 "Delete all the trailing whitespace across the current buffer.
612 All whitespace after the last non-whitespace character in a line is deleted.
614 A formfeed is not considered whitespace by this function."
621 ;; Don't delete formfeeds, even if they are considered whitespace.
628 "Insert a newline, then indent according to major mode.
629 Indentation is done using the value of `indent-line-function'.
630 In programming language modes, this is the same as TAB.
631 In some text modes, where TAB inserts a tab, this command indents to the
632 column specified by the function `current-left-margin'."
639 "Reindent current line, insert newline, then indent the new line.
640 Indentation of both lines is done according to the current major mode,
641 which means calling the current value of `indent-line-function'.
642 In programming language modes, this is the same as TAB.
643 In some text modes, where TAB inserts a tab, this indents to the
644 column specified by the function `current-left-margin'."
647 ;; Be careful to insert the newline before indenting the line.
648 ;; Otherwise, the indentation might be wrong.
652 ;; We are at EOL before the call to indent-according-to-mode, and
653 ;; after it we usually are as well, but not always. We tried to
654 ;; address it with `save-excursion' but that uses a normal marker
655 ;; whereas we need `move after insertion', so we do the save/restore
656 ;; by hand.
660 ;; Remove the trailing white-space after indentation because
661 ;; indentation may introduce the whitespace.
666 "Read next input character and insert it.
667 This is useful for inserting control characters.
669 If the first character you type after this command is an octal digit,
670 you should type a sequence of octal digits which specify a character code.
671 Any nondigit terminates the sequence. If the terminator is a RET,
672 it is discarded; any other terminator is used itself as input.
673 The variable `read-quoted-char-radix' specifies the radix for this feature;
674 set it to 10 or 16 to use decimal or hex instead of octal.
676 In overwrite mode, this function inserts the character anyway, and
677 does not handle octal digits specially. This means that if you use
678 overwrite as your normal editing mode, you can use this function to
679 insert characters when necessary.
681 In binary overwrite mode, this function does overwrite, and octal
682 digits are interpreted as a character code. This is intended to be
683 useful for editing binary files."
690 ;; This used to assume character codes 0240 - 0377 stand for
691 ;; characters in some single-byte character set, and converted them
692 ;; to Emacs characters. But in 23.1 this feature is deprecated
693 ;; in favor of inserting the corresponding Unicode characters.
694 ;; (if (and enable-multibyte-characters
695 ;; (>= char ?\240)
696 ;; (<= char ?\377))
697 ;; (setq char (unibyte-char-to-multibyte char)))
706 "Move forward ARG lines and position at first nonblank character."
712 "Move backward ARG lines and position at first nonblank character."
718 "Move point to the first non-whitespace character on this line."
722 ;; Move back over chars that have whitespace syntax but have the p flag.
726 "Fixup white space between objects around point.
727 Leave one space or none, according to the context."
734 nil
738 "Delete all spaces and tabs around point.
739 If BACKWARD-ONLY is non-nil, only delete them before point."
744 orig-pos
753 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
767 \f
769 "Move point to the beginning of the buffer; leave mark at previous position.
771 With numeric arg N, put point N/10 of the way from the beginning.
773 If the buffer is narrowed, this command uses the beginning and size
774 of the accessible part of the buffer.
776 Don't use this command in Lisp programs!
777 \(goto-char (point-min)) is faster and avoids clobbering the mark."
786 ;; Avoid overflow for large buffer sizes!
794 "Move point to the end of the buffer; leave mark at previous position.
796 With numeric arg N, put point N/10 of the way from the end.
798 If the buffer is narrowed, this command uses the beginning and size
799 of the accessible part of the buffer.
801 Don't use this command in Lisp programs!
802 \(goto-char (point-max)) is faster and avoids clobbering the mark."
809 ;; Avoid overflow for large buffer sizes!
814 ;; If we went to a place in the middle of the buffer,
815 ;; adjust it to the beginning of a line.
818 ;; If the end of the buffer is not already on the screen,
819 ;; then scroll specially to put it near, but not at, the bottom.
824 "Put point at beginning and mark at end of buffer.
825 You probably should not use this function in Lisp programs;
826 it is usually a mistake for a Lisp function to use any subroutine
827 that uses or sets the mark."
832 \f
834 ;; Counting lines, one way or another.
837 "Goto line ARG, counting from line 1 at beginning of buffer.
838 Normally, move point in the current buffer, and leave mark at previous
840 in the most recently displayed other buffer, and switch to it.
841 When called from Lisp code, the optional argument BUFFER specifies
842 a buffer to switch to.
844 If there's a number in the buffer at point, it is the default for ARG."
848 ;; Look for a default, a number in the buffer at point.
857 ;; Decide if we're switching buffers.
865 ;; Read the argument, offering that number (if any) as default.
868 buffer-prompt
869 default)
870 nil nil t
871 'minibuffer-history
872 default)
873 buffer))))
874 ;; Switch to the desired buffer, one way or another.
879 ;; Leave mark at previous position
881 ;; Move to the specified line number in that buffer.
890 "Print number of lines and characters in the region."
896 "Print the current buffer line number and narrowed line number of point."
909 "Return number of lines between START and END.
910 This is usually the number of newlines between them,
911 but can be one more if START is not equal to END
912 and the greater of them is not at the start of a line."
928 done)))
932 "Return (narrowed) buffer line number at position POS.
933 If POS is nil, use current buffer location.
934 Counting starts at (point-min), so the value refers
935 to the contents of the accessible portion of the buffer."
945 "Print info on cursor position (on screen and within buffer).
946 Also describe the character after point, and give its character code
947 in octal, decimal and hex.
949 For a non-ASCII multibyte character, also give its encoding in the
950 buffer's selected coding system if the coding system encodes the
951 character safely. If the character is encoded into one byte, that
952 code is shown in hex. If the character is encoded into more than one
955 In addition, with prefix argument, show details about that character
956 in *Help* buffer. See also the command `describe-char'."
964 ;; Avoid overflow from multiplying by 100!
968 ""
974 pos total percent beg end col hscroll)
976 pos total col hscroll))
978 encoded encoding-msg display-prop under-display)
985 ;; Check if the character is displayed with some `display'
986 ;; text property. In that case, set under-display to the
987 ;; buffer substring covered by that property.
998 under-display)))
1004 char char char under-display)
1006 char char char under-display display-prop))
1009 char char char
1011 "..."
1015 ;; We show the detailed information about CHAR.
1022 encoding-msg pos total percent beg end col hscroll)
1029 encoding-msg pos total percent col hscroll))))))
1030 \f
1031 ;; Initialize read-expression-map. It is defined at C level.
1043 "Value for `print-level' while printing value in `eval-expression'.
1044 A value of nil means no limit."
1050 "Value for `print-length' while printing value in `eval-expression'.
1051 A value of nil means no limit."
1057 "If non-nil set `debug-on-error' to t in `eval-expression'.
1058 If nil, don't change the value of `debug-on-error'."
1064 "Format VALUE as a result of evaluated expression.
1065 Return a formatted string which is displayed in the echo area
1066 in addition to the value printed by prin1 in functions which
1067 display the result of expression evaluation."
1080 ;; We define this, rather than making `eval' interactive,
1081 ;; for the sake of completion of names like eval-region, eval-buffer.
1084 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1085 Value is also consed on to front of the variable `values'.
1086 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1087 insert the result into the current buffer instead of printing it in
1088 the echo area.
1090 If `eval-expression-debug-on-error' is non-nil, which is the default,
1091 this command arranges for all errors to enter the debugger."
1095 nil read-expression-map t
1097 current-prefix-arg))
1102 ;; Bind debug-on-error to something unique so that we can
1103 ;; detect when evaled code changes it.
1107 ;; If evaled code has changed the value of debug-on-error,
1108 ;; propagate that change to the global binding.
1124 "Prompting with PROMPT, let user edit COMMAND and eval result.
1125 COMMAND is a Lisp expression. Let user edit that expression in
1126 the minibuffer, then read and evaluate the result."
1133 read-expression-map t
1135 ;; If command was added to command-history as a string,
1136 ;; get rid of that. We want only evaluable expressions there.
1140 ;; If command to be redone does not match front of history,
1141 ;; add it to the history.
1147 "Edit and re-evaluate last complex command, or ARGth from last.
1148 A complex command is one which used the minibuffer.
1149 The command is placed in the minibuffer as a Lisp form for editing.
1150 The result is executed, repeating the command as changed.
1151 If the command has been changed or is not the most recent previous command
1152 it is added to the front of the command history.
1153 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1154 to get different commands to edit and resubmit."
1157 newcmd)
1169 ;; If command was added to command-history as a
1170 ;; string, get rid of that. We want only
1171 ;; evaluable expressions there.
1175 ;; If command to be redone does not match front of history,
1176 ;; add it to the history.
1183 \f
1185 "Default minibuffer history list.
1186 This is used for all minibuffer input
1187 except when an alternate history list is specified.
1189 Maximum length of the history list is determined by the value
1192 "Control whether history list elements are expressions or strings.
1193 If the value of this variable equals current minibuffer depth,
1194 they are expressions; otherwise they are strings.
1195 \(That convention is designed to do the right thing for
1202 "Text that was in this minibuffer before any history commands.
1203 This is nil if there have not yet been any history commands
1212 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1216 "*Minibuffer history variables for which matching should ignore case.
1217 If a history variable is a member of this list, then the
1219 commands ignore case when searching it, regardless of `case-fold-search'."
1224 "Find the previous history element that matches REGEXP.
1225 \(Previous history elements refer to earlier actions.)
1226 With prefix argument N, search for Nth previous match.
1227 If N is negative, find the next or Nth next match.
1228 Normally, history elements are matched case-insensitively if
1229 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1230 makes the search case-sensitive.
1231 See also `minibuffer-history-case-insensitive-variables'."
1235 nil
1236 minibuffer-local-map
1237 nil
1238 'minibuffer-history-search-history
1240 ;; Use the last regexp specified, by default, if input is empty.
1245 regexp)
1255 ;; On some systems, ignore case for file names.
1257 minibuffer-history-case-insensitive-variables)
1258 t
1259 ;; Respect the user's setting for case-fold-search:
1260 case-fold-search)
1261 nil))
1262 prevpos
1263 match-string
1264 match-offset
1271 "No later matching history item"
1292 next-matching-history-element))
1296 "Find the next history element that matches REGEXP.
1297 \(The next history element refers to a more recent action.)
1298 With prefix argument N, search for Nth next match.
1299 If N is negative, find the previous or Nth previous match.
1300 Normally, history elements are matched case-insensitively if
1301 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1302 makes the search case-sensitive."
1306 nil
1307 minibuffer-local-map
1308 nil
1309 'minibuffer-history-search-history
1311 ;; Use the last regexp specified, by default, if input is empty.
1316 regexp)
1323 "Function run by `goto-history-element' before consuming `minibuffer-default'.
1324 This is useful to dynamically add more elements to the list `minibuffer-default'
1325 when `goto-history-element' reaches the end of this list.
1326 Before calling this function `goto-history-element' sets the variable
1327 `minibuffer-default-add-done' to t, so it will call this function only
1328 once. In special cases, when this function needs to be called more
1329 than once, it can set `minibuffer-default-add-done' to nil explicitly,
1333 "When nil, add more elements to the end of the list of default values.
1334 The value nil causes `goto-history-element' to add more elements to
1335 the list of defaults when it reaches the end of this list. It does
1341 "Return a list of all completions without the default value.
1342 This function is used to add all elements of the completion table to
1343 the end of the list of defaults just after the default value."
1347 minibuffer-completion-table
1348 minibuffer-completion-predicate
1349 t)))
1355 "Puts element of the minibuffer history in the minibuffer.
1356 The argument NABS specifies the absolute history position."
1370 elt minibuffer-returned-to-present)
1382 previous-history-element))
1394 minibuffer-default)))
1406 elt))
1410 "Puts next element of the minibuffer history in the minibuffer.
1411 With argument N, it uses the Nth following element."
1417 "Puts previous element of the minibuffer history in the minibuffer.
1418 With argument N, it uses the Nth previous element."
1424 "Get next history element which completes the minibuffer before the point.
1425 The contents of the minibuffer after the point are deleted, and replaced
1426 by the new completion."
1432 n)
1433 ;; next-matching-history-element always puts us at (point-min).
1434 ;; Move to the position we were at before changing the buffer contents.
1435 ;; This is still sensical, because the text before point has not changed.
1439 "\
1440 Get previous history element which completes the minibuffer before the point.
1441 The contents of the minibuffer after the point are deleted, and replaced
1442 by the new completion."
1446 ;; For compatibility with the old subr of the same name.
1448 "Return the display width of the minibuffer prompt.
1449 Return 0 if current buffer is not a minibuffer."
1450 ;; Return the width of everything before the field at the end of
1451 ;; the buffer; this should be 0 for normal buffers.
1453 \f
1454 ;; isearch minibuffer history
1461 "Set up a minibuffer for using isearch to search the minibuffer history.
1462 Intended to be added to `minibuffer-setup-hook'."
1474 "Clean up the minibuffer after terminating isearch in the minibuffer."
1479 "Return the proper search function, for isearch in minibuffer history."
1486 ;; Use standard functions to search within minibuffer text
1492 found)
1493 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1494 ;; searching forward. Lazy-highlight calls this lambda with the
1495 ;; bound arg, so skip the minibuffer prompt.
1499 ;; 1. First try searching in the initial minibuffer text
1502 noerror)
1503 ;; 2. If the above search fails, start putting next/prev history
1504 ;; elements in the minibuffer successively, and search the string
1505 ;; in them. Do this only when bound is nil (i.e. not while
1506 ;; lazy-highlighting search strings in the current minibuffer text).
1518 ;; After putting the next/prev history element, search
1519 ;; the string in them again, until next-history-element
1520 ;; or previous-history-element raises an error at the
1521 ;; beginning/end of history.
1524 ;; For backward search, don't search
1525 ;; in the minibuffer prompt
1527 noerror)))
1528 ;; Return point of the new search result
1530 ;; Return nil when next(prev)-history-element fails
1534 "Display the minibuffer history search prompt.
1535 If there are no search errors, this function displays an overlay with
1536 the isearch prompt which replaces the original minibuffer prompt.
1537 Otherwise, it displays the standard isearch message returned from
1538 `isearch-message'."
1540 ;; Use standard function `isearch-message' when not in the minibuffer,
1541 ;; or search fails, or has an error (like incomplete regexp).
1542 ;; This function overwrites minibuffer text with isearch message,
1543 ;; so it's possible to see what is wrong in the search string.
1545 ;; Otherwise, put the overlay with the standard isearch prompt over
1546 ;; the initial minibuffer prompt.
1555 ;; And clear any previous isearch message.
1559 "Wrap the minibuffer history search when search is failed.
1560 Move point to the first history element for a forward search,
1561 or to the last history element for a backward search."
1563 ;; When `minibuffer-history-isearch-search' fails on reaching the
1564 ;; beginning/end of the history, wrap the search to the first/last
1565 ;; minibuffer history element.
1573 "Save a function restoring the state of minibuffer history search.
1574 Save `minibuffer-history-position' to the additional state parameter
1575 in the search status stack."
1580 "Restore the minibuffer history search state.
1581 Go to the history element by the absolute history position `hist-pos'."
1584 \f
1585 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1589 "Table mapping redo records to the corresponding undo one.
1590 A redo record for undo-in-region maps to t.
1600 "Within a run of consecutive undo commands, list remaining to be undone.
1604 "Undo some previous changes.
1605 Repeat this command to undo more changes.
1606 A numeric argument serves as a repeat count.
1608 In Transient Mark mode when the mark is active, only undo changes within
1610 as an argument limits undo to changes within the current region."
1612 ;; Make last-command indicate for the next command that this was an undo.
1613 ;; That way, another undo will undo more.
1614 ;; If we get to the end of the undo history and get an error,
1615 ;; another undo command will find the undo history empty
1616 ;; and will get another error. To begin undoing the undos,
1617 ;; you must type some other command.
1620 message)
1621 ;; If we get an error in undo-start,
1622 ;; the next command should not be a "consecutive undo".
1623 ;; So set `this-command' to something other than `undo'.
1628 ;; If something (a timer or filter?) changed the buffer
1629 ;; since the previous command, don't continue the undo seq.
1633 ;; If the last undo record made was made by undo
1634 ;; it shows nothing else happened in between.
1641 ;; get rid of initial undo boundary
1643 ;; If we got this far, the next command should be a consecutive undo.
1645 ;; Check to see whether we're hitting a redo record, and if
1646 ;; so, ask the user whether she wants to skip the redo/undo pair.
1653 ;; The equiv entry might point to another redo record if we have done
1654 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1662 ;; Record the fact that the just-generated undo records come from an
1663 ;; undo operation--that is, they are redo records.
1664 ;; In the ordinary case (not within a region), map the redo
1665 ;; record to the following undos.
1666 ;; I don't know how to do that in the undo-in-region case.
1669 undo-equiv-table)
1670 ;; Don't specify a position in the undo record for the undo command.
1671 ;; Instead, undoing this should move point to where the change is.
1690 ;; Record what the current undo list says,
1691 ;; so the next command can tell if the buffer was modified in between.
1694 ;; Display a message announcing success.
1699 "Make BUFFER stop keeping undo information.
1700 No argument or nil as argument means do this for the current buffer."
1706 "Undo some previous changes.
1707 Repeat this command to undo more changes.
1708 A numeric argument serves as a repeat count.
1709 Contrary to `undo', this will not redo a previous undo."
1714 "Non-nil while performing an undo.
1718 "Undo back N undo-boundaries beyond what was already undone recently.
1719 Call `undo-start' to get ready to undo recent changes,
1720 then call `undo-more' one or more times to undo them."
1729 ;; Deep copy of a list
1731 "Make a copy of undo list LIST."
1737 elt))
1740 "Set `pending-undo-list' to the front of the undo list.
1741 The next call to `undo-more' will undo the most recently made change.
1742 If BEG and END are specified, then only undo elements
1743 that apply to text between BEG and END are used; other undo elements
1744 are ignored. If BEG and END are nil, all undo elements are used."
1750 buffer-undo-list)))
1755 "Return a list of undo elements for the region START to END.
1756 The elements come from `buffer-undo-list', but we keep only
1757 the elements inside this region, and discard those outside this region.
1758 If we find an element that crosses an edge of this region,
1759 we stop and ignore all further elements."
1762 undo-adjusted-markers
1763 some-rejected
1764 undo-elt undo-elt temp-undo-list delta)
1769 ;; This is a "was unmodified" element.
1770 ;; Keep it if we have kept everything thus far.
1777 ;; Don't put two nils together in the list
1791 ;; Loop down the earlier events adjusting their buffer
1792 ;; positions to reflect the fact that a change to the buffer
1793 ;; isn't being undone. We only need to process those element
1794 ;; types which undo-elt-in-region will return as being in
1795 ;; the region since only those types can ever get into the
1796 ;; output
1805 ;; (TEXT . POSITION)
1812 ;; (BEGIN . END)
1817 ;; (nil PROPERTY VALUE BEG . END)
1827 "Determine whether UNDO-ELT falls inside the region START ... END.
1828 If it crosses the edge, we return nil."
1833 t)
1835 nil)
1837 ;; (TEXT . POSITION)
1841 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1842 ;; See if MARKER is inside the region.
1853 ;; (nil PROPERTY VALUE BEG . END)
1858 ;; (BEGIN . END)
1863 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1864 This assumes we have already decided that UNDO-ELT
1865 is not *inside* the region START...END."
1868 ;; (nil PROPERTY VALUE BEG . END)
1873 ;; (BEGIN . END)
1877 ;; Return the first affected buffer position and the delta for an undo element
1878 ;; delta is defined as the change in subsequent buffer positions if we *did*
1879 ;; the undo.
1883 ;; (TEXT . POSITION)
1886 ;; (BEGIN . END)
1893 "If non-nil ask about discarding undo info for the current command.
1894 Normally, Emacs discards the undo info for the current command if
1895 it exceeds `undo-outer-limit'. But if you set this option
1896 non-nil, it asks in the echo area whether to discard the info.
1897 If you answer no, there is a slight risk that Emacs might crash, so
1898 only do it if you really want to undo the command.
1900 This option is mainly intended for debugging. You have to be
1901 careful if you use it for other purposes. Garbage collection is
1902 inhibited while the question is asked, meaning that Emacs might
1903 leak memory. So you should make sure that you do not wait
1904 excessively long before answering the question."
1910 "If non-nil, an extra level of size that's ok in an undo item.
1911 We don't ask the user about truncating the undo list until the
1912 current item gets bigger than this amount.
1917 ;; When the first undo batch in an undo list is longer than
1918 ;; undo-outer-limit, this function gets called to warn the user that
1919 ;; the undo info for the current command was discarded. Garbage
1920 ;; collection is inhibited around the call, so it had better not do a
1921 ;; lot of consing.
1927 ;; Don't ask the question again unless it gets even bigger.
1928 ;; This applies, in particular, if the user quits from the question.
1929 ;; Such a quit quits out of GC, but something else will call GC
1930 ;; again momentarily. It will call this function again,
1931 ;; but we don't want to ask the question again.
1938 t)
1939 nil))
1944 "The undo info was discarded because it exceeded \
1945 `undo-outer-limit'.
1947 This is normal if you executed a command that made a huge change
1948 to the buffer. In that case, to prevent similar problems in the
1949 future, set `undo-outer-limit' to a value that is large enough to
1950 cover the maximum size of normal changes you expect a single
1951 command to make, but not so large that it might exceed the
1952 maximum memory allotted to Emacs.
1954 If you did not execute any such command, the situation is
1955 probably due to a bug and you should report it.
1957 You can disable the popping up of this buffer by adding the entry
1961 t))
1962 \f
1964 "History list for some commands that read shell commands.
1966 Maximum length of the history list is determined by the value
1973 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1974 This buffer is used when `shell-command' or `shell-command-on-region'
1975 is run interactively. A value of nil means that output to stderr and
1981 "Return a list of all commands associted with the current file.
1982 This function is used to add all related commands retieved by `mailcap'
1983 to the end of the list of defaults just after the default value."
1987 minibuffer-default))
1992 commands))
1998 "Dynamically complete shell command at point."
2007 map)
2011 "Read a shell command from the minibuffer.
2012 The arguments are the same as the ones of `read-from-minibuffer',
2013 except READ and KEYMAP are missing and HIST defaults
2014 to `shell-command-history'."
2020 minibuffer-local-shell-command-map
2021 nil
2023 args)))
2026 "Execute string COMMAND in inferior shell; display output, if any.
2027 With prefix argument, insert the COMMAND's output at point.
2029 If COMMAND ends in ampersand, execute it asynchronously.
2030 The output appears in the buffer `*Async Shell Command*'.
2031 That buffer is in shell mode.
2033 Otherwise, COMMAND is executed synchronously. The output appears in
2034 the buffer `*Shell Command Output*'. If the output is short enough to
2035 display in the echo area (which is determined by the variables
2036 `resize-mini-windows' and `max-mini-window-height'), it is shown
2037 there, but it is nonetheless available in buffer `*Shell Command
2038 Output*' even though that buffer is not automatically displayed.
2040 To specify a coding system for converting non-ASCII characters
2042 before this command.
2044 Noninteractive callers can specify coding systems by binding
2045 `coding-system-for-read' and `coding-system-for-write'.
2047 The optional second argument OUTPUT-BUFFER, if non-nil,
2048 says to put the output in some other buffer.
2049 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2050 If OUTPUT-BUFFER is not a buffer and not nil,
2051 insert output in current buffer. (This cannot be done asynchronously.)
2052 In either case, the output is inserted after point (leaving mark after it).
2054 If the command terminates without error, but generates output,
2056 the output can be displayed in the echo area or in its buffer.
2057 If the output is short enough to display in the echo area
2058 \(determined by the variable `max-mini-window-height' if
2059 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
2060 the buffer containing the output is displayed.
2064 of the output.
2066 If there is no output, or if output is inserted in the current buffer,
2067 then `*Shell Command Output*' is deleted.
2069 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
2070 or buffer name to which to direct the command's standard error output.
2071 If it is nil, error output is mingled with regular output.
2072 In an interactive call, the variable `shell-command-default-error-buffer'
2073 specifies the value of ERROR-BUFFER."
2080 current-prefix-arg
2081 shell-command-default-error-buffer))
2082 ;; Look for a handler in case default-directory is a remote file name.
2090 ;; Output goes in current buffer.
2096 temporary-file-directory)))
2097 nil)))
2100 ;; We do not use -f for csh; we will not support broken use of
2101 ;; .cshrcs. Even the BSD csh manual says to use
2102 ;; "if ($?prompt) exit" before things which are not useful
2103 ;; non-interactively. Besides, if someone wants their other
2104 ;; aliases for shell commands then they can still have them.
2108 t)
2109 nil shell-command-switch command)
2116 ;; Do no formatting while reading error file,
2117 ;; because that can run a shell command, and we
2118 ;; don't want that to cause an infinite recursion.
2120 ;; Put point after the inserted errors.
2124 ;; This is like exchange-point-and-mark, but doesn't
2125 ;; activate the mark. It is cleaner to avoid activation,
2126 ;; even though the command loop would deactivate the mark
2127 ;; because we inserted text.
2131 ;; Output goes in a separate buffer.
2132 ;; Preserve the match data in case called from a program.
2135 ;; Command ending with ampersand means asynchronous.
2139 proc)
2140 ;; Remove the ampersand.
2142 ;; If will kill a process, query first.
2154 shell-command-switch command))
2158 ))
2160 output-buffer nil error-buffer)))))))
2164 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2165 MESSAGE may be either a string or a buffer.
2167 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2168 the maximum height of the echo area, as defined by `max-mini-window-height'
2169 if `resize-mini-windows' is non-nil.
2171 Returns either the string shown in the echo area, or when a pop-up
2172 buffer is used, the window used to display it.
2174 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2175 name of the buffer used to display it in the case where a pop-up buffer
2176 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2177 string and it is displayed in the echo area, it is not specified whether
2178 the contents are inserted into the buffer anyway.
2180 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2181 and only used if a buffer is displayed."
2183 ;; Trivial case where we can use the echo area
2187 ;; Trivial case where we can just remove single trailing newline
2190 ;; General case
2193 message
2202 0
2206 (<= lines
2210 max-mini-window-height))
2212 max-mini-window-height)
2216 ;; Don't use the echo area if the output buffer is
2217 ;; already dispayed in the selected frame.
2219 ;; Echo area
2225 ;; Buffer
2228 not-this-window frame))))))))
2231 ;; We have a sentinel to prevent insertion of a termination message
2232 ;; in the buffer itself.
2240 &optional output-buffer replace
2241 error-buffer display-error-buffer)
2242 "Execute string COMMAND in inferior shell with region as input.
2243 Normally display output (if any) in temp buffer `*Shell Command Output*';
2244 Prefix arg means replace the region with it. Return the exit code of
2245 COMMAND.
2247 To specify a coding system for converting non-ASCII characters
2249 before this command. By default, the input (from the current buffer)
2250 is encoded in the same coding system that will be used to save the file,
2251 `buffer-file-coding-system'. If the output is going to replace the region,
2252 then it is decoded from that same coding system.
2254 The noninteractive arguments are START, END, COMMAND,
2255 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2256 Noninteractive callers can specify coding systems by binding
2257 `coding-system-for-read' and `coding-system-for-write'.
2259 If the command generates output, the output may be displayed
2260 in the echo area or in a buffer.
2261 If the output is short enough to display in the echo area
2262 \(determined by the variable `max-mini-window-height' if
2263 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2264 it is displayed in the buffer `*Shell Command Output*'. The output
2265 is available in that buffer in both cases.
2267 If there is output and an error, a message about the error
2268 appears at the end of the output.
2270 If there is no output, or if output is inserted in the current buffer,
2271 then `*Shell Command Output*' is deleted.
2273 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2274 that says to put the output in some other buffer.
2275 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2276 If OUTPUT-BUFFER is not a buffer and not nil,
2277 insert output in the current buffer.
2278 In either case, the output is inserted after point (leaving mark after it).
2280 If REPLACE, the optional fifth argument, is non-nil, that means insert
2281 the output in place of text from START to END, putting point and mark
2282 around it.
2284 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2285 or buffer name to which to direct the command's standard error output.
2286 If it is nil, error output is mingled with regular output.
2287 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2288 were any errors. (This is always t, interactively.)
2289 In an interactive call, the variable `shell-command-default-error-buffer'
2290 specifies the value of ERROR-BUFFER."
2294 ;; Do this before calling region-beginning
2295 ;; and region-end, in case subprocess output
2296 ;; relocates them while we are in the minibuffer.
2298 ;; call-interactively recognizes region-beginning and
2299 ;; region-end specially, leaving them in the history.
2301 string
2302 current-prefix-arg
2303 current-prefix-arg
2304 shell-command-default-error-buffer
2305 t)))
2311 temporary-file-directory)))
2312 nil))
2313 exit-status)
2317 ;; Replace specified region with output from command.
2319 ;; Don't muck with mark unless REPLACE says we should.
2326 t)
2327 nil shell-command-switch command))
2328 ;; It is rude to delete a buffer which the command is not using.
2329 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2330 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2331 ;; (kill-buffer shell-buffer)))
2332 ;; Don't muck with mark unless REPLACE says we should.
2334 ;; No prefix argument: put the output in a temp buffer,
2335 ;; replacing its entire contents.
2340 ;; If the input is the same buffer as the output,
2341 ;; delete everything but the specified region,
2342 ;; then replace that region with the output.
2348 shell-file-name t
2351 t)
2352 nil shell-command-switch
2353 command)))
2354 ;; Clear the output buffer, then run the command with
2355 ;; output there.
2367 buffer)
2368 nil shell-command-switch command)))
2369 ;; Report the output.
2379 ;; There's some output, display it
2381 ;; No output; error?
2385 "some error output"
2391 output))
2394 exit-status))
2397 exit-status output))))
2398 ;; Don't kill: there might be useful info in the undo-log.
2399 ;; (kill-buffer buffer)
2400 ))))
2408 ;; Do no formatting while reading error file,
2409 ;; because that can run a shell command, and we
2410 ;; don't want that to cause an infinite recursion.
2412 ;; Put point after the inserted errors.
2417 exit-status))
2420 "Execute shell command COMMAND and return its output as a string."
2423 standard-output
2427 "Process files synchronously in a separate process.
2428 Similar to `call-process', but may invoke a file handler based on
2429 `default-directory'. The current working directory of the
2430 subprocess is `default-directory'.
2432 File names in INFILE and BUFFER are handled normally, but file
2433 names in ARGS should be relative to `default-directory', as they
2434 are passed to the process verbatim. \(This is a difference to
2435 `call-process' which does not support file handlers for INFILE
2436 and BUFFER.\)
2438 Some file handlers might not support all variants, for example
2439 they might behave as if DISPLAY was nil, regardless of the actual
2440 value passed."
2442 lc stderr-file)
2452 display args)
2458 "Start a program in a subprocess. Return the process object for it.
2460 Similar to `start-process', but may invoke a file handler based on
2461 `default-directory'. See Info node `(elisp)Magic File Names'.
2463 This handler ought to run PROGRAM, perhaps on the local host,
2464 perhaps on a remote host that corresponds to `default-directory'.
2465 In the latter case, the local part of `default-directory' becomes
2466 the working directory of the process.
2468 PROGRAM and PROGRAM-ARGS might be file names. They are not
2469 objects of file handler invocation."
2475 \f
2479 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2480 (define-key map [switch-frame] nil)
2481 (define-key map [?\C-u] 'universal-argument-more)
2482 (define-key map [?-] 'universal-argument-minus)
2483 (define-key map [?0] 'digit-argument)
2484 (define-key map [?1] 'digit-argument)
2485 (define-key map [?2] 'digit-argument)
2486 (define-key map [?3] 'digit-argument)
2487 (define-key map [?4] 'digit-argument)
2488 (define-key map [?5] 'digit-argument)
2489 (define-key map [?6] 'digit-argument)
2490 (define-key map [?7] 'digit-argument)
2491 (define-key map [?8] 'digit-argument)
2492 (define-key map [?9] 'digit-argument)
2493 (define-key map [kp-0] 'digit-argument)
2494 (define-key map [kp-1] 'digit-argument)
2495 (define-key map [kp-2] 'digit-argument)
2496 (define-key map [kp-3] 'digit-argument)
2497 (define-key map [kp-4] 'digit-argument)
2498 (define-key map [kp-5] 'digit-argument)
2499 (define-key map [kp-6] 'digit-argument)
2500 (define-key map [kp-7] 'digit-argument)
2501 (define-key map [kp-8] 'digit-argument)
2502 (define-key map [kp-9] 'digit-argument)
2503 (define-key map [kp-subtract] 'universal-argument-minus)
2504 map)
2507 (defvar universal-argument-num-events nil
2508 "Number of argument-specifying events read by `universal-argument'.
2509 `universal-argument-other-key' uses this to discard those events
2510 from (this-command-keys), and reread only the final command.")
2512 (defvar overriding-map-is-bound nil
2513 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2515 (defvar saved-overriding-map nil
2516 "The saved value of `overriding-terminal-local-map'.
2520 (defun ensure-overriding-map-is-bound ()
2521 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2522 (unless overriding-map-is-bound
2523 (setq saved-overriding-map overriding-terminal-local-map)
2524 (setq overriding-terminal-local-map universal-argument-map)
2525 (setq overriding-map-is-bound t)))
2527 (defun restore-overriding-map ()
2528 "Restore `overriding-terminal-local-map' to its saved value."
2529 (setq overriding-terminal-local-map saved-overriding-map)
2530 (setq overriding-map-is-bound nil))
2532 (defun universal-argument ()
2533 "Begin a numeric argument for the following command.
2538 multiplies the argument by 4 each time.
2540 which is different in effect from any particular numeric argument.
2542 (interactive)
2543 (setq prefix-arg (list 4))
2544 (setq universal-argument-num-events (length (this-command-keys)))
2545 (ensure-overriding-map-is-bound))
2547 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2548 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2549 (defun universal-argument-more (arg)
2550 (interactive "P")
2551 (if (consp arg)
2552 (setq prefix-arg (list (* 4 (car arg))))
2553 (if (eq arg '-)
2554 (setq prefix-arg (list -4))
2555 (setq prefix-arg arg)
2556 (restore-overriding-map)))
2557 (setq universal-argument-num-events (length (this-command-keys))))
2559 (defun negative-argument (arg)
2560 "Begin a negative numeric argument for the next command.
2562 (interactive "P")
2563 (cond ((integerp arg)
2564 (setq prefix-arg (- arg)))
2565 ((eq arg '-)
2566 (setq prefix-arg nil))
2567 (t
2568 (setq prefix-arg '-)))
2569 (setq universal-argument-num-events (length (this-command-keys)))
2570 (ensure-overriding-map-is-bound))
2572 (defun digit-argument (arg)
2573 "Part of the numeric argument for the next command.
2575 (interactive "P")
2576 (let* ((char (if (integerp last-command-char)
2577 last-command-char
2578 (get last-command-char 'ascii-character)))
2580 (cond ((integerp arg)
2581 (setq prefix-arg (+ (* arg 10)
2582 (if (< arg 0) (- digit) digit))))
2583 ((eq arg '-)
2584 ;; Treat -0 as just -, so that -01 will work.
2585 (setq prefix-arg (if (zerop digit) '- (- digit))))
2586 (t
2587 (setq prefix-arg digit))))
2588 (setq universal-argument-num-events (length (this-command-keys)))
2589 (ensure-overriding-map-is-bound))
2591 ;; For backward compatibility, minus with no modifiers is an ordinary
2592 ;; command if digits have already been entered.
2593 (defun universal-argument-minus (arg)
2594 (interactive "P")
2595 (if (integerp arg)
2596 (universal-argument-other-key arg)
2597 (negative-argument arg)))
2599 ;; Anything else terminates the argument and is left in the queue to be
2600 ;; executed as a command.
2601 (defun universal-argument-other-key (arg)
2602 (interactive "P")
2603 (setq prefix-arg arg)
2604 (let* ((key (this-command-keys))
2605 (keylist (listify-key-sequence key)))
2606 (setq unread-command-events
2607 (append (nthcdr universal-argument-num-events keylist)
2608 unread-command-events)))
2609 (reset-this-command-lengths)
2610 (restore-overriding-map))
2611 \f
2612 (defvar buffer-substring-filters nil
2613 "List of filter functions for `filter-buffer-substring'.
2614 Each function must accept a single argument, a string, and return
2615 a string. The buffer substring is passed to the first function
2616 in the list, and the return value of each function is passed to
2617 the next. The return value of the last function is used as the
2618 return value of `filter-buffer-substring'.
2620 If this variable is nil, no filtering is performed.")
2622 (defun filter-buffer-substring (beg end &optional delete noprops)
2623 "Return the buffer substring between BEG and END, after filtering.
2624 The buffer substring is passed through each of the filter
2625 functions in `buffer-substring-filters', and the value from the
2626 last filter function is returned. If `buffer-substring-filters'
2627 is nil, the buffer substring is returned unaltered.
2629 If DELETE is non-nil, the text between BEG and END is deleted
2630 from the buffer.
2632 If NOPROPS is non-nil, final string returned does not include
2633 text properties, while the string passed to the filters still
2634 includes text properties from the buffer text.
2636 Point is temporarily set to BEG before calling
2637 `buffer-substring-filters', in case the functions need to know
2638 where the text came from.
2640 This function should be used instead of `buffer-substring',
2641 `buffer-substring-no-properties', or `delete-and-extract-region'
2642 when you want to allow filtering to take place. For example,
2643 major or minor modes can use `buffer-substring-filters' to
2644 extract characters that are special to a buffer, and should not
2645 be copied into other buffers."
2646 (cond
2647 ((or delete buffer-substring-filters)
2648 (save-excursion
2649 (goto-char beg)
2650 (let ((string (if delete (delete-and-extract-region beg end)
2651 (buffer-substring beg end))))
2652 (dolist (filter buffer-substring-filters)
2653 (setq string (funcall filter string)))
2654 (if noprops
2655 (set-text-properties 0 (length string) nil string))
2656 string)))
2657 (noprops
2658 (buffer-substring-no-properties beg end))
2659 (t
2660 (buffer-substring beg end))))
2663 ;;;; Window system cut and paste hooks.
2665 (defvar interprogram-cut-function nil
2666 "Function to call to make a killed region available to other programs.
2668 Most window systems provide some sort of facility for cutting and
2669 pasting text between the windows of different programs.
2670 This variable holds a function that Emacs calls whenever text
2671 is put in the kill ring, to make the new kill available to other
2672 programs.
2674 The function takes one or two arguments.
2675 The first argument, TEXT, is a string containing
2676 the text which should be made available.
2677 The second, optional, argument PUSH, has the same meaning as the
2678 similar argument to `x-set-cut-buffer', which see.")
2680 (defvar interprogram-paste-function nil
2681 "Function to call to get text cut from other programs.
2683 Most window systems provide some sort of facility for cutting and
2684 pasting text between the windows of different programs.
2685 This variable holds a function that Emacs calls to obtain
2686 text that other programs have provided for pasting.
2688 The function should be called with no arguments. If the function
2689 returns nil, then no other program has provided such text, and the top
2690 of the Emacs kill ring should be used. If the function returns a
2691 string, then the caller of the function \(usually `current-kill')
2692 should put this string in the kill ring as the latest kill.
2694 This function may also return a list of strings if the window
2695 system supports multiple selections. The first string will be
2696 used as the pasted text, but the other will be placed in the
2697 kill ring for easy access via `yank-pop'.
2699 Note that the function should return a string only if a program other
2700 than Emacs has provided a string for pasting; if Emacs provided the
2701 most recent string, the function should return nil. If it is
2702 difficult to tell whether Emacs or some other program provided the
2703 current string, it is probably good enough to return nil if the string
2704 is equal (according to `string=') to the last text Emacs provided.")
2705 \f
2708 ;;;; The kill ring data structure.
2710 (defvar kill-ring nil
2711 "List of killed text sequences.
2712 Since the kill ring is supposed to interact nicely with cut-and-paste
2713 facilities offered by window systems, use of this variable should
2714 interact nicely with `interprogram-cut-function' and
2715 `interprogram-paste-function'. The functions `kill-new',
2716 `kill-append', and `current-kill' are supposed to implement this
2717 interaction; you may want to use them instead of manipulating the kill
2718 ring directly.")
2720 (defcustom kill-ring-max 60
2721 "*Maximum length of kill ring before oldest elements are thrown away."
2722 :type 'integer
2723 :group 'killing)
2725 (defvar kill-ring-yank-pointer nil
2726 "The tail of the kill ring whose car is the last thing yanked.")
2728 (defun kill-new (string &optional replace yank-handler)
2729 "Make STRING the latest kill in the kill ring.
2730 Set `kill-ring-yank-pointer' to point to it.
2731 If `interprogram-cut-function' is non-nil, apply it to STRING.
2732 Optional second argument REPLACE non-nil means that STRING will replace
2733 the front of the kill ring, rather than being added to the list.
2735 Optional third arguments YANK-HANDLER controls how the STRING is later
2736 inserted into a buffer; see `insert-for-yank' for details.
2737 When a yank handler is specified, STRING must be non-empty (the yank
2738 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2740 When the yank handler has a non-nil PARAM element, the original STRING
2741 argument is not used by `insert-for-yank'. However, since Lisp code
2742 may access and use elements from the kill ring directly, the STRING
2744 (if (> (length string) 0)
2745 (if yank-handler
2746 (put-text-property 0 (length string)
2747 'yank-handler yank-handler string))
2748 (if yank-handler
2749 (signal 'args-out-of-range
2750 (list string "yank-handler specified for empty string"))))
2751 (if (fboundp 'menu-bar-update-yank-menu)
2752 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2753 (if (and replace kill-ring)
2754 (setcar kill-ring string)
2755 (push string kill-ring)
2756 (if (> (length kill-ring) kill-ring-max)
2757 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2758 (setq kill-ring-yank-pointer kill-ring)
2759 (if interprogram-cut-function
2760 (funcall interprogram-cut-function string (not replace))))
2762 (defun kill-append (string before-p &optional yank-handler)
2763 "Append STRING to the end of the latest kill in the kill ring.
2764 If BEFORE-P is non-nil, prepend STRING to the kill.
2765 Optional third argument YANK-HANDLER, if non-nil, specifies the
2766 yank-handler text property to be set on the combined kill ring
2767 string. If the specified yank-handler arg differs from the
2768 yank-handler property of the latest kill string, this function
2769 adds the combined string to the kill ring as a new element,
2770 instead of replacing the last kill with it.
2771 If `interprogram-cut-function' is set, pass the resulting kill to it."
2772 (let* ((cur (car kill-ring)))
2773 (kill-new (if before-p (concat string cur) (concat cur string))
2774 (or (= (length cur) 0)
2775 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2776 yank-handler)))
2778 (defcustom yank-pop-change-selection nil
2779 "If non-nil, rotating the kill ring changes the window system selection."
2780 :type 'boolean
2781 :group 'killing
2782 :version "23.1")
2784 (defun current-kill (n &optional do-not-move)
2785 "Rotate the yanking point by N places, and then return that kill.
2786 If N is zero, `interprogram-paste-function' is set, and calling it returns a
2787 string or list of strings, then that string (or list) is added to the front
2788 of the kill ring and the string (or first string in the list) is returned as
2789 the latest kill.
2791 If N is not zero, and if `yank-pop-change-selection' is
2792 non-nil, use `interprogram-cut-function' to transfer the
2793 kill at the new yank point into the window system selection.
2795 If optional arg DO-NOT-MOVE is non-nil, then don't actually
2796 move the yanking point; just return the Nth kill forward."
2798 (let ((interprogram-paste (and (= n 0)
2799 interprogram-paste-function
2800 (funcall interprogram-paste-function))))
2801 (if interprogram-paste
2802 (progn
2803 ;; Disable the interprogram cut function when we add the new
2804 ;; text to the kill ring, so Emacs doesn't try to own the
2805 ;; selection, with identical text.
2806 (let ((interprogram-cut-function nil))
2807 (if (listp interprogram-paste)
2808 (mapc 'kill-new (nreverse interprogram-paste))
2809 (kill-new interprogram-paste)))
2810 (car kill-ring))
2811 (or kill-ring (error "Kill ring is empty"))
2812 (let ((ARGth-kill-element
2813 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2814 (length kill-ring))
2815 kill-ring)))
2816 (unless do-not-move
2817 (setq kill-ring-yank-pointer ARGth-kill-element)
2818 (when (and yank-pop-change-selection
2819 (> n 0)
2820 interprogram-cut-function)
2821 (funcall interprogram-cut-function (car ARGth-kill-element))))
2822 (car ARGth-kill-element)))))
2826 ;;;; Commands for manipulating the kill ring.
2828 (defcustom kill-read-only-ok nil
2829 "*Non-nil means don't signal an error for killing read-only text."
2830 :type 'boolean
2831 :group 'killing)
2833 (put 'text-read-only 'error-conditions
2834 '(text-read-only buffer-read-only error))
2835 (put 'text-read-only 'error-message "Text is read-only")
2837 (defun kill-region (beg end &optional yank-handler)
2839 This deletes the text from the buffer and saves it in the kill ring.
2843 If you want to append the killed region to the last killed text,
2846 If the buffer is read-only, Emacs will beep and refrain from deleting
2847 the text, but put the text in the kill ring anyway. This means that
2848 you can use the killing commands to copy text from a read-only buffer.
2850 This is the primitive for programs to kill text (as opposed to deleting it).
2851 Supply two arguments, character positions indicating the stretch of text
2852 to be killed.
2854 If the previous command was also a kill command,
2855 the text killed this time appends to the text killed last time
2856 to make one entry in the kill ring.
2858 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2859 specifies the yank-handler text property to be set on the killed
2860 text. See `insert-for-yank'."
2861 ;; Pass point first, then mark, because the order matters
2862 ;; when calling kill-append.
2863 (interactive (list (point) (mark)))
2864 (unless (and beg end)
2865 (error "The mark is not set now, so there is no region"))
2866 (condition-case nil
2867 (let ((string (filter-buffer-substring beg end t)))
2868 (when string ;STRING is nil if BEG = END
2869 ;; Add that string to the kill ring, one way or another.
2870 (if (eq last-command 'kill-region)
2871 (kill-append string (< end beg) yank-handler)
2872 (kill-new string nil yank-handler)))
2873 (when (or string (eq last-command 'kill-region))
2874 (setq this-command 'kill-region))
2875 nil)
2876 ((buffer-read-only text-read-only)
2877 ;; The code above failed because the buffer, or some of the characters
2878 ;; in the region, are read-only.
2879 ;; We should beep, in case the user just isn't aware of this.
2880 ;; However, there's no harm in putting
2881 ;; the region's text in the kill ring, anyway.
2882 (copy-region-as-kill beg end)
2883 ;; Set this-command now, so it will be set even if we get an error.
2884 (setq this-command 'kill-region)
2885 ;; This should barf, if appropriate, and give us the correct error.
2886 (if kill-read-only-ok
2887 (progn (message "Read only text copied to kill ring") nil)
2888 ;; Signal an error if the buffer is read-only.
2889 (barf-if-buffer-read-only)
2890 ;; If the buffer isn't read-only, the text is.
2891 (signal 'text-read-only (list (current-buffer)))))))
2893 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2894 ;; to get two copies of the text when the user accidentally types M-w and
2895 ;; then corrects it with the intended C-w.
2896 (defun copy-region-as-kill (beg end)
2897 "Save the region as if killed, but don't kill it.
2898 In Transient Mark mode, deactivate the mark.
2899 If `interprogram-cut-function' is non-nil, also save the text for a window
2900 system cut and paste.
2902 This command's old key binding has been given to `kill-ring-save'."
2903 (interactive "r")
2904 (if (eq last-command 'kill-region)
2905 (kill-append (filter-buffer-substring beg end) (< end beg))
2906 (kill-new (filter-buffer-substring beg end)))
2907 (setq deactivate-mark t)
2908 nil)
2910 (defun kill-ring-save (beg end)
2911 "Save the region as if killed, but don't kill it.
2912 In Transient Mark mode, deactivate the mark.
2913 If `interprogram-cut-function' is non-nil, also save the text for a window
2914 system cut and paste.
2916 If you want to append the killed line to the last killed text,
2919 This command is similar to `copy-region-as-kill', except that it gives
2920 visual feedback indicating the extent of the region being copied."
2921 (interactive "r")
2922 (copy-region-as-kill beg end)
2923 ;; This use of interactive-p is correct
2924 ;; because the code it controls just gives the user visual feedback.
2925 (if (interactive-p)
2926 (let ((other-end (if (= (point) beg) end beg))
2927 (opoint (point))
2928 ;; Inhibit quitting so we can make a quit here
2929 ;; look like a C-g typed as a command.
2930 (inhibit-quit t))
2931 (if (pos-visible-in-window-p other-end (selected-window))
2932 ;; Swap point-and-mark quickly so as to show the region that
2933 ;; was selected. Don't do it if the region is highlighted.
2934 (unless (and (region-active-p)
2935 (face-background 'region))
2936 ;; Swap point and mark.
2937 (set-marker (mark-marker) (point) (current-buffer))
2938 (goto-char other-end)
2939 (sit-for blink-matching-delay)
2940 ;; Swap back.
2941 (set-marker (mark-marker) other-end (current-buffer))
2942 (goto-char opoint)
2943 ;; If user quit, deactivate the mark
2944 ;; as C-g would as a command.
2945 (and quit-flag mark-active
2946 (deactivate-mark)))
2947 (let* ((killed-text (current-kill 0))
2948 (message-len (min (length killed-text) 40)))
2949 (if (= (point) beg)
2950 ;; Don't say "killed"; that is misleading.
2952 (substring killed-text (- message-len)))
2954 (substring killed-text 0 message-len))))))))
2956 (defun append-next-kill (&optional interactive)
2957 "Cause following command, if it kills, to append to previous kill.
2958 The argument is used for internal purposes; do not supply one."
2959 (interactive "p")
2960 ;; We don't use (interactive-p), since that breaks kbd macros.
2961 (if interactive
2962 (progn
2963 (setq this-command 'kill-region)
2964 (message "If the next command is a kill, it will append"))
2965 (setq last-command 'kill-region)))
2966 \f
2967 ;; Yanking.
2969 ;; This is actually used in subr.el but defcustom does not work there.
2970 (defcustom yank-excluded-properties
2971 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2972 yank-handler follow-link fontified)
2973 "Text properties to discard when yanking.
2974 The value should be a list of text properties to discard or t,
2975 which means to discard all text properties."
2976 :type '(choice (const :tag "All" t) (repeat symbol))
2977 :group 'killing
2978 :version "22.1")
2980 (defvar yank-window-start nil)
2981 (defvar yank-undo-function nil
2982 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2983 Function is called with two parameters, START and END corresponding to
2984 the value of the mark and point; it is guaranteed that START <= END.
2985 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2987 (defun yank-pop (&optional arg)
2988 "Replace just-yanked stretch of killed text with a different stretch.
2989 This command is allowed only immediately after a `yank' or a `yank-pop'.
2990 At such a time, the region contains a stretch of reinserted
2991 previously-killed text. `yank-pop' deletes that text and inserts in its
2992 place a different stretch of killed text.
2994 With no argument, the previous kill is inserted.
2995 With argument N, insert the Nth previous kill.
2996 If N is negative, this is a more recent kill.
2998 The sequence of kills wraps around, so that after the oldest one
2999 comes the newest one.
3001 When this command inserts killed text into the buffer, it honors
3002 `yank-excluded-properties' and `yank-handler' as described in the
3003 doc string for `insert-for-yank-1', which see."
3004 (interactive "*p")
3005 (if (not (eq last-command 'yank))
3006 (error "Previous command was not a yank"))
3007 (setq this-command 'yank)
3008 (unless arg (setq arg 1))
3009 (let ((inhibit-read-only t)
3010 (before (< (point) (mark t))))
3011 (if before
3012 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
3013 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
3014 (setq yank-undo-function nil)
3015 (set-marker (mark-marker) (point) (current-buffer))
3016 (insert-for-yank (current-kill arg))
3017 ;; Set the window start back where it was in the yank command,
3018 ;; if possible.
3019 (set-window-start (selected-window) yank-window-start t)
3020 (if before
3021 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3022 ;; It is cleaner to avoid activation, even though the command
3023 ;; loop would deactivate the mark because we inserted text.
3024 (goto-char (prog1 (mark t)
3025 (set-marker (mark-marker) (point) (current-buffer))))))
3026 nil)
3028 (defun yank (&optional arg)
3030 More precisely, reinsert the stretch of killed text most recently
3031 killed OR yanked. Put point at end, and set mark at beginning.
3032 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
3033 With argument N, reinsert the Nth most recently killed stretch of killed
3034 text.
3036 When this command inserts killed text into the buffer, it honors
3037 `yank-excluded-properties' and `yank-handler' as described in the
3038 doc string for `insert-for-yank-1', which see.
3041 (interactive "*P")
3042 (setq yank-window-start (window-start))
3043 ;; If we don't get all the way thru, make last-command indicate that
3044 ;; for the following command.
3045 (setq this-command t)
3046 (push-mark (point))
3047 (insert-for-yank (current-kill (cond
3048 ((listp arg) 0)
3049 ((eq arg '-) -2)
3050 (t (1- arg)))))
3051 (if (consp arg)
3052 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
3053 ;; It is cleaner to avoid activation, even though the command
3054 ;; loop would deactivate the mark because we inserted text.
3055 (goto-char (prog1 (mark t)
3056 (set-marker (mark-marker) (point) (current-buffer)))))
3057 ;; If we do get all the way thru, make this-command indicate that.
3058 (if (eq this-command t)
3059 (setq this-command 'yank))
3060 nil)
3062 (defun rotate-yank-pointer (arg)
3063 "Rotate the yanking point in the kill ring.
3064 With argument, rotate that many kills forward (or backward, if negative)."
3065 (interactive "p")
3066 (current-kill arg))
3067 \f
3068 ;; Some kill commands.
3070 ;; Internal subroutine of delete-char
3071 (defun kill-forward-chars (arg)
3072 (if (listp arg) (setq arg (car arg)))
3073 (if (eq arg '-) (setq arg -1))
3074 (kill-region (point) (forward-point arg)))
3076 ;; Internal subroutine of backward-delete-char
3077 (defun kill-backward-chars (arg)
3078 (if (listp arg) (setq arg (car arg)))
3079 (if (eq arg '-) (setq arg -1))
3080 (kill-region (point) (forward-point (- arg))))
3082 (defcustom backward-delete-char-untabify-method 'untabify
3083 "*The method for untabifying when deleting backward.
3084 Can be `untabify' -- turn a tab to many spaces, then delete one space;
3085 `hungry' -- delete all whitespace, both tabs and spaces;
3086 `all' -- delete all whitespace, including tabs, spaces and newlines;
3087 nil -- just delete one character."
3088 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3089 :version "20.3"
3090 :group 'killing)
3092 (defun backward-delete-char-untabify (arg &optional killp)
3093 "Delete characters backward, changing tabs into spaces.
3094 The exact behavior depends on `backward-delete-char-untabify-method'.
3095 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3096 Interactively, ARG is the prefix arg (default 1)
3097 and KILLP is t if a prefix arg was specified."
3099 (when (eq backward-delete-char-untabify-method 'untabify)
3100 (let ((count arg))
3101 (save-excursion
3102 (while (and (> count 0) (not (bobp)))
3104 (let ((col (current-column)))
3105 (forward-char -1)
3106 (setq col (- col (current-column)))
3107 (insert-char ?\s col)
3108 (delete-char 1)))
3109 (forward-char -1)
3110 (setq count (1- count))))))
3111 (delete-backward-char
3113 ((eq backward-delete-char-untabify-method 'all)
3115 (if skip
3116 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3117 (point)))))
3118 (+ arg (if (zerop wh) 0 (1- wh))))
3119 arg))
3120 killp))
3122 (defun zap-to-char (arg char)
3123 "Kill up to and including ARG'th occurrence of CHAR.
3124 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3125 Goes backward if ARG is negative; error if CHAR not found."
3127 (if (char-table-p translation-table-for-input)
3128 (setq char (or (aref translation-table-for-input char) char)))
3129 (kill-region (point) (progn
3130 (search-forward (char-to-string char) nil nil arg)
3131 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3132 (point))))
3134 ;; kill-line and its subroutines.
3136 (defcustom kill-whole-line nil
3137 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3138 :type 'boolean
3139 :group 'killing)
3141 (defun kill-line (&optional arg)
3142 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3143 With prefix argument, kill that many lines from point.
3144 Negative arguments kill lines backward.
3145 With zero argument, kills the text before point on the current line.
3148 a number counts as a prefix arg.
3150 To kill a whole line, when point is not at the beginning, type \
3153 If `kill-whole-line' is non-nil, then this command kills the whole line
3154 including its terminating newline, when used at the beginning of a line
3155 with no argument. As a consequence, you can always kill a whole line
3158 If you want to append the killed line to the last killed text,
3161 If the buffer is read-only, Emacs will beep and refrain from deleting
3162 the line, but put the line in the kill ring anyway. This means that
3163 you can use this command to copy text from a read-only buffer.
3164 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3165 even beep.)"
3166 (interactive "P")
3167 (kill-region (point)
3168 ;; It is better to move point to the other end of the kill
3169 ;; before killing. That way, in a read-only buffer, point
3170 ;; moves across the text that is copied to the kill ring.
3171 ;; The choice has no effect on undo now that undo records
3172 ;; the value of point from before the command was run.
3173 (progn
3174 (if arg
3175 (forward-visible-line (prefix-numeric-value arg))
3176 (if (eobp)
3177 (signal 'end-of-buffer nil))
3178 (let ((end
3179 (save-excursion
3180 (end-of-visible-line) (point))))
3181 (if (or (save-excursion
3182 ;; If trailing whitespace is visible,
3183 ;; don't treat it as nothing.
3184 (unless show-trailing-whitespace
3186 (= (point) end))
3187 (and kill-whole-line (bolp)))
3188 (forward-visible-line 1)
3189 (goto-char end))))
3190 (point))))
3192 (defun kill-whole-line (&optional arg)
3193 "Kill current line.
3194 With prefix arg, kill that many lines starting from the current line.
3195 If arg is negative, kill backward. Also kill the preceding newline.
3197 If arg is zero, kill current line but exclude the trailing newline."
3198 (interactive "p")
3199 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3200 (signal 'end-of-buffer nil))
3201 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3202 (signal 'beginning-of-buffer nil))
3203 (unless (eq last-command 'kill-region)
3204 (kill-new "")
3205 (setq last-command 'kill-region))
3206 (cond ((zerop arg)
3207 ;; We need to kill in two steps, because the previous command
3208 ;; could have been a kill command, in which case the text
3209 ;; before point needs to be prepended to the current kill
3210 ;; ring entry and the text after point appended. Also, we
3211 ;; need to use save-excursion to avoid copying the same text
3212 ;; twice to the kill ring in read-only buffers.
3213 (save-excursion
3214 (kill-region (point) (progn (forward-visible-line 0) (point))))
3215 (kill-region (point) (progn (end-of-visible-line) (point))))
3216 ((< arg 0)
3217 (save-excursion
3218 (kill-region (point) (progn (end-of-visible-line) (point))))
3219 (kill-region (point)
3220 (progn (forward-visible-line (1+ arg))
3221 (unless (bobp) (backward-char))
3222 (point))))
3223 (t
3224 (save-excursion
3225 (kill-region (point) (progn (forward-visible-line 0) (point))))
3226 (kill-region (point)
3227 (progn (forward-visible-line arg) (point))))))
3229 (defun forward-visible-line (arg)
3230 "Move forward by ARG lines, ignoring currently invisible newlines only.
3231 If ARG is negative, move backward -ARG lines.
3232 If ARG is zero, move to the beginning of the current line."
3233 (condition-case nil
3234 (if (> arg 0)
3235 (progn
3236 (while (> arg 0)
3237 (or (zerop (forward-line 1))
3238 (signal 'end-of-buffer nil))
3239 ;; If the newline we just skipped is invisible,
3240 ;; don't count it.
3241 (let ((prop
3242 (get-char-property (1- (point)) 'invisible)))
3243 (if (if (eq buffer-invisibility-spec t)
3244 prop
3245 (or (memq prop buffer-invisibility-spec)
3246 (assq prop buffer-invisibility-spec)))
3247 (setq arg (1+ arg))))
3248 (setq arg (1- arg)))
3249 ;; If invisible text follows, and it is a number of complete lines,
3250 ;; skip it.
3251 (let ((opoint (point)))
3252 (while (and (not (eobp))
3253 (let ((prop
3254 (get-char-property (point) 'invisible)))
3255 (if (eq buffer-invisibility-spec t)
3256 prop
3257 (or (memq prop buffer-invisibility-spec)
3258 (assq prop buffer-invisibility-spec)))))
3259 (goto-char
3260 (if (get-text-property (point) 'invisible)
3261 (or (next-single-property-change (point) 'invisible)
3262 (point-max))
3263 (next-overlay-change (point)))))
3264 (unless (bolp)
3265 (goto-char opoint))))
3266 (let ((first t))
3267 (while (or first (<= arg 0))
3268 (if first
3269 (beginning-of-line)
3270 (or (zerop (forward-line -1))
3271 (signal 'beginning-of-buffer nil)))
3272 ;; If the newline we just moved to is invisible,
3273 ;; don't count it.
3274 (unless (bobp)
3275 (let ((prop
3276 (get-char-property (1- (point)) 'invisible)))
3277 (unless (if (eq buffer-invisibility-spec t)
3278 prop
3279 (or (memq prop buffer-invisibility-spec)
3280 (assq prop buffer-invisibility-spec)))
3281 (setq arg (1+ arg)))))
3282 (setq first nil))
3283 ;; If invisible text follows, and it is a number of complete lines,
3284 ;; skip it.
3285 (let ((opoint (point)))
3286 (while (and (not (bobp))
3287 (let ((prop
3288 (get-char-property (1- (point)) 'invisible)))
3289 (if (eq buffer-invisibility-spec t)
3290 prop
3291 (or (memq prop buffer-invisibility-spec)
3292 (assq prop buffer-invisibility-spec)))))
3293 (goto-char
3294 (if (get-text-property (1- (point)) 'invisible)
3295 (or (previous-single-property-change (point) 'invisible)
3296 (point-min))
3297 (previous-overlay-change (point)))))
3298 (unless (bolp)
3299 (goto-char opoint)))))
3300 ((beginning-of-buffer end-of-buffer)
3301 nil)))
3303 (defun end-of-visible-line ()
3304 "Move to end of current visible line."
3305 (end-of-line)
3306 ;; If the following character is currently invisible,
3307 ;; skip all characters with that same `invisible' property value,
3308 ;; then find the next newline.
3309 (while (and (not (eobp))
3310 (save-excursion
3312 (let ((prop
3313 (get-char-property (point) 'invisible)))
3314 (if (eq buffer-invisibility-spec t)
3315 prop
3316 (or (memq prop buffer-invisibility-spec)
3317 (assq prop buffer-invisibility-spec))))))
3319 (if (get-text-property (point) 'invisible)
3320 (goto-char (next-single-property-change (point) 'invisible))
3321 (goto-char (next-overlay-change (point))))
3322 (end-of-line)))
3323 \f
3324 (defun insert-buffer (buffer)
3325 "Insert after point the contents of BUFFER.
3326 Puts mark after the inserted text.
3327 BUFFER may be a buffer or a buffer name.
3329 This function is meant for the user to run interactively.
3330 Don't call it from programs: use `insert-buffer-substring' instead!"
3331 (interactive
3332 (list
3333 (progn
3334 (barf-if-buffer-read-only)
3335 (read-buffer "Insert buffer: "
3336 (if (eq (selected-window) (next-window (selected-window)))
3337 (other-buffer (current-buffer))
3338 (window-buffer (next-window (selected-window))))
3339 t))))
3340 (push-mark
3341 (save-excursion
3342 (insert-buffer-substring (get-buffer buffer))
3343 (point)))
3344 nil)
3346 (defun append-to-buffer (buffer start end)
3347 "Append to specified buffer the text of the region.
3348 It is inserted into that buffer before its point.
3350 When calling from a program, give three arguments:
3351 BUFFER (or buffer name), START and END.
3352 START and END specify the portion of the current buffer to be copied."
3353 (interactive
3354 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3355 (region-beginning) (region-end)))
3356 (let ((oldbuf (current-buffer)))
3357 (save-excursion
3358 (let* ((append-to (get-buffer-create buffer))
3359 (windows (get-buffer-window-list append-to t t))
3360 point)
3361 (set-buffer append-to)
3362 (setq point (point))
3363 (barf-if-buffer-read-only)
3364 (insert-buffer-substring oldbuf start end)
3365 (dolist (window windows)
3366 (when (= (window-point window) point)
3367 (set-window-point window (point))))))))
3369 (defun prepend-to-buffer (buffer start end)
3370 "Prepend to specified buffer the text of the region.
3371 It is inserted into that buffer after its point.
3373 When calling from a program, give three arguments:
3374 BUFFER (or buffer name), START and END.
3375 START and END specify the portion of the current buffer to be copied."
3377 (let ((oldbuf (current-buffer)))
3378 (save-excursion
3379 (set-buffer (get-buffer-create buffer))
3380 (barf-if-buffer-read-only)
3381 (save-excursion
3382 (insert-buffer-substring oldbuf start end)))))
3384 (defun copy-to-buffer (buffer start end)
3385 "Copy to specified buffer the text of the region.
3386 It is inserted into that buffer, replacing existing text there.
3388 When calling from a program, give three arguments:
3389 BUFFER (or buffer name), START and END.
3390 START and END specify the portion of the current buffer to be copied."
3392 (let ((oldbuf (current-buffer)))
3393 (with-current-buffer (get-buffer-create buffer)
3394 (barf-if-buffer-read-only)
3395 (erase-buffer)
3396 (save-excursion
3397 (insert-buffer-substring oldbuf start end)))))
3398 \f
3399 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3400 (put 'mark-inactive 'error-message "The mark is not active now")
3402 (defvar activate-mark-hook nil
3403 "Hook run when the mark becomes active.
3404 It is also run at the end of a command, if the mark is active and
3405 it is possible that the region may have changed.")
3407 (defvar deactivate-mark-hook nil
3408 "Hook run when the mark becomes inactive.")
3410 (defun mark (&optional force)
3411 "Return this buffer's mark value as integer, or nil if never set.
3413 In Transient Mark mode, this function signals an error if
3414 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3415 or the argument FORCE is non-nil, it disregards whether the mark
3416 is active, and returns an integer or nil in the usual way.
3418 If you are using this in an editing command, you are most likely making
3419 a mistake; see the documentation of `set-mark'."
3420 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3421 (marker-position (mark-marker))
3422 (signal 'mark-inactive nil)))
3424 ;; Many places set mark-active directly, and several of them failed to also
3425 ;; run deactivate-mark-hook. This shorthand should simplify.
3426 (defsubst deactivate-mark ()
3427 "Deactivate the mark by setting `mark-active' to nil.
3428 \(That makes a difference only in Transient Mark mode.)
3429 Also runs the hook `deactivate-mark-hook'."
3430 (when transient-mark-mode
3431 (if (or (eq transient-mark-mode 'lambda)
3432 (and (eq (car-safe transient-mark-mode) 'only)
3433 (null (cdr transient-mark-mode))))
3434 (setq transient-mark-mode nil)
3435 (if (eq (car-safe transient-mark-mode) 'only)
3436 (setq transient-mark-mode (cdr transient-mark-mode)))
3437 (setq mark-active nil)
3438 (run-hooks 'deactivate-mark-hook))))
3440 (defun activate-mark ()
3441 "Activate the mark."
3442 (when (mark t)
3443 (setq mark-active t)
3444 (unless transient-mark-mode
3445 (setq transient-mark-mode 'lambda))))
3447 (defcustom select-active-regions nil
3448 "If non-nil, an active region automatically becomes the window selection."
3449 :type 'boolean
3450 :group 'killing
3451 :version "23.1")
3453 (defun set-mark (pos)
3454 "Set this buffer's mark to POS. Don't use this function!
3455 That is to say, don't use this function unless you want
3456 the user to see that the mark has moved, and you want the previous
3457 mark position to be lost.
3459 Normally, when a new mark is set, the old one should go on the stack.
3460 This is why most applications should use `push-mark', not `set-mark'.
3462 Novice Emacs Lisp programmers often try to use the mark for the wrong
3463 purposes. The mark saves a location for the user's convenience.
3464 Most editing commands should not alter the mark.
3465 To remember a location for internal use in the Lisp program,
3466 store it in a Lisp variable. Example:
3468 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3470 (if pos
3471 (progn
3472 (setq mark-active t)
3473 (run-hooks 'activate-mark-hook)
3474 (and select-active-regions
3475 (x-set-selection
3476 nil (buffer-substring (region-beginning) (region-end))))
3477 (set-marker (mark-marker) pos (current-buffer)))
3478 ;; Normally we never clear mark-active except in Transient Mark mode.
3479 ;; But when we actually clear out the mark value too,
3480 ;; we must clear mark-active in any mode.
3481 (setq mark-active nil)
3482 (run-hooks 'deactivate-mark-hook)
3483 (set-marker (mark-marker) nil)))
3485 (defcustom use-empty-active-region nil
3486 "If non-nil, an active region takes control even if empty.
3487 This applies to certain commands which, in Transient Mark mode,
3488 apply to the active region if there is one. If the setting is t,
3489 these commands apply to an empty active region if there is one.
3490 If the setting is nil, these commands treat an empty active
3491 region as if it were not active."
3492 :type 'boolean
3493 :version "23.1"
3494 :group 'editing-basics)
3496 (defun use-region-p ()
3497 "Return t if certain commands should apply to the region.
3498 Certain commands normally apply to text near point,
3499 but in Transient Mark mode when the mark is active they apply
3500 to the region instead. Such commands should use this subroutine to
3501 test whether to do that.
3503 This function also obeys `use-empty-active-region'."
3504 (and (region-active-p)
3505 (or use-empty-active-region (> (region-end) (region-beginning)))))
3507 (defun region-active-p ()
3508 "Return t if Transient Mark mode is enabled and the mark is active.
3509 This is NOT the best function to use to test whether a command should
3510 operate on the region instead of the usual behavior -- for that,
3511 use `use-region-p'."
3512 (and transient-mark-mode mark-active))
3514 (defvar mark-ring nil
3515 "The list of former marks of the current buffer, most recent first.")
3516 (make-variable-buffer-local 'mark-ring)
3517 (put 'mark-ring 'permanent-local t)
3519 (defcustom mark-ring-max 16
3520 "*Maximum size of mark ring. Start discarding off end if gets this big."
3521 :type 'integer
3522 :group 'editing-basics)
3524 (defvar global-mark-ring nil
3525 "The list of saved global marks, most recent first.")
3527 (defcustom global-mark-ring-max 16
3528 "*Maximum size of global mark ring. \
3529 Start discarding off end if gets this big."
3530 :type 'integer
3531 :group 'editing-basics)
3533 (defun pop-to-mark-command ()
3534 "Jump to mark, and pop a new position for mark off the ring
3535 \(does not affect global mark ring\)."
3536 (interactive)
3537 (if (null (mark t))
3538 (error "No mark set in this buffer")
3539 (if (= (point) (mark t))
3540 (message "Mark popped"))
3541 (goto-char (mark t))
3542 (pop-mark)))
3544 (defun push-mark-command (arg &optional nomsg)
3545 "Set mark at where point is.
3546 If no prefix arg and mark is already set there, just activate it.
3547 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3548 (interactive "P")
3549 (let ((mark (marker-position (mark-marker))))
3550 (if (or arg (null mark) (/= mark (point)))
3551 (push-mark nil nomsg t)
3552 (setq mark-active t)
3553 (run-hooks 'activate-mark-hook)
3554 (unless nomsg
3555 (message "Mark activated")))))
3557 (defcustom set-mark-command-repeat-pop nil
3560 will pop the mark twice, and
3562 will pop the mark three times.
3566 :type 'boolean
3567 :group 'editing-basics)
3569 (defun set-mark-command (arg)
3570 "Set the mark where point is, or jump to the mark.
3571 Setting the mark also alters the region, which is the text
3572 between point and mark; this is the closest equivalent in
3575 With no prefix argument, set the mark at point, and push the
3576 old mark position on local mark ring. Also push the old mark on
3577 global mark ring, if the previous mark was set in another buffer.
3579 When Transient Mark Mode is off, immediately repeating this
3580 command activates `transient-mark-mode' temporarily.
3583 jump to the mark, and set the mark from
3584 position popped off the local mark ring \(this does not affect the global
3586 mark ring \(see `pop-global-mark'\).
3588 If `set-mark-command-repeat-pop' is non-nil, repeating
3590 off the local (or global) mark ring and jumps there.
3593 argument, unconditionally set mark where point is, even if
3594 `set-mark-command-repeat-pop' is non-nil.
3596 Novice Emacs Lisp programmers often try to use the mark for the wrong
3597 purposes. See the documentation of `set-mark' for more information."
3598 (interactive "P")
3599 (cond ((eq transient-mark-mode 'lambda)
3600 (setq transient-mark-mode nil))
3601 ((eq (car-safe transient-mark-mode) 'only)
3602 (deactivate-mark)))
3603 (cond
3604 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3605 (push-mark-command nil))
3606 ((not (eq this-command 'set-mark-command))
3607 (if arg
3608 (pop-to-mark-command)
3609 (push-mark-command t)))
3610 ((and set-mark-command-repeat-pop
3611 (eq last-command 'pop-to-mark-command))
3612 (setq this-command 'pop-to-mark-command)
3613 (pop-to-mark-command))
3614 ((and set-mark-command-repeat-pop
3615 (eq last-command 'pop-global-mark)
3616 (not arg))
3617 (setq this-command 'pop-global-mark)
3618 (pop-global-mark))
3619 (arg
3620 (setq this-command 'pop-to-mark-command)
3621 (pop-to-mark-command))
3622 ((eq last-command 'set-mark-command)
3623 (if (region-active-p)
3624 (progn
3625 (deactivate-mark)
3626 (message "Mark deactivated"))
3627 (activate-mark)
3628 (message "Mark activated")))
3629 (t
3630 (push-mark-command nil))))
3632 (defun push-mark (&optional location nomsg activate)
3633 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3634 If the last global mark pushed was not in the current buffer,
3635 also push LOCATION on the global mark ring.
3636 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3638 Novice Emacs Lisp programmers often try to use the mark for the wrong
3639 purposes. See the documentation of `set-mark' for more information.
3641 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3642 (unless (null (mark t))
3643 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3644 (when (> (length mark-ring) mark-ring-max)
3645 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3646 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3647 (set-marker (mark-marker) (or location (point)) (current-buffer))
3648 ;; Now push the mark on the global mark ring.
3649 (if (and global-mark-ring
3650 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3651 ;; The last global mark pushed was in this same buffer.
3652 ;; Don't push another one.
3653 nil
3654 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3655 (when (> (length global-mark-ring) global-mark-ring-max)
3656 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3657 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3658 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3659 (message "Mark set"))
3660 (if (or activate (not transient-mark-mode))
3661 (set-mark (mark t)))
3662 nil)
3664 (defun pop-mark ()
3665 "Pop off mark ring into the buffer's actual mark.
3666 Does not set point. Does nothing if mark ring is empty."
3667 (when mark-ring
3668 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3669 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3670 (move-marker (car mark-ring) nil)
3671 (if (null (mark t)) (ding))
3672 (setq mark-ring (cdr mark-ring)))
3673 (deactivate-mark))
3675 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3676 (defun exchange-point-and-mark (&optional arg)
3677 "Put the mark where point is now, and point where the mark is now.
3678 This command works even when the mark is not active,
3679 and it reactivates the mark.
3681 If Transient Mark mode is on, a prefix arg deactivates the mark
3682 if it is active, and otherwise avoids reactivating it. If
3683 Transient Mark mode is off, a prefix arg enables Transient Mark
3684 mode temporarily."
3685 (interactive "P")
3686 (let ((omark (mark t))
3687 (temp-highlight (eq (car-safe transient-mark-mode) 'only)))
3688 (if (null omark)
3689 (error "No mark set in this buffer"))
3690 (deactivate-mark)
3691 (set-mark (point))
3692 (goto-char omark)
3693 (cond (temp-highlight
3694 (setq transient-mark-mode (cons 'only transient-mark-mode)))
3695 ((or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3696 (not (or arg (region-active-p))))
3697 (deactivate-mark))
3698 (t (activate-mark)))
3699 nil))
3701 (defun handle-shift-selection (&optional deactivate)
3702 "Check for shift translation, and operate on the mark accordingly.
3703 This is called whenever a command with a `^' character in its
3704 `interactive' spec is invoked while `shift-select-mode' is
3705 non-nil.
3707 If the command was invoked through shift-translation, set the
3708 mark and activate the region temporarily, unless it was already
3709 set in this way. If the command was invoked without
3710 shift-translation and a region is temporarily active, deactivate
3711 the mark.
3713 With optional arg DEACTIVATE, only perform region deactivation."
3714 (cond ((and this-command-keys-shift-translated
3715 (null deactivate))
3716 (unless (and mark-active
3717 (eq (car-safe transient-mark-mode) 'only))
3718 (setq transient-mark-mode
3719 (cons 'only
3720 (unless (eq transient-mark-mode 'lambda)
3721 transient-mark-mode)))
3722 (push-mark nil nil t)))
3723 ((eq (car-safe transient-mark-mode) 'only)
3724 (setq transient-mark-mode (cdr transient-mark-mode))
3725 (deactivate-mark))))
3727 (define-minor-mode transient-mark-mode
3728 "Toggle Transient Mark mode.
3729 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3731 In Transient Mark mode, when the mark is active, the region is highlighted.
3733 So do certain other operations that set the mark
3734 but whose main purpose is something else--for example,
3740 Many commands change their behavior when Transient Mark mode is in effect
3741 and the mark is active, by acting on the region instead of their usual
3742 default part of the buffer's text. Examples of such commands include
3747 commands which are sensitive to the Transient Mark mode."
3748 :global t
3749 :init-value (not noninteractive)
3750 :group 'editing-basics)
3752 ;; The variable transient-mark-mode is ugly: it can take on special
3753 ;; values. Document these here.
3754 (defvar transient-mark-mode t
3755 "*Non-nil if Transient Mark mode is enabled.
3756 See the command `transient-mark-mode' for a description of this minor mode.
3758 Non-nil also enables highlighting of the region whenever the mark is active.
3759 The variable `highlight-nonselected-windows' controls whether to highlight
3760 all windows or just the selected window.
3762 If the value is `lambda', that enables Transient Mark mode
3763 temporarily. After any subsequent action that would normally
3764 deactivate the mark (such as buffer modification), Transient Mark mode
3765 is turned off.
3767 If the value is (only . OLDVAL), that enables Transient Mark mode
3768 temporarily. After any subsequent point motion command that is not
3769 shift-translated, or any other action that would normally deactivate
3770 the mark (such as buffer modification), the value of
3771 `transient-mark-mode' is set to OLDVAL.")
3773 (defvar widen-automatically t
3774 "Non-nil means it is ok for commands to call `widen' when they want to.
3775 Some commands will do this in order to go to positions outside
3776 the current accessible part of the buffer.
3778 If `widen-automatically' is nil, these commands will do something else
3779 as a fallback, and won't change the buffer bounds.")
3781 (defun pop-global-mark ()
3782 "Pop off global mark ring and jump to the top location."
3783 (interactive)
3784 ;; Pop entries which refer to non-existent buffers.
3785 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3786 (setq global-mark-ring (cdr global-mark-ring)))
3787 (or global-mark-ring
3788 (error "No global mark set"))
3789 (let* ((marker (car global-mark-ring))
3790 (buffer (marker-buffer marker))
3791 (position (marker-position marker)))
3792 (setq global-mark-ring (nconc (cdr global-mark-ring)
3793 (list (car global-mark-ring))))
3794 (set-buffer buffer)
3795 (or (and (>= position (point-min))
3796 (<= position (point-max)))
3797 (if widen-automatically
3798 (widen)
3799 (error "Global mark position is outside accessible part of buffer")))
3800 (goto-char position)
3801 (switch-to-buffer buffer)))
3802 \f
3803 (defcustom next-line-add-newlines nil
3804 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3805 :type 'boolean
3806 :version "21.1"
3807 :group 'editing-basics)
3809 (defun next-line (&optional arg try-vscroll)
3810 "Move cursor vertically down ARG lines.
3811 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3812 If there is no character in the target line exactly under the current column,
3813 the cursor is positioned after the character in that line which spans this
3814 column, or at the end of the line if it is not long enough.
3815 If there is no line in the buffer after this one, behavior depends on the
3816 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3817 to create a line, and moves the cursor to that line. Otherwise it moves the
3818 cursor to the end of the buffer.
3820 If the variable `line-move-visual' is non-nil, this command moves
3821 by display lines. Otherwise, it moves by buffer lines, without
3822 taking variable-width characters or continued lines into account.
3825 a semipermanent goal column for this command.
3826 Then instead of trying to move exactly vertically (or as close as possible),
3827 this command moves to the specified goal column (or as close as possible).
3828 The goal column is stored in the variable `goal-column', which is nil
3829 when there is no goal column.
3831 If you are thinking of using this in a Lisp program, consider
3832 using `forward-line' instead. It is usually easier to use
3833 and more reliable (no dependence on goal column, etc.)."
3835 (or arg (setq arg 1))
3836 (if (and next-line-add-newlines (= arg 1))
3837 (if (save-excursion (end-of-line) (eobp))
3838 ;; When adding a newline, don't expand an abbrev.
3839 (let ((abbrev-mode nil))
3840 (end-of-line)
3842 (line-move arg nil nil try-vscroll))
3843 (if (interactive-p)
3844 (condition-case nil
3845 (line-move arg nil nil try-vscroll)
3846 ((beginning-of-buffer end-of-buffer) (ding)))
3847 (line-move arg nil nil try-vscroll)))
3848 nil)
3850 (defun previous-line (&optional arg try-vscroll)
3851 "Move cursor vertically up ARG lines.
3852 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3853 If there is no character in the target line exactly over the current column,
3854 the cursor is positioned after the character in that line which spans this
3855 column, or at the end of the line if it is not long enough.
3857 If the variable `line-move-visual' is non-nil, this command moves
3858 by display lines. Otherwise, it moves by buffer lines, without
3859 taking variable-width characters or continued lines into account.
3862 a semipermanent goal column for this command.
3863 Then instead of trying to move exactly vertically (or as close as possible),
3864 this command moves to the specified goal column (or as close as possible).
3865 The goal column is stored in the variable `goal-column', which is nil
3866 when there is no goal column.
3868 If you are thinking of using this in a Lisp program, consider using
3869 `forward-line' with a negative argument instead. It is usually easier
3870 to use and more reliable (no dependence on goal column, etc.)."
3872 (or arg (setq arg 1))
3873 (if (interactive-p)
3874 (condition-case nil
3875 (line-move (- arg) nil nil try-vscroll)
3876 ((beginning-of-buffer end-of-buffer) (ding)))
3877 (line-move (- arg) nil nil try-vscroll))
3878 nil)
3880 (defcustom track-eol nil
3881 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3882 This means moving to the end of each line moved onto.
3883 The beginning of a blank line does not count as the end of a line.
3884 This has no effect when `line-move-visual' is non-nil."
3885 :type 'boolean
3886 :group 'editing-basics)
3888 (defcustom goal-column nil
3890 :type '(choice integer
3891 (const :tag "None" nil))
3892 :group 'editing-basics)
3893 (make-variable-buffer-local 'goal-column)
3895 (defvar temporary-goal-column 0
3896 "Current goal column for vertical motion.
3897 It is the column where point was at the start of the current run
3898 of vertical motion commands. It is a floating point number when
3899 moving by visual lines via `line-move-visual'; this is the
3900 x-position, in pixels, divided by the default column width. When
3901 the `track-eol' feature is doing its job, the value is
3902 `most-positive-fixnum'.")
3904 (defcustom line-move-ignore-invisible t
3906 Outline mode sets this."
3907 :type 'boolean
3908 :group 'editing-basics)
3910 (defcustom line-move-visual t
3911 "When non-nil, `line-move' moves point by visual lines.
3912 This movement is based on where the cursor is displayed on the
3913 screen, instead of relying on buffer contents alone. It takes
3914 into account variable-width characters and line continuation."
3915 :type 'boolean
3916 :group 'editing-basics)
3918 ;; Returns non-nil if partial move was done.
3919 (defun line-move-partial (arg noerror to-end)
3920 (if (< arg 0)
3921 ;; Move backward (up).
3922 ;; If already vscrolled, reduce vscroll
3923 (let ((vs (window-vscroll nil t)))
3924 (when (> vs (frame-char-height))
3925 (set-window-vscroll nil (- vs (frame-char-height)) t)))
3927 ;; Move forward (down).
3928 (let* ((lh (window-line-height -1))
3929 (vpos (nth 1 lh))
3930 (ypos (nth 2 lh))
3931 (rbot (nth 3 lh))
3932 py vs)
3933 (when (or (null lh)
3934 (>= rbot (frame-char-height))
3935 (<= ypos (- (frame-char-height))))
3936 (unless lh
3937 (let ((wend (pos-visible-in-window-p t nil t)))
3938 (setq rbot (nth 3 wend)
3939 vpos (nth 5 wend))))
3940 (cond
3941 ;; If last line of window is fully visible, move forward.
3942 ((or (null rbot) (= rbot 0))
3943 nil)
3944 ;; If cursor is not in the bottom scroll margin, move forward.
3945 ((and (> vpos 0)
3946 (< (setq py
3947 (or (nth 1 (window-line-height))
3948 (let ((ppos (posn-at-point)))
3949 (cdr (or (posn-actual-col-row ppos)
3950 (posn-col-row ppos))))))
3951 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
3952 nil)
3953 ;; When already vscrolled, we vscroll some more if we can,
3954 ;; or clear vscroll and move forward at end of tall image.
3955 ((> (setq vs (window-vscroll nil t)) 0)
3956 (when (> rbot 0)
3957 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
3958 ;; If cursor just entered the bottom scroll margin, move forward,
3959 ;; but also vscroll one line so redisplay wont recenter.
3960 ((and (> vpos 0)
3961 (= py (min (- (window-text-height) scroll-margin 1)
3962 (1- vpos))))
3963 (set-window-vscroll nil (frame-char-height) t)
3964 (line-move-1 arg noerror to-end)
3965 t)
3966 ;; If there are lines above the last line, scroll-up one line.
3967 ((> vpos 0)
3968 (scroll-up 1)
3969 t)
3970 ;; Finally, start vscroll.
3971 (t
3972 (set-window-vscroll nil (frame-char-height) t)))))))
3975 ;; This is like line-move-1 except that it also performs
3976 ;; vertical scrolling of tall images if appropriate.
3977 ;; That is not really a clean thing to do, since it mixes
3978 ;; scrolling with cursor motion. But so far we don't have
3979 ;; a cleaner solution to the problem of making C-n do something
3980 ;; useful given a tall image.
3981 (defun line-move (arg &optional noerror to-end try-vscroll)
3982 (unless (and auto-window-vscroll try-vscroll
3983 ;; Only vscroll for single line moves
3984 (= (abs arg) 1)
3985 ;; But don't vscroll in a keyboard macro.
3986 (not defining-kbd-macro)
3987 (not executing-kbd-macro)
3988 (line-move-partial arg noerror to-end))
3989 (set-window-vscroll nil 0 t)
3990 (if line-move-visual
3991 (line-move-visual arg noerror)
3992 (line-move-1 arg noerror to-end))))
3994 ;; Display-based alternative to line-move-1.
3995 ;; Arg says how many lines to move. The value is t if we can move the
3996 ;; specified number of lines.
3997 (defun line-move-visual (arg &optional noerror)
3998 (unless (and (floatp temporary-goal-column)
3999 (or (memq last-command '(next-line previous-line))
4000 ;; In case we're called from some other command.
4001 (eq last-command this-command)))
4002 (let ((x (car (nth 2 (posn-at-point)))))
4003 (when x
4004 (setq temporary-goal-column (/ (float x) (frame-char-width))))))
4005 (or (= (vertical-motion
4006 (cons (or goal-column (truncate temporary-goal-column)) arg))
4007 arg)
4008 (unless noerror
4009 (signal (if (< arg 0)
4010 'beginning-of-buffer
4011 'end-of-buffer)
4012 nil))))
4014 ;; This is the guts of next-line and previous-line.
4015 ;; Arg says how many lines to move.
4016 ;; The value is t if we can move the specified number of lines.
4017 (defun line-move-1 (arg &optional noerror to-end)
4018 ;; Don't run any point-motion hooks, and disregard intangibility,
4019 ;; for intermediate positions.
4020 (let ((inhibit-point-motion-hooks t)
4021 (opoint (point))
4022 (orig-arg arg))
4023 (if (floatp temporary-goal-column)
4024 (setq temporary-goal-column (truncate temporary-goal-column)))
4025 (unwind-protect
4026 (progn
4027 (if (not (memq last-command '(next-line previous-line)))
4028 (setq temporary-goal-column
4029 (if (and track-eol (eolp)
4030 ;; Don't count beg of empty line as end of line
4031 ;; unless we just did explicit end-of-line.
4032 (or (not (bolp)) (eq last-command 'move-end-of-line)))
4033 most-positive-fixnum
4034 (current-column))))
4036 (if (not (or (integerp selective-display)
4037 line-move-ignore-invisible))
4038 ;; Use just newline characters.
4039 ;; Set ARG to 0 if we move as many lines as requested.
4040 (or (if (> arg 0)
4041 (progn (if (> arg 1) (forward-line (1- arg)))
4042 ;; This way of moving forward ARG lines
4043 ;; verifies that we have a newline after the last one.
4044 ;; It doesn't get confused by intangible text.
4045 (end-of-line)
4046 (if (zerop (forward-line 1))
4047 (setq arg 0)))
4048 (and (zerop (forward-line arg))
4049 (bolp)
4050 (setq arg 0)))
4051 (unless noerror
4052 (signal (if (< arg 0)
4053 'beginning-of-buffer
4054 'end-of-buffer)
4055 nil)))
4056 ;; Move by arg lines, but ignore invisible ones.
4057 (let (done)
4058 (while (and (> arg 0) (not done))
4059 ;; If the following character is currently invisible,
4060 ;; skip all characters with that same `invisible' property value.
4061 (while (and (not (eobp)) (invisible-p (point)))
4062 (goto-char (next-char-property-change (point))))
4063 ;; Move a line.
4064 ;; We don't use `end-of-line', since we want to escape
4065 ;; from field boundaries ocurring exactly at point.
4066 (goto-char (constrain-to-field
4067 (let ((inhibit-field-text-motion t))
4068 (line-end-position))
4069 (point) t t
4070 'inhibit-line-move-field-capture))
4071 ;; If there's no invisibility here, move over the newline.
4072 (cond
4073 ((eobp)
4074 (if (not noerror)
4075 (signal 'end-of-buffer nil)
4076 (setq done t)))
4077 ((and (> arg 1) ;; Use vertical-motion for last move
4078 (not (integerp selective-display))
4079 (not (invisible-p (point))))
4080 ;; We avoid vertical-motion when possible
4081 ;; because that has to fontify.
4082 (forward-line 1))
4083 ;; Otherwise move a more sophisticated way.
4084 ((zerop (vertical-motion 1))
4085 (if (not noerror)
4086 (signal 'end-of-buffer nil)
4087 (setq done t))))
4088 (unless done
4089 (setq arg (1- arg))))
4090 ;; The logic of this is the same as the loop above,
4091 ;; it just goes in the other direction.
4092 (while (and (< arg 0) (not done))
4093 ;; For completely consistency with the forward-motion
4094 ;; case, we should call beginning-of-line here.
4095 ;; However, if point is inside a field and on a
4096 ;; continued line, the call to (vertical-motion -1)
4097 ;; below won't move us back far enough; then we return
4098 ;; to the same column in line-move-finish, and point
4099 ;; gets stuck -- cyd
4100 (forward-line 0)
4101 (cond
4102 ((bobp)
4103 (if (not noerror)
4104 (signal 'beginning-of-buffer nil)
4105 (setq done t)))
4106 ((and (< arg -1) ;; Use vertical-motion for last move
4107 (not (integerp selective-display))
4108 (not (invisible-p (1- (point)))))
4109 (forward-line -1))
4110 ((zerop (vertical-motion -1))
4111 (if (not noerror)
4112 (signal 'beginning-of-buffer nil)
4113 (setq done t))))
4114 (unless done
4115 (setq arg (1+ arg))
4116 (while (and ;; Don't move over previous invis lines
4117 ;; if our target is the middle of this line.
4118 (or (zerop (or goal-column temporary-goal-column))
4119 (< arg 0))
4120 (not (bobp)) (invisible-p (1- (point))))
4121 (goto-char (previous-char-property-change (point))))))))
4122 ;; This is the value the function returns.
4123 (= arg 0))
4125 (cond ((> arg 0)
4126 ;; If we did not move down as far as desired, at least go
4127 ;; to end of line. Be sure to call point-entered and
4128 ;; point-left-hooks.
4129 (let* ((npoint (prog1 (line-end-position)
4130 (goto-char opoint)))
4131 (inhibit-point-motion-hooks nil))
4132 (goto-char npoint)))
4133 ((< arg 0)
4134 ;; If we did not move up as far as desired,
4135 ;; at least go to beginning of line.
4136 (let* ((npoint (prog1 (line-beginning-position)
4137 (goto-char opoint)))
4138 (inhibit-point-motion-hooks nil))
4139 (goto-char npoint)))
4140 (t
4141 (line-move-finish (or goal-column temporary-goal-column)
4142 opoint (> orig-arg 0)))))))
4144 (defun line-move-finish (column opoint forward)
4145 (let ((repeat t))
4146 (while repeat
4147 ;; Set REPEAT to t to repeat the whole thing.
4148 (setq repeat nil)
4150 (let (new
4151 (old (point))
4152 (line-beg (save-excursion (beginning-of-line) (point)))
4153 (line-end
4154 ;; Compute the end of the line
4155 ;; ignoring effectively invisible newlines.
4156 (save-excursion
4157 ;; Like end-of-line but ignores fields.
4159 (while (and (not (eobp)) (invisible-p (point)))
4160 (goto-char (next-char-property-change (point)))
4162 (point))))
4164 ;; Move to the desired column.
4165 (line-move-to-column column)
4167 ;; Corner case: suppose we start out in a field boundary in
4168 ;; the middle of a continued line. When we get to
4169 ;; line-move-finish, point is at the start of a new *screen*
4170 ;; line but the same text line; then line-move-to-column would
4171 ;; move us backwards. Test using C-n with point on the "x" in
4172 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
4173 (and forward
4174 (< (point) old)
4175 (goto-char old))
4177 (setq new (point))
4179 ;; Process intangibility within a line.
4180 ;; With inhibit-point-motion-hooks bound to nil, a call to
4181 ;; goto-char moves point past intangible text.
4183 ;; However, inhibit-point-motion-hooks controls both the
4184 ;; intangibility and the point-entered/point-left hooks. The
4185 ;; following hack avoids calling the point-* hooks
4186 ;; unnecessarily. Note that we move *forward* past intangible
4187 ;; text when the initial and final points are the same.
4188 (goto-char new)
4189 (let ((inhibit-point-motion-hooks nil))
4190 (goto-char new)
4192 ;; If intangibility moves us to a different (later) place
4193 ;; in the same line, use that as the destination.
4194 (if (<= (point) line-end)
4195 (setq new (point))
4196 ;; If that position is "too late",
4197 ;; try the previous allowable position.
4198 ;; See if it is ok.
4199 (backward-char)
4200 (if (if forward
4201 ;; If going forward, don't accept the previous
4202 ;; allowable position if it is before the target line.
4203 (< line-beg (point))
4204 ;; If going backward, don't accept the previous
4205 ;; allowable position if it is still after the target line.
4206 (<= (point) line-end))
4207 (setq new (point))
4208 ;; As a last resort, use the end of the line.
4209 (setq new line-end))))
4211 ;; Now move to the updated destination, processing fields
4212 ;; as well as intangibility.
4213 (goto-char opoint)
4214 (let ((inhibit-point-motion-hooks nil))
4215 (goto-char
4216 ;; Ignore field boundaries if the initial and final
4217 ;; positions have the same `field' property, even if the
4218 ;; fields are non-contiguous. This seems to be "nicer"
4219 ;; behavior in many situations.
4220 (if (eq (get-char-property new 'field)
4221 (get-char-property opoint 'field))
4222 new
4223 (constrain-to-field new opoint t t
4224 'inhibit-line-move-field-capture))))
4226 ;; If all this moved us to a different line,
4227 ;; retry everything within that new line.
4228 (when (or (< (point) line-beg) (> (point) line-end))
4229 ;; Repeat the intangibility and field processing.
4230 (setq repeat t))))))
4232 (defun line-move-to-column (col)
4233 "Try to find column COL, considering invisibility.
4234 This function works only in certain cases,
4235 because what we really need is for `move-to-column'
4236 and `current-column' to be able to ignore invisible text."
4237 (if (zerop col)
4238 (beginning-of-line)
4239 (move-to-column col))
4241 (when (and line-move-ignore-invisible
4242 (not (bolp)) (invisible-p (1- (point))))
4243 (let ((normal-location (point))
4244 (normal-column (current-column)))
4245 ;; If the following character is currently invisible,
4246 ;; skip all characters with that same `invisible' property value.
4247 (while (and (not (eobp))
4248 (invisible-p (point)))
4249 (goto-char (next-char-property-change (point))))
4250 ;; Have we advanced to a larger column position?
4251 (if (> (current-column) normal-column)
4252 ;; We have made some progress towards the desired column.
4253 ;; See if we can make any further progress.
4254 (line-move-to-column (+ (current-column) (- col normal-column)))
4255 ;; Otherwise, go to the place we originally found
4256 ;; and move back over invisible text.
4257 ;; that will get us to the same place on the screen
4258 ;; but with a more reasonable buffer position.
4259 (goto-char normal-location)
4260 (let ((line-beg (save-excursion (beginning-of-line) (point))))
4261 (while (and (not (bolp)) (invisible-p (1- (point))))
4262 (goto-char (previous-char-property-change (point) line-beg))))))))
4264 (defun move-end-of-line (arg)
4265 "Move point to end of current line as displayed.
4266 \(If there's an image in the line, this disregards newlines
4267 which are part of the text that the image rests on.)
4269 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4270 If point reaches the beginning or end of buffer, it stops there.
4271 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4272 (interactive "^p")
4273 (or arg (setq arg 1))
4274 (let (done)
4275 (while (not done)
4276 (let ((newpos
4277 (save-excursion
4278 (let ((goal-column 0)
4279 (line-move-visual nil))
4280 (and (line-move arg t)
4281 (not (bobp))
4282 (progn
4283 (while (and (not (bobp)) (invisible-p (1- (point))))
4284 (goto-char (previous-single-char-property-change
4285 (point) 'invisible)))
4286 (backward-char 1)))
4287 (point)))))
4288 (goto-char newpos)
4289 (if (and (> (point) newpos)
4291 (backward-char 1)
4292 (if (and (> (point) newpos) (not (eobp))
4294 ;; If we skipped something intangible and now we're not
4295 ;; really at eol, keep going.
4296 (setq arg 1)
4297 (setq done t)))))))
4299 (defun move-beginning-of-line (arg)
4300 "Move point to beginning of current line as displayed.
4301 \(If there's an image in the line, this disregards newlines
4302 which are part of the text that the image rests on.)
4304 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4305 If point reaches the beginning or end of buffer, it stops there.
4306 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4307 (interactive "^p")
4308 (or arg (setq arg 1))
4310 (let ((orig (point))
4311 first-vis first-vis-field-value)
4313 ;; Move by lines, if ARG is not 1 (the default).
4314 (if (/= arg 1)
4315 (let ((line-move-visual nil))
4316 (line-move (1- arg) t)))
4318 ;; Move to beginning-of-line, ignoring fields and invisibles.
4320 (while (and (not (bobp)) (invisible-p (1- (point))))
4321 (goto-char (previous-char-property-change (point)))
4324 ;; Now find first visible char in the line
4325 (while (and (not (eobp)) (invisible-p (point)))
4326 (goto-char (next-char-property-change (point))))
4327 (setq first-vis (point))
4329 ;; See if fields would stop us from reaching FIRST-VIS.
4330 (setq first-vis-field-value
4331 (constrain-to-field first-vis orig (/= arg 1) t nil))
4333 (goto-char (if (/= first-vis-field-value first-vis)
4334 ;; If yes, obey them.
4335 first-vis-field-value
4336 ;; Otherwise, move to START with attention to fields.
4337 ;; (It is possible that fields never matter in this case.)
4338 (constrain-to-field (point) orig
4339 (/= arg 1) t nil)))))
4342 ;;; Many people have said they rarely use this feature, and often type
4343 ;;; it by accident. Maybe it shouldn't even be on a key.
4344 (put 'set-goal-column 'disabled t)
4346 (defun set-goal-column (arg)
4348 Those commands will move to this position in the line moved to
4349 rather than trying to keep the same horizontal position.
4350 With a non-nil argument, clears out the goal column
4352 The goal column is stored in the variable `goal-column'."
4353 (interactive "P")
4354 (if arg
4355 (progn
4356 (setq goal-column nil)
4357 (message "No goal column"))
4358 (setq goal-column (current-column))
4359 ;; The older method below can be erroneous if `set-goal-column' is bound
4360 ;; to a sequence containing %
4361 ;;(message (substitute-command-keys
4363 ;;goal-column)
4364 (message "%s"
4365 (concat
4366 (format "Goal column %d " goal-column)
4367 (substitute-command-keys
4370 )
4371 nil)
4372 \f
4373 ;;; Editing based on visual lines, as opposed to logical lines.
4375 (defun end-of-visual-line (&optional n)
4376 "Move point to end of current visual line.
4377 With argument N not nil or 1, move forward N - 1 visual lines first.
4378 If point reaches the beginning or end of buffer, it stops there.
4379 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4380 (interactive "^p")
4381 (or n (setq n 1))
4382 (if (/= n 1)
4383 (let ((line-move-visual t))
4384 (line-move (1- n) t)))
4385 (vertical-motion (cons (window-width) 0)))
4387 (defun beginning-of-visual-line (&optional n)
4388 "Move point to beginning of current visual line.
4389 With argument N not nil or 1, move forward N - 1 visual lines first.
4390 If point reaches the beginning or end of buffer, it stops there.
4391 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4392 (interactive "^p")
4393 (or n (setq n 1))
4394 (if (/= n 1)
4395 (let ((line-move-visual t))
4396 (line-move (1- n) t)))
4397 (vertical-motion 0))
4399 (defun kill-visual-line (&optional arg)
4400 "Kill the rest of the visual line.
4401 If there are only whitespace characters there, kill through the
4402 newline as well.
4404 With prefix argument, kill that many lines from point.
4405 Negative arguments kill lines backward.
4406 With zero argument, kill the text before point on the current line.
4409 a number counts as a prefix arg.
4411 If `kill-whole-line' is non-nil, then this command kills the whole line
4412 including its terminating newline, when used at the beginning of a line
4413 with no argument. As a consequence, you can always kill a whole line
4416 If you want to append the killed line to the last killed text,
4419 If the buffer is read-only, Emacs will beep and refrain from deleting
4420 the line, but put the line in the kill ring anyway. This means that
4421 you can use this command to copy text from a read-only buffer.
4422 \(If the variable `kill-read-only-ok' is non-nil, then this won't
4423 even beep.)"
4424 (interactive "P")
4425 (let ((opoint (point))
4426 (line-move-visual t)
4427 end)
4428 ;; It is better to move point to the other end of the kill before
4429 ;; killing. That way, in a read-only buffer, point moves across
4430 ;; the text that is copied to the kill ring. The choice has no
4431 ;; effect on undo now that undo records the value of point from
4432 ;; before the command was run.
4433 (if arg
4434 (vertical-motion (prefix-numeric-value arg))
4435 (if (eobp)
4436 (signal 'end-of-buffer nil))
4437 (setq end (save-excursion
4438 (end-of-visual-line) (point)))
4439 (if (or (save-excursion
4440 ;; If trailing whitespace is visible,
4441 ;; don't treat it as nothing.
4442 (unless show-trailing-whitespace
4444 (= (point) end))
4445 (and kill-whole-line (bolp)))
4446 (line-move 1)
4447 (goto-char end)))
4448 (kill-region opoint (point))))
4450 (defun next-logical-line (&optional arg try-vscroll)
4451 "Move cursor vertically down ARG lines.
4452 This is identical to `previous-line', except that it always moves
4453 by logical lines instead of visual lines, ignoring the value of
4454 the variable `line-move-visual'."
4456 (let ((line-move-visual nil))
4457 (with-no-warnings
4458 (next-line arg try-vscroll))))
4460 (defun previous-logical-line (&optional arg try-vscroll)
4461 "Move cursor vertically up ARG lines.
4462 This is identical to `previous-line', except that it always moves
4463 by logical lines instead of visual lines, ignoring the value of
4464 the variable `line-move-visual'."
4466 (let ((line-move-visual nil))
4467 (with-no-warnings
4468 (previous-line arg try-vscroll))))
4470 (defgroup visual-line nil
4471 "Editing based on visual lines."
4472 :group 'convenience
4473 :version "23.1")
4475 (defvar visual-line-mode-map
4476 (let ((map (make-sparse-keymap)))
4477 (define-key map [remap kill-line] 'kill-visual-line)
4478 (define-key map [remap move-beginning-of-line] 'beginning-of-visual-line)
4479 (define-key map [remap move-end-of-line] 'end-of-visual-line)
4480 (define-key map "\M-[" 'previous-logical-line)
4481 (define-key map "\M-]" 'next-logical-line)
4482 map))
4484 (defcustom visual-line-fringe-indicators '(nil nil)
4485 "How fringe indicators are shown for wrapped lines in `visual-line-mode'.
4486 The value should be a list of the form (LEFT RIGHT), where LEFT
4487 and RIGHT are symbols representing the bitmaps to display, to
4488 indicate wrapped lines, in the left and right fringes respectively.
4489 See also `fringe-indicator-alist'.
4490 The default is not to display fringe indicators for wrapped lines.
4491 This variable does not affect fringe indicators displayed for
4492 other purposes."
4493 :type '(list (choice (const :tag "Hide left indicator" nil)
4494 (const :tag "Left curly arrow" left-curly-arrow)
4495 (symbol :tag "Other bitmap"))
4496 (choice (const :tag "Hide right indicator" nil)
4497 (const :tag "Right curly arrow" right-curly-arrow)
4498 (symbol :tag "Other bitmap")))
4499 :set (lambda (symbol value)
4500 (dolist (buf (buffer-list))
4501 (with-current-buffer buf
4502 (when (and (boundp 'visual-line-mode)
4503 (symbol-value 'visual-line-mode))
4504 (setq fringe-indicator-alist
4505 (cons (cons 'continuation value)
4506 (assq-delete-all
4507 'continuation
4508 (copy-tree fringe-indicator-alist)))))))
4509 (set-default symbol value)))
4511 (defvar visual-line--saved-state nil)
4513 (define-minor-mode visual-line-mode
4514 "Redefine simple editing commands to act on visual lines, not logical lines.
4515 This also turns on `word-wrap' in the buffer."
4516 :keymap visual-line-mode-map
4517 :group 'visual-line
4518 :lighter " wrap"
4519 (if visual-line-mode
4520 (progn
4521 (set (make-local-variable 'visual-line--saved-state) nil)
4522 ;; Save the local values of some variables, to be restored if
4523 ;; visual-line-mode is turned off.
4524 (dolist (var '(line-move-visual truncate-lines
4525 truncate-partial-width-windows
4526 word-wrap fringe-indicator-alist))
4527 (if (local-variable-p var)
4528 (push (cons var (symbol-value var))
4529 visual-line--saved-state)))
4530 (set (make-local-variable 'line-move-visual) t)
4531 (set (make-local-variable 'truncate-partial-width-windows) nil)
4532 (setq truncate-lines nil
4533 word-wrap t
4534 fringe-indicator-alist
4535 (cons (cons 'continuation visual-line-fringe-indicators)
4536 fringe-indicator-alist)))
4537 (kill-local-variable 'line-move-visual)
4538 (kill-local-variable 'word-wrap)
4539 (kill-local-variable 'truncate-lines)
4540 (kill-local-variable 'truncate-partial-width-windows)
4541 (kill-local-variable 'fringe-indicator-alist)
4542 (dolist (saved visual-line--saved-state)
4543 (set (make-local-variable (car saved)) (cdr saved)))
4544 (kill-local-variable 'visual-line--saved-state)))
4546 (defun turn-on-visual-line-mode ()
4547 (visual-line-mode 1))
4549 (define-globalized-minor-mode global-visual-line-mode
4550 visual-line-mode turn-on-visual-line-mode
4551 :lighter " vl")
4552 \f
4553 (defun scroll-other-window-down (lines)
4555 For more details, see the documentation for `scroll-other-window'."
4556 (interactive "P")
4557 (scroll-other-window
4558 ;; Just invert the argument's meaning.
4559 ;; We can do that without knowing which window it will be.
4560 (if (eq lines '-) nil
4561 (if (null lines) '-
4562 (- (prefix-numeric-value lines))))))
4564 (defun beginning-of-buffer-other-window (arg)
4565 "Move point to the beginning of the buffer in the other window.
4566 Leave mark at previous position.
4567 With arg N, put point N/10 of the way from the true beginning."
4568 (interactive "P")
4569 (let ((orig-window (selected-window))
4570 (window (other-window-for-scrolling)))
4571 ;; We use unwind-protect rather than save-window-excursion
4572 ;; because the latter would preserve the things we want to change.
4573 (unwind-protect
4574 (progn
4575 (select-window window)
4576 ;; Set point and mark in that window's buffer.
4577 (with-no-warnings
4578 (beginning-of-buffer arg))
4579 ;; Set point accordingly.
4580 (recenter '(t)))
4581 (select-window orig-window))))
4583 (defun end-of-buffer-other-window (arg)
4584 "Move point to the end of the buffer in the other window.
4585 Leave mark at previous position.
4586 With arg N, put point N/10 of the way from the true end."
4587 (interactive "P")
4588 ;; See beginning-of-buffer-other-window for comments.
4589 (let ((orig-window (selected-window))
4590 (window (other-window-for-scrolling)))
4591 (unwind-protect
4592 (progn
4593 (select-window window)
4594 (with-no-warnings
4595 (end-of-buffer arg))
4596 (recenter '(t)))
4597 (select-window orig-window))))
4598 \f
4599 (defun transpose-chars (arg)
4600 "Interchange characters around point, moving forward one character.
4601 With prefix arg ARG, effect is to take character before point
4602 and drag it forward past ARG other characters (backward if ARG negative).
4603 If no argument and at end of line, the previous two chars are exchanged."
4604 (interactive "*P")
4605 (and (null arg) (eolp) (forward-char -1))
4606 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4608 (defun transpose-words (arg)
4609 "Interchange words around point, leaving point at end of them.
4610 With prefix arg ARG, effect is to take word before or around point
4611 and drag it forward past ARG other words (backward if ARG negative).
4612 If ARG is zero, the words around or after point and around or after mark
4613 are interchanged."
4614 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4615 (interactive "*p")
4616 (transpose-subr 'forward-word arg))
4618 (defun transpose-sexps (arg)
4620 Does not work on a sexp that point is in the middle of
4621 if it is a list or string."
4622 (interactive "*p")
4623 (transpose-subr
4624 (lambda (arg)
4625 ;; Here we should try to simulate the behavior of
4626 ;; (cons (progn (forward-sexp x) (point))
4627 ;; (progn (forward-sexp (- x)) (point)))
4628 ;; Except that we don't want to rely on the second forward-sexp
4629 ;; putting us back to where we want to be, since forward-sexp-function
4630 ;; might do funny things like infix-precedence.
4631 (if (if (> arg 0)
4633 (and (not (bobp))
4635 ;; Jumping over a symbol. We might be inside it, mind you.
4636 (progn (funcall (if (> arg 0)
4637 'skip-syntax-backward 'skip-syntax-forward)
4638 "w_")
4639 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4640 ;; Otherwise, we're between sexps. Take a step back before jumping
4641 ;; to make sure we'll obey the same precedence no matter which direction
4642 ;; we're going.
4643 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4644 (cons (save-excursion (forward-sexp arg) (point))
4645 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4646 (not (zerop (funcall (if (> arg 0)
4647 'skip-syntax-forward
4648 'skip-syntax-backward)
4649 ".")))))
4650 (point)))))
4651 arg 'special))
4653 (defun transpose-lines (arg)
4654 "Exchange current line and previous line, leaving point after both.
4655 With argument ARG, takes previous line and moves it past ARG lines.
4656 With argument 0, interchanges line point is in with line mark is in."
4657 (interactive "*p")
4658 (transpose-subr (function
4659 (lambda (arg)
4660 (if (> arg 0)
4661 (progn
4662 ;; Move forward over ARG lines,
4663 ;; but create newlines if necessary.
4664 (setq arg (forward-line arg))
4666 (setq arg (1+ arg)))
4667 (if (> arg 0)
4668 (newline arg)))
4669 (forward-line arg))))
4670 arg))
4672 (defun transpose-subr (mover arg &optional special)
4673 (let ((aux (if special mover
4674 (lambda (x)
4675 (cons (progn (funcall mover x) (point))
4676 (progn (funcall mover (- x)) (point))))))
4677 pos1 pos2)
4678 (cond
4679 ((= arg 0)
4680 (save-excursion
4681 (setq pos1 (funcall aux 1))
4682 (goto-char (mark))
4683 (setq pos2 (funcall aux 1))
4684 (transpose-subr-1 pos1 pos2))
4685 (exchange-point-and-mark))
4686 ((> arg 0)
4687 (setq pos1 (funcall aux -1))
4688 (setq pos2 (funcall aux arg))
4689 (transpose-subr-1 pos1 pos2)
4690 (goto-char (car pos2)))
4691 (t
4692 (setq pos1 (funcall aux -1))
4693 (goto-char (car pos1))
4694 (setq pos2 (funcall aux arg))
4695 (transpose-subr-1 pos1 pos2)))))
4697 (defun transpose-subr-1 (pos1 pos2)
4698 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4699 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4700 (when (> (car pos1) (car pos2))
4701 (let ((swap pos1))
4702 (setq pos1 pos2 pos2 swap)))
4703 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
4704 (atomic-change-group
4705 (let (word2)
4706 ;; FIXME: We first delete the two pieces of text, so markers that
4707 ;; used to point to after the text end up pointing to before it :-(
4708 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
4709 (goto-char (car pos2))
4710 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
4711 (goto-char (car pos1))
4712 (insert word2))))
4713 \f
4714 (defun backward-word (&optional arg)
4715 "Move backward until encountering the beginning of a word.
4716 With argument, do this that many times."
4717 (interactive "^p")
4718 (forward-word (- (or arg 1))))
4720 (defun mark-word (&optional arg allow-extend)
4721 "Set mark ARG words away from point.
4723 move to with the same argument.
4724 Interactively, if this command is repeated
4725 or (in Transient Mark mode) if the mark is active,
4726 it marks the next ARG words after the ones already marked."
4728 (cond ((and allow-extend
4729 (or (and (eq last-command this-command) (mark t))
4730 (region-active-p)))
4731 (setq arg (if arg (prefix-numeric-value arg)
4732 (if (< (mark) (point)) -1 1)))
4733 (set-mark
4734 (save-excursion
4735 (goto-char (mark))
4736 (forward-word arg)
4737 (point))))
4738 (t
4739 (push-mark
4740 (save-excursion
4741 (forward-word (prefix-numeric-value arg))
4742 (point))
4743 nil t))))
4745 (defun kill-word (arg)
4746 "Kill characters forward until encountering the end of a word.
4747 With argument, do this that many times."
4748 (interactive "p")
4749 (kill-region (point) (progn (forward-word arg) (point))))
4751 (defun backward-kill-word (arg)
4752 "Kill characters backward until encountering the beginning of a word.
4753 With argument, do this that many times."
4754 (interactive "p")
4755 (kill-word (- arg)))
4757 (defun current-word (&optional strict really-word)
4758 "Return the symbol or word that point is on (or a nearby one) as a string.
4759 The return value includes no text properties.
4760 If optional arg STRICT is non-nil, return nil unless point is within
4761 or adjacent to a symbol or word. In all cases the value can be nil
4762 if there is no word nearby.
4763 The function, belying its name, normally finds a symbol.
4764 If optional arg REALLY-WORD is non-nil, it finds just a word."
4765 (save-excursion
4766 (let* ((oldpoint (point)) (start (point)) (end (point))
4767 (syntaxes (if really-word "w" "w_"))
4768 (not-syntaxes (concat "^" syntaxes)))
4769 (skip-syntax-backward syntaxes) (setq start (point))
4770 (goto-char oldpoint)
4771 (skip-syntax-forward syntaxes) (setq end (point))
4772 (when (and (eq start oldpoint) (eq end oldpoint)
4773 ;; Point is neither within nor adjacent to a word.
4774 (not strict))
4775 ;; Look for preceding word in same line.
4776 (skip-syntax-backward not-syntaxes
4777 (save-excursion (beginning-of-line)
4778 (point)))
4779 (if (bolp)
4780 ;; No preceding word in same line.
4781 ;; Look for following word in same line.
4782 (progn
4783 (skip-syntax-forward not-syntaxes
4784 (save-excursion (end-of-line)
4785 (point)))
4786 (setq start (point))
4787 (skip-syntax-forward syntaxes)
4788 (setq end (point)))
4789 (setq end (point))
4790 (skip-syntax-backward syntaxes)
4791 (setq start (point))))
4792 ;; If we found something nonempty, return it as a string.
4793 (unless (= start end)
4794 (buffer-substring-no-properties start end)))))
4795 \f
4796 (defcustom fill-prefix nil
4797 "*String for filling to insert at front of new line, or nil for none."
4798 :type '(choice (const :tag "None" nil)
4799 string)
4800 :group 'fill)
4801 (make-variable-buffer-local 'fill-prefix)
4802 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
4804 (defcustom auto-fill-inhibit-regexp nil
4805 "*Regexp to match lines which should not be auto-filled."
4806 :type '(choice (const :tag "None" nil)
4807 regexp)
4808 :group 'fill)
4810 ;; This function is used as the auto-fill-function of a buffer
4811 ;; when Auto-Fill mode is enabled.
4812 ;; It returns t if it really did any work.
4813 ;; (Actually some major modes use a different auto-fill function,
4814 ;; but this one is the default one.)
4815 (defun do-auto-fill ()
4816 (let (fc justify give-up
4817 (fill-prefix fill-prefix))
4818 (if (or (not (setq justify (current-justification)))
4819 (null (setq fc (current-fill-column)))
4820 (and (eq justify 'left)
4821 (<= (current-column) fc))
4822 (and auto-fill-inhibit-regexp
4823 (save-excursion (beginning-of-line)
4824 (looking-at auto-fill-inhibit-regexp))))
4825 nil ;; Auto-filling not required
4826 (if (memq justify '(full center right))
4827 (save-excursion (unjustify-current-line)))
4829 ;; Choose a fill-prefix automatically.
4830 (when (and adaptive-fill-mode
4831 (or (null fill-prefix) (string= fill-prefix "")))
4832 (let ((prefix
4833 (fill-context-prefix
4834 (save-excursion (backward-paragraph 1) (point))
4835 (save-excursion (forward-paragraph 1) (point)))))
4836 (and prefix (not (equal prefix ""))
4837 ;; Use auto-indentation rather than a guessed empty prefix.
4838 (not (and fill-indent-according-to-mode
4840 (setq fill-prefix prefix))))
4842 (while (and (not give-up) (> (current-column) fc))
4843 ;; Determine where to split the line.
4844 (let* (after-prefix
4845 (fill-point
4846 (save-excursion
4847 (beginning-of-line)
4848 (setq after-prefix (point))
4849 (and fill-prefix
4850 (looking-at (regexp-quote fill-prefix))
4851 (setq after-prefix (match-end 0)))
4852 (move-to-column (1+ fc))
4853 (fill-move-to-break-point after-prefix)
4854 (point))))
4856 ;; See whether the place we found is any good.
4857 (if (save-excursion
4858 (goto-char fill-point)
4859 (or (bolp)
4860 ;; There is no use breaking at end of line.
4861 (save-excursion (skip-chars-forward " ") (eolp))
4862 ;; It is futile to split at the end of the prefix
4863 ;; since we would just insert the prefix again.
4864 (and after-prefix (<= (point) after-prefix))
4865 ;; Don't split right after a comment starter
4866 ;; since we would just make another comment starter.
4867 (and comment-start-skip
4868 (let ((limit (point)))
4869 (beginning-of-line)
4870 (and (re-search-forward comment-start-skip
4871 limit t)
4872 (eq (point) limit))))))
4873 ;; No good place to break => stop trying.
4874 (setq give-up t)
4875 ;; Ok, we have a useful place to break the line. Do it.
4876 (let ((prev-column (current-column)))
4877 ;; If point is at the fill-point, do not `save-excursion'.
4878 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4879 ;; point will end up before it rather than after it.
4880 (if (save-excursion
4882 (= (point) fill-point))
4883 (default-indent-new-line t)
4884 (save-excursion
4885 (goto-char fill-point)
4886 (default-indent-new-line t)))
4887 ;; Now do justification, if required
4888 (if (not (eq justify 'left))
4889 (save-excursion
4890 (end-of-line 0)
4891 (justify-current-line justify nil t)))
4892 ;; If making the new line didn't reduce the hpos of
4893 ;; the end of the line, then give up now;
4894 ;; trying again will not help.
4895 (if (>= (current-column) prev-column)
4896 (setq give-up t))))))
4897 ;; Justify last line.
4898 (justify-current-line justify t t)
4899 t)))
4901 (defvar comment-line-break-function 'comment-indent-new-line
4902 "*Mode-specific function which line breaks and continues a comment.
4903 This function is called during auto-filling when a comment syntax
4904 is defined.
4905 The function should take a single optional argument, which is a flag
4906 indicating whether it should use soft newlines.")
4908 (defun default-indent-new-line (&optional soft)
4909 "Break line at point and indent.
4910 If a comment syntax is defined, call `comment-indent-new-line'.
4912 The inserted newline is marked hard if variable `use-hard-newlines' is true,
4913 unless optional argument SOFT is non-nil."
4914 (interactive)
4915 (if comment-start
4916 (funcall comment-line-break-function soft)
4917 ;; Insert the newline before removing empty space so that markers
4918 ;; get preserved better.
4920 (save-excursion (forward-char -1) (delete-horizontal-space))
4921 (delete-horizontal-space)
4923 (if (and fill-prefix (not adaptive-fill-mode))
4924 ;; Blindly trust a non-adaptive fill-prefix.
4925 (progn
4926 (indent-to-left-margin)
4927 (insert-before-markers-and-inherit fill-prefix))
4929 (cond
4930 ;; If there's an adaptive prefix, use it unless we're inside
4931 ;; a comment and the prefix is not a comment starter.
4932 (fill-prefix
4933 (indent-to-left-margin)
4934 (insert-and-inherit fill-prefix))
4935 ;; If we're not inside a comment, just try to indent.
4936 (t (indent-according-to-mode))))))
4938 (defvar normal-auto-fill-function 'do-auto-fill
4939 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4940 Some major modes set this.")
4942 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4943 ;; FIXME: turn into a proper minor mode.
4944 ;; Add a global minor mode version of it.
4945 (defun auto-fill-mode (&optional arg)
4946 "Toggle Auto Fill mode.
4947 With arg, turn Auto Fill mode on if and only if arg is positive.
4948 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4949 automatically breaks the line at a previous space.
4951 The value of `normal-auto-fill-function' specifies the function to use
4952 for `auto-fill-function' when turning Auto Fill mode on."
4953 (interactive "P")
4954 (prog1 (setq auto-fill-function
4955 (if (if (null arg)
4956 (not auto-fill-function)
4957 (> (prefix-numeric-value arg) 0))
4958 normal-auto-fill-function
4959 nil))
4960 (force-mode-line-update)))
4962 ;; This holds a document string used to document auto-fill-mode.
4963 (defun auto-fill-function ()
4964 "Automatically break line at a previous space, in insertion of text."
4965 nil)
4967 (defun turn-on-auto-fill ()
4968 "Unconditionally turn on Auto Fill mode."
4969 (auto-fill-mode 1))
4971 (defun turn-off-auto-fill ()
4972 "Unconditionally turn off Auto Fill mode."
4973 (auto-fill-mode -1))
4975 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4977 (defun set-fill-column (arg)
4978 "Set `fill-column' to specified argument.
4981 (interactive
4982 (list (or current-prefix-arg
4983 ;; We used to use current-column silently, but C-x f is too easily
4984 ;; typed as a typo for C-x C-f, so we turned it into an error and
4985 ;; now an interactive prompt.
4986 (read-number "Set fill-column to: " (current-column)))))
4987 (if (consp arg)
4988 (setq arg (current-column)))
4989 (if (not (integerp arg))
4990 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4991 (error "set-fill-column requires an explicit argument")
4992 (message "Fill column set to %d (was %d)" arg fill-column)
4993 (setq fill-column arg)))
4994 \f
4995 (defun set-selective-display (arg)
4996 "Set `selective-display' to ARG; clear it if no arg.
4997 When the value of `selective-display' is a number > 0,
4998 lines whose indentation is >= that value are not displayed.
4999 The variable `selective-display' has a separate value for each buffer."
5000 (interactive "P")
5001 (if (eq selective-display t)
5002 (error "selective-display already in use for marked lines"))
5003 (let ((current-vpos
5004 (save-restriction
5005 (narrow-to-region (point-min) (point))
5006 (goto-char (window-start))
5007 (vertical-motion (window-height)))))
5008 (setq selective-display
5009 (and arg (prefix-numeric-value arg)))
5010 (recenter current-vpos))
5011 (set-window-start (selected-window) (window-start (selected-window)))
5012 (princ "selective-display set to " t)
5013 (prin1 selective-display t)
5014 (princ "." t))
5016 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
5018 (defun toggle-truncate-lines (&optional arg)
5019 "Toggle whether to fold or truncate long lines for the current buffer.
5020 With prefix argument ARG, truncate long lines if ARG is positive,
5021 otherwise don't truncate them. Note that in side-by-side
5022 windows, this command has no effect if `truncate-partial-width-windows'
5023 is non-nil."
5024 (interactive "P")
5025 (setq truncate-lines
5026 (if (null arg)
5027 (not truncate-lines)
5028 (> (prefix-numeric-value arg) 0)))
5029 (force-mode-line-update)
5030 (unless truncate-lines
5031 (let ((buffer (current-buffer)))
5032 (walk-windows (lambda (window)
5033 (if (eq buffer (window-buffer window))
5034 (set-window-hscroll window 0)))
5035 nil t)))
5036 (message "Truncate long lines %s"
5037 (if truncate-lines "enabled" "disabled")))
5039 (defvar overwrite-mode-textual " Ovwrt"
5040 "The string displayed in the mode line when in overwrite mode.")
5041 (defvar overwrite-mode-binary " Bin Ovwrt"
5042 "The string displayed in the mode line when in binary overwrite mode.")
5044 (defun overwrite-mode (arg)
5045 "Toggle overwrite mode.
5046 With prefix argument ARG, turn overwrite mode on if ARG is positive,
5047 otherwise turn it off. In overwrite mode, printing characters typed
5048 in replace existing text on a one-for-one basis, rather than pushing
5049 it to the right. At the end of a line, such characters extend the line.
5050 Before a tab, such characters insert until the tab is filled in.
5052 is supposed to make it easier to insert characters when necessary."
5053 (interactive "P")
5054 (setq overwrite-mode
5055 (if (if (null arg) (not overwrite-mode)
5056 (> (prefix-numeric-value arg) 0))
5057 'overwrite-mode-textual))
5058 (force-mode-line-update))
5060 (defun binary-overwrite-mode (arg)
5061 "Toggle binary overwrite mode.
5062 With prefix argument ARG, turn binary overwrite mode on if ARG is
5063 positive, otherwise turn it off. In binary overwrite mode, printing
5064 characters typed in replace existing text. Newlines are not treated
5065 specially, so typing at the end of a line joins the line to the next,
5066 with the typed character between them. Typing before a tab character
5068 replaces the text at the cursor, just as ordinary typing characters do.
5070 Note that binary overwrite mode is not its own minor mode; it is a
5071 specialization of overwrite mode, entered by setting the
5072 `overwrite-mode' variable to `overwrite-mode-binary'."
5073 (interactive "P")
5074 (setq overwrite-mode
5075 (if (if (null arg)
5076 (not (eq overwrite-mode 'overwrite-mode-binary))
5077 (> (prefix-numeric-value arg) 0))
5078 'overwrite-mode-binary))
5079 (force-mode-line-update))
5081 (define-minor-mode line-number-mode
5082 "Toggle Line Number mode.
5083 With arg, turn Line Number mode on if arg is positive, otherwise
5084 turn it off. When Line Number mode is enabled, the line number
5085 appears in the mode line.
5087 Line numbers do not appear for very large buffers and buffers
5088 with very long lines; see variables `line-number-display-limit'
5089 and `line-number-display-limit-width'."
5090 :init-value t :global t :group 'mode-line)
5092 (define-minor-mode column-number-mode
5093 "Toggle Column Number mode.
5094 With arg, turn Column Number mode on if arg is positive,
5095 otherwise turn it off. When Column Number mode is enabled, the
5096 column number appears in the mode line."
5097 :global t :group 'mode-line)
5099 (define-minor-mode size-indication-mode
5100 "Toggle Size Indication mode.
5101 With arg, turn Size Indication mode on if arg is positive,
5102 otherwise turn it off. When Size Indication mode is enabled, the
5103 size of the accessible part of the buffer appears in the mode line."
5104 :global t :group 'mode-line)
5105 \f
5106 (defgroup paren-blinking nil
5107 "Blinking matching of parens and expressions."
5108 :prefix "blink-matching-"
5109 :group 'paren-matching)
5111 (defcustom blink-matching-paren t
5112 "*Non-nil means show matching open-paren when close-paren is inserted."
5113 :type 'boolean
5114 :group 'paren-blinking)
5116 (defcustom blink-matching-paren-on-screen t
5117 "*Non-nil means show matching open-paren when it is on screen.
5118 If nil, don't show it (but the open-paren can still be shown
5119 when it is off screen).
5121 This variable has no effect if `blink-matching-paren' is nil.
5122 \(In that case, the open-paren is never shown.)
5123 It is also ignored if `show-paren-mode' is enabled."
5124 :type 'boolean
5125 :group 'paren-blinking)
5127 (defcustom blink-matching-paren-distance (* 25 1024)
5128 "*If non-nil, maximum distance to search backwards for matching open-paren.
5129 If nil, search stops at the beginning of the accessible portion of the buffer."
5130 :type '(choice (const nil) integer)
5131 :group 'paren-blinking)
5133 (defcustom blink-matching-delay 1
5134 "*Time in seconds to delay after showing a matching paren."
5135 :type 'number
5136 :group 'paren-blinking)
5138 (defcustom blink-matching-paren-dont-ignore-comments nil
5139 "*If nil, `blink-matching-paren' ignores comments.
5140 More precisely, when looking for the matching parenthesis,
5141 it skips the contents of comments that end before point."
5142 :type 'boolean
5143 :group 'paren-blinking)
5145 (defun blink-matching-open ()
5146 "Move cursor momentarily to the beginning of the sexp before point."
5147 (interactive)
5148 (when (and (> (point) (point-min))
5149 blink-matching-paren
5150 ;; Verify an even number of quoting characters precede the close.
5151 (= 1 (logand 1 (- (point)
5152 (save-excursion
5153 (forward-char -1)
5155 (point))))))
5156 (let* ((oldpos (point))
5157 (message-log-max nil) ; Don't log messages about paren matching.
5158 (atdollar (eq (syntax-class (syntax-after (1- oldpos))) 8))
5159 (isdollar)
5160 (blinkpos
5161 (save-excursion
5162 (save-restriction
5163 (if blink-matching-paren-distance
5164 (narrow-to-region
5165 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
5166 (- (point) blink-matching-paren-distance))
5167 oldpos))
5168 (let ((parse-sexp-ignore-comments
5169 (and parse-sexp-ignore-comments
5170 (not blink-matching-paren-dont-ignore-comments))))
5171 (condition-case ()
5172 (scan-sexps oldpos -1)
5173 (error nil))))))
5174 (matching-paren
5175 (and blinkpos
5176 ;; Not syntax '$'.
5177 (not (setq isdollar
5178 (eq (syntax-class (syntax-after blinkpos)) 8)))
5179 (let ((syntax (syntax-after blinkpos)))
5180 (and (consp syntax)
5181 (eq (syntax-class syntax) 4)
5182 (cdr syntax))))))
5183 (cond
5184 ;; isdollar is for:
5185 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00871.html
5186 ((not (or (and isdollar blinkpos)
5187 (and atdollar (not blinkpos)) ; see below
5188 (eq matching-paren (char-before oldpos))
5189 ;; The cdr might hold a new paren-class info rather than
5190 ;; a matching-char info, in which case the two CDRs
5191 ;; should match.
5192 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
5193 (message "Mismatched parentheses"))
5194 ((not blinkpos)
5195 (or blink-matching-paren-distance
5196 ;; Don't complain when `$' with no blinkpos, because it
5197 ;; could just be the first one typed in the buffer.
5198 atdollar
5199 (message "Unmatched parenthesis")))
5200 ((pos-visible-in-window-p blinkpos)
5201 ;; Matching open within window, temporarily move to blinkpos but only
5202 ;; if `blink-matching-paren-on-screen' is non-nil.
5203 (and blink-matching-paren-on-screen
5204 (not show-paren-mode)
5205 (save-excursion
5206 (goto-char blinkpos)
5207 (sit-for blink-matching-delay))))
5208 (t
5209 (save-excursion
5210 (goto-char blinkpos)
5211 (let ((open-paren-line-string
5212 ;; Show what precedes the open in its line, if anything.
5213 (cond
5215 (buffer-substring (line-beginning-position)
5216 (1+ blinkpos)))
5217 ;; Show what follows the open in its line, if anything.
5218 ((save-excursion
5219 (forward-char 1)
5221 (not (eolp)))
5222 (buffer-substring blinkpos
5223 (line-end-position)))
5224 ;; Otherwise show the previous nonblank line,
5225 ;; if there is one.
5227 (concat
5228 (buffer-substring (progn
5230 (line-beginning-position))
5231 (progn (end-of-line)
5233 (point)))
5234 ;; Replace the newline and other whitespace with `...'.
5235 "..."
5236 (buffer-substring blinkpos (1+ blinkpos))))
5237 ;; There is nothing to show except the char itself.
5238 (t (buffer-substring blinkpos (1+ blinkpos))))))
5239 (message "Matches %s"
5240 (substring-no-properties open-paren-line-string)))))))))
5242 ;; Turned off because it makes dbx bomb out.
5243 (setq blink-paren-function 'blink-matching-open)
5244 \f
5245 ;; This executes C-g typed while Emacs is waiting for a command.
5246 ;; Quitting out of a program does not go through here;
5247 ;; that happens in the QUIT macro at the C code level.
5248 (defun keyboard-quit ()
5249 "Signal a `quit' condition.
5250 During execution of Lisp code, this character causes a quit directly.
5251 At top-level, as an editor command, this simply beeps."
5252 (interactive)
5253 (deactivate-mark)
5254 (if (fboundp 'kmacro-keyboard-quit)
5255 (kmacro-keyboard-quit))
5256 (setq defining-kbd-macro nil)
5257 (signal 'quit nil))
5259 (defvar buffer-quit-function nil
5262 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
5264 (defun keyboard-escape-quit ()
5266 This command can exit an interactive command such as `query-replace',
5267 can clear out a prefix argument or a region,
5268 can get out of the minibuffer or other recursive edit,
5269 cancel the use of the current buffer (for special-purpose buffers),
5270 or go back to just one window (by deleting all but the selected window)."
5271 (interactive)
5272 (cond ((eq last-command 'mode-exited) nil)
5273 ((> (minibuffer-depth) 0)
5274 (abort-recursive-edit))
5275 (current-prefix-arg
5276 nil)
5277 ((region-active-p)
5278 (deactivate-mark))
5279 ((> (recursion-depth) 0)
5280 (exit-recursive-edit))
5281 (buffer-quit-function
5282 (funcall buffer-quit-function))
5283 ((not (one-window-p t))
5284 (delete-other-windows))
5286 (bury-buffer))))
5288 (defun play-sound-file (file &optional volume device)
5289 "Play sound stored in FILE.
5290 VOLUME and DEVICE correspond to the keywords of the sound
5291 specification for `play-sound'."
5292 (interactive "fPlay sound file: ")
5293 (let ((sound (list :file file)))
5294 (if volume
5295 (plist-put sound :volume volume))
5296 (if device
5297 (plist-put sound :device device))
5298 (push 'sound sound)
5299 (play-sound sound)))
5301 \f
5302 (defcustom read-mail-command 'rmail
5303 "*Your preference for a mail reading package.
5304 This is used by some keybindings which support reading mail.
5305 See also `mail-user-agent' concerning sending mail."
5306 :type '(choice (function-item rmail)
5307 (function-item gnus)
5308 (function-item mh-rmail)
5309 (function :tag "Other"))
5310 :version "21.1"
5311 :group 'mail)
5313 (defcustom mail-user-agent 'sendmail-user-agent
5314 "*Your preference for a mail composition package.
5315 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
5316 outgoing email message. This variable lets you specify which
5317 mail-sending package you prefer.
5319 Valid values include:
5321 `sendmail-user-agent' -- use the default Emacs Mail package.
5322 See Info node `(emacs)Sending Mail'.
5323 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
5324 See Info node `(mh-e)'.
5325 `message-user-agent' -- use the Gnus Message package.
5326 See Info node `(message)'.
5327 `gnus-user-agent' -- like `message-user-agent', but with Gnus
5328 paraphernalia, particularly the Gcc: header for
5329 archiving.
5331 Additional valid symbols may be available; check with the author of
5332 your package for details. The function should return non-nil if it
5333 succeeds.
5335 See also `read-mail-command' concerning reading mail."
5336 :type '(radio (function-item :tag "Default Emacs mail"
5338 sendmail-user-agent)
5339 (function-item :tag "Emacs interface to MH"
5341 mh-e-user-agent)
5342 (function-item :tag "Gnus Message package"
5344 message-user-agent)
5345 (function-item :tag "Gnus Message with full Gnus features"
5347 gnus-user-agent)
5348 (function :tag "Other"))
5349 :group 'mail)
5351 (define-mail-user-agent 'sendmail-user-agent
5352 'sendmail-user-agent-compose
5353 'mail-send-and-exit)
5355 (defun rfc822-goto-eoh ()
5356 ;; Go to header delimiter line in a mail message, following RFC822 rules
5357 (goto-char (point-min))
5358 (when (re-search-forward
5360 (goto-char (match-beginning 0))))
5362 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
5363 switch-function yank-action
5364 send-actions)
5365 (if switch-function
5366 (let ((special-display-buffer-names nil)
5367 (special-display-regexps nil)
5368 (same-window-buffer-names nil)
5369 (same-window-regexps nil))
5370 (funcall switch-function "*mail*")))
5371 (let ((cc (cdr (assoc-string "cc" other-headers t)))
5372 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
5373 (body (cdr (assoc-string "body" other-headers t))))
5374 (or (mail continue to subject in-reply-to cc yank-action send-actions)
5375 continue
5376 (error "Message aborted"))
5377 (save-excursion
5378 (rfc822-goto-eoh)
5379 (while other-headers
5380 (unless (member-ignore-case (car (car other-headers))
5381 '("in-reply-to" "cc" "body"))
5382 (insert (car (car other-headers)) ": "
5383 (cdr (car other-headers))
5385 (setq other-headers (cdr other-headers)))
5386 (when body
5387 (forward-line 1)
5388 (insert body))
5389 t)))
5391 (defun compose-mail (&optional to subject other-headers continue
5392 switch-function yank-action send-actions)
5393 "Start composing a mail message to send.
5394 This uses the user's chosen mail composition package
5395 as selected with the variable `mail-user-agent'.
5396 The optional arguments TO and SUBJECT specify recipients
5397 and the initial Subject field, respectively.
5399 OTHER-HEADERS is an alist specifying additional
5400 header fields. Elements look like (HEADER . VALUE) where both
5401 HEADER and VALUE are strings.
5403 CONTINUE, if non-nil, says to continue editing a message already
5404 being composed.
5406 SWITCH-FUNCTION, if non-nil, is a function to use to
5407 switch to and display the buffer used for mail composition.
5409 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5410 to insert the raw text of the message being replied to.
5411 It has the form (FUNCTION . ARGS). The user agent will apply
5412 FUNCTION to ARGS, to insert the raw text of the original message.
5413 \(The user agent will also run `mail-citation-hook', *after* the
5414 original text has been inserted in this way.)
5416 SEND-ACTIONS is a list of actions to call when the message is sent.
5417 Each action has the form (FUNCTION . ARGS)."
5418 (interactive
5419 (list nil nil nil current-prefix-arg))
5420 (let ((function (get mail-user-agent 'composefunc)))
5421 (funcall function to subject other-headers continue
5422 switch-function yank-action send-actions)))
5424 (defun compose-mail-other-window (&optional to subject other-headers continue
5425 yank-action send-actions)
5427 (interactive
5428 (list nil nil nil current-prefix-arg))
5429 (compose-mail to subject other-headers continue
5430 'switch-to-buffer-other-window yank-action send-actions))
5433 (defun compose-mail-other-frame (&optional to subject other-headers continue
5434 yank-action send-actions)
5436 (interactive
5437 (list nil nil nil current-prefix-arg))
5438 (compose-mail to subject other-headers continue
5439 'switch-to-buffer-other-frame yank-action send-actions))
5440 \f
5441 (defvar set-variable-value-history nil
5442 "History of values entered with `set-variable'.
5444 Maximum length of the history list is determined by the value
5445 of `history-length', which see.")
5447 (defun set-variable (variable value &optional make-local)
5448 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5449 VARIABLE should be a user option variable name, a Lisp variable
5450 meant to be customized by users. You should enter VALUE in Lisp syntax,
5451 so if you want VALUE to be a string, you must surround it with doublequotes.
5452 VALUE is used literally, not evaluated.
5454 If VARIABLE has a `variable-interactive' property, that is used as if
5455 it were the arg to `interactive' (which see) to interactively read VALUE.
5457 If VARIABLE has been defined with `defcustom', then the type information
5458 in the definition is used to check that VALUE is valid.
5460 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5461 (interactive
5462 (let* ((default-var (variable-at-point))
5463 (var (if (user-variable-p default-var)
5464 (read-variable (format "Set variable (default %s): " default-var)
5465 default-var)
5466 (read-variable "Set variable: ")))
5467 (minibuffer-help-form '(describe-variable var))
5468 (prop (get var 'variable-interactive))
5469 (obsolete (car (get var 'byte-obsolete-variable)))
5470 (prompt (format "Set %s %s to value: " var
5471 (cond ((local-variable-p var)
5472 "(buffer-local)")
5473 ((or current-prefix-arg
5474 (local-variable-if-set-p var))
5475 "buffer-locally")
5476 (t "globally"))))
5477 (val (progn
5478 (when obsolete
5479 (message (concat "`%S' is obsolete; "
5480 (if (symbolp obsolete) "use `%S' instead" "%s"))
5481 var obsolete)
5482 (sit-for 3))
5483 (if prop
5484 ;; Use VAR's `variable-interactive' property
5485 ;; as an interactive spec for prompting.
5486 (call-interactively `(lambda (arg)
5487 (interactive ,prop)
5488 arg))
5489 (read
5490 (read-string prompt nil
5491 'set-variable-value-history
5492 (format "%S" (symbol-value var))))))))
5493 (list var val current-prefix-arg)))
5495 (and (custom-variable-p variable)
5496 (not (get variable 'custom-type))
5497 (custom-load-symbol variable))
5498 (let ((type (get variable 'custom-type)))
5499 (when type
5500 ;; Match with custom type.
5501 (require 'cus-edit)
5502 (setq type (widget-convert type))
5503 (unless (widget-apply type :match value)
5504 (error "Value `%S' does not match type %S of %S"
5505 value (car type) variable))))
5507 (if make-local
5508 (make-local-variable variable))
5510 (set variable value)
5512 ;; Force a thorough redisplay for the case that the variable
5513 ;; has an effect on the display, like `tab-width' has.
5514 (force-mode-line-update))
5515 \f
5516 ;; Define the major mode for lists of completions.
5518 (defvar completion-list-mode-map
5519 (let ((map (make-sparse-keymap)))
5520 (define-key map [mouse-2] 'mouse-choose-completion)
5521 (define-key map [follow-link] 'mouse-face)
5522 (define-key map [down-mouse-2] nil)
5523 (define-key map "\C-m" 'choose-completion)
5524 (define-key map "\e\e\e" 'delete-completion-window)
5525 (define-key map [left] 'previous-completion)
5526 (define-key map [right] 'next-completion)
5527 map)
5528 "Local map for completion list buffers.")
5530 ;; Completion mode is suitable only for specially formatted data.
5531 (put 'completion-list-mode 'mode-class 'special)
5533 (defvar completion-reference-buffer nil
5534 "Record the buffer that was current when the completion list was requested.
5535 This is a local variable in the completion list buffer.
5536 Initial value is nil to avoid some compiler warnings.")
5538 (defvar completion-no-auto-exit nil
5539 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5540 This also applies to other functions such as `choose-completion'
5541 and `mouse-choose-completion'.")
5543 (defvar completion-base-size nil
5544 "Number of chars before point not involved in completion.
5545 This is a local variable in the completion list buffer.
5546 It refers to the chars in the minibuffer if completing in the
5547 minibuffer, or in `completion-reference-buffer' otherwise.
5548 Only characters in the field at point are included.
5550 If nil, Emacs determines which part of the tail end of the
5551 buffer's text is involved in completion by comparing the text
5552 directly.")
5554 (defun delete-completion-window ()
5555 "Delete the completion list window.
5556 Go to the window from which completion was requested."
5557 (interactive)
5558 (let ((buf completion-reference-buffer))
5559 (if (one-window-p t)
5560 (if (window-dedicated-p (selected-window))
5561 (delete-frame (selected-frame)))
5562 (delete-window (selected-window))
5563 (if (get-buffer-window buf)
5564 (select-window (get-buffer-window buf))))))
5566 (defun previous-completion (n)
5567 "Move to the previous item in the completion list."
5568 (interactive "p")
5569 (next-completion (- n)))
5571 (defun next-completion (n)
5572 "Move to the next item in the completion list.
5573 With prefix argument N, move N items (negative N means move backward)."
5574 (interactive "p")
5575 (let ((beg (point-min)) (end (point-max)))
5576 (while (and (> n 0) (not (eobp)))
5577 ;; If in a completion, move to the end of it.
5578 (when (get-text-property (point) 'mouse-face)
5579 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5580 ;; Move to start of next one.
5581 (unless (get-text-property (point) 'mouse-face)
5582 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5583 (setq n (1- n)))
5584 (while (and (< n 0) (not (bobp)))
5585 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5586 ;; If in a completion, move to the start of it.
5587 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5588 (goto-char (previous-single-property-change
5589 (point) 'mouse-face nil beg)))
5590 ;; Move to end of the previous completion.
5591 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5592 (goto-char (previous-single-property-change
5593 (point) 'mouse-face nil beg)))
5594 ;; Move to the start of that one.
5595 (goto-char (previous-single-property-change
5596 (point) 'mouse-face nil beg))
5597 (setq n (1+ n))))))
5599 (defun choose-completion ()
5600 "Choose the completion that point is in or next to."
5601 (interactive)
5602 (let (beg end completion (buffer completion-reference-buffer)
5603 (base-size completion-base-size))
5604 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
5605 (setq end (point) beg (1+ (point))))
5606 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
5607 (setq end (1- (point)) beg (point)))
5608 (if (null beg)
5609 (error "No completion here"))
5610 (setq beg (previous-single-property-change beg 'mouse-face))
5611 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
5612 (setq completion (buffer-substring-no-properties beg end))
5613 (let ((owindow (selected-window)))
5614 (if (and (one-window-p t 'selected-frame)
5615 (window-dedicated-p owindow))
5616 ;; This is a special buffer's frame
5617 (iconify-frame (selected-frame))
5618 (or (window-dedicated-p (selected-window))
5619 (bury-buffer)))
5620 (select-window
5621 (or (and (buffer-live-p buffer)
5622 (get-buffer-window buffer))
5623 owindow)))
5624 (choose-completion-string completion buffer base-size)))
5626 ;; Delete the longest partial match for STRING
5627 ;; that can be found before POINT.
5628 (defun choose-completion-delete-max-match (string)
5629 (let ((opoint (point))
5630 len)
5631 ;; Try moving back by the length of the string.
5632 (goto-char (max (- (point) (length string))
5633 (minibuffer-prompt-end)))
5634 ;; See how far back we were actually able to move. That is the
5635 ;; upper bound on how much we can match and delete.
5636 (setq len (- opoint (point)))
5637 (if completion-ignore-case
5638 (setq string (downcase string)))
5639 (while (and (> len 0)
5640 (let ((tail (buffer-substring (point) opoint)))
5641 (if completion-ignore-case
5642 (setq tail (downcase tail)))
5643 (not (string= tail (substring string 0 len)))))
5644 (setq len (1- len))
5645 (forward-char 1))
5646 (delete-char len)))
5648 (defvar choose-completion-string-functions nil
5649 "Functions that may override the normal insertion of a completion choice.
5650 These functions are called in order with four arguments:
5651 CHOICE - the string to insert in the buffer,
5652 BUFFER - the buffer in which the choice should be inserted,
5653 MINI-P - non-nil if BUFFER is a minibuffer, and
5654 BASE-SIZE - the number of characters in BUFFER before
5655 the string being completed.
5657 If a function in the list returns non-nil, that function is supposed
5658 to have inserted the CHOICE in the BUFFER, and possibly exited
5659 the minibuffer; no further functions will be called.
5661 If all functions in the list return nil, that means to use
5662 the default method of inserting the completion in BUFFER.")
5664 (defun choose-completion-string (choice &optional buffer base-size)
5665 "Switch to BUFFER and insert the completion choice CHOICE.
5666 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
5667 to keep. If it is nil, we call `choose-completion-delete-max-match'
5668 to decide what to delete."
5670 ;; If BUFFER is the minibuffer, exit the minibuffer
5671 ;; unless it is reading a file name and CHOICE is a directory,
5672 ;; or completion-no-auto-exit is non-nil.
5674 (let* ((buffer (or buffer completion-reference-buffer))
5675 (mini-p (minibufferp buffer)))
5676 ;; If BUFFER is a minibuffer, barf unless it's the currently
5677 ;; active minibuffer.
5678 (if (and mini-p
5679 (or (not (active-minibuffer-window))
5680 (not (equal buffer
5681 (window-buffer (active-minibuffer-window))))))
5682 (error "Minibuffer is not active for completion")
5683 ;; Set buffer so buffer-local choose-completion-string-functions works.
5684 (set-buffer buffer)
5685 (unless (run-hook-with-args-until-success
5686 'choose-completion-string-functions
5687 choice buffer mini-p base-size)
5688 ;; Insert the completion into the buffer where it was requested.
5689 ;; FIXME:
5690 ;; - There may not be a field at point, or there may be a field but
5691 ;; it's not a "completion field", in which case we have to
5692 ;; call choose-completion-delete-max-match even if base-size is set.
5693 ;; - we may need to delete further than (point) to (field-end),
5694 ;; depending on the completion-style, and for that we need to
5695 ;; extra data `completion-extra-size'.
5696 (if base-size
5697 (delete-region (+ base-size (field-beginning)) (point))
5698 (choose-completion-delete-max-match choice))
5699 (insert choice)
5700 (remove-text-properties (- (point) (length choice)) (point)
5701 '(mouse-face nil))
5702 ;; Update point in the window that BUFFER is showing in.
5703 (let ((window (get-buffer-window buffer t)))
5704 (set-window-point window (point)))
5705 ;; If completing for the minibuffer, exit it with this choice.
5706 (and (not completion-no-auto-exit)
5707 (minibufferp buffer)
5708 minibuffer-completion-table
5709 ;; If this is reading a file name, and the file name chosen
5710 ;; is a directory, don't exit the minibuffer.
5711 (if (and minibuffer-completing-file-name
5712 (file-directory-p (field-string (point-max))))
5713 (let ((mini (active-minibuffer-window)))
5714 (select-window mini)
5715 (when minibuffer-auto-raise
5716 (raise-frame (window-frame mini))))
5717 (exit-minibuffer)))))))
5719 (define-derived-mode completion-list-mode nil "Completion List"
5720 "Major mode for buffers showing lists of possible completions.
5722 to select the completion near point.
5724 with the mouse.
5727 (set (make-local-variable 'completion-base-size) nil))
5729 (defun completion-list-mode-finish ()
5730 "Finish setup of the completions buffer.
5731 Called from `temp-buffer-show-hook'."
5732 (when (eq major-mode 'completion-list-mode)
5733 (toggle-read-only 1)))
5735 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
5738 ;; Variables and faces used in `completion-setup-function'.
5740 (defcustom completion-show-help t
5741 "Non-nil means show help message in *Completions* buffer."
5742 :type 'boolean
5743 :version "22.1"
5744 :group 'completion)
5746 ;; This is for packages that need to bind it to a non-default regexp
5747 ;; in order to make the first-differing character highlight work
5748 ;; to their liking
5749 (defvar completion-root-regexp "^/"
5750 "Regexp to use in `completion-setup-function' to find the root directory.")
5752 ;; This function goes in completion-setup-hook, so that it is called
5753 ;; after the text of the completion list buffer is written.
5754 (defun completion-setup-function ()
5755 (let* ((mainbuf (current-buffer))
5756 (mbuf-contents (minibuffer-completion-contents))
5757 common-string-length)
5758 ;; When reading a file name in the minibuffer,
5759 ;; set default-directory in the minibuffer
5760 ;; so it will get copied into the completion list buffer.
5761 (if minibuffer-completing-file-name
5762 (with-current-buffer mainbuf
5763 (setq default-directory
5764 (file-name-directory (expand-file-name mbuf-contents)))))
5765 (with-current-buffer standard-output
5766 (let ((base-size completion-base-size)) ;Read before killing localvars.
5767 (completion-list-mode)
5768 (set (make-local-variable 'completion-base-size) base-size))
5769 (set (make-local-variable 'completion-reference-buffer) mainbuf)
5770 (unless completion-base-size
5771 ;; This may be needed for old completion packages which don't use
5772 ;; completion-all-completions-with-base-size yet.
5773 (setq completion-base-size
5774 (cond
5775 (minibuffer-completing-file-name
5776 ;; For file name completion, use the number of chars before
5777 ;; the start of the file name component at point.
5778 (with-current-buffer mainbuf
5779 (save-excursion
5780 (skip-chars-backward completion-root-regexp)
5781 (- (point) (minibuffer-prompt-end)))))
5782 (minibuffer-completing-symbol nil)
5783 ;; Otherwise, in minibuffer, the base size is 0.
5784 ((minibufferp mainbuf) 0))))
5785 ;; Maybe insert help string.
5786 (when completion-show-help
5787 (goto-char (point-min))
5788 (if (display-mouse-p)
5789 (insert (substitute-command-keys
5791 (insert (substitute-command-keys
5795 (add-hook 'completion-setup-hook 'completion-setup-function)
5797 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5798 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
5800 (defun switch-to-completions ()
5801 "Select the completion list window."
5802 (interactive)
5803 ;; Make sure we have a completions window.
5804 (or (get-buffer-window "*Completions*")
5805 (minibuffer-completion-help))
5806 (let ((window (get-buffer-window "*Completions*")))
5807 (when window
5808 (select-window window)
5809 (goto-char (point-min))
5811 (forward-line 1))))
5812 \f
5813 ;;; Support keyboard commands to turn on various modifiers.
5815 ;; These functions -- which are not commands -- each add one modifier
5816 ;; to the following event.
5818 (defun event-apply-alt-modifier (ignore-prompt)
5821 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5822 (defun event-apply-super-modifier (ignore-prompt)
5825 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5826 (defun event-apply-hyper-modifier (ignore-prompt)
5829 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5830 (defun event-apply-shift-modifier (ignore-prompt)
5833 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5834 (defun event-apply-control-modifier (ignore-prompt)
5837 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5838 (defun event-apply-meta-modifier (ignore-prompt)
5841 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5843 (defun event-apply-modifier (event symbol lshiftby prefix)
5844 "Apply a modifier flag to event EVENT.
5845 SYMBOL is the name of this modifier, as a symbol.
5846 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5847 PREFIX is the string that represents this modifier in an event type symbol."
5848 (if (numberp event)
5849 (cond ((eq symbol 'control)
5850 (if (and (<= (downcase event) ?z)
5851 (>= (downcase event) ?a))
5852 (- (downcase event) ?a -1)
5853 (if (and (<= (downcase event) ?Z)
5854 (>= (downcase event) ?A))
5855 (- (downcase event) ?A -1)
5856 (logior (lsh 1 lshiftby) event))))
5857 ((eq symbol 'shift)
5858 (if (and (<= (downcase event) ?z)
5859 (>= (downcase event) ?a))
5860 (upcase event)
5861 (logior (lsh 1 lshiftby) event)))
5862 (t
5863 (logior (lsh 1 lshiftby) event)))
5864 (if (memq symbol (event-modifiers event))
5865 event
5866 (let ((event-type (if (symbolp event) event (car event))))
5867 (setq event-type (intern (concat prefix (symbol-name event-type))))
5868 (if (symbolp event)
5869 event-type
5870 (cons event-type (cdr event)))))))
5872 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5873 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5874 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5875 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5876 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5877 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5878 \f
5879 ;;;; Keypad support.
5881 ;; Make the keypad keys act like ordinary typing keys. If people add
5882 ;; bindings for the function key symbols, then those bindings will
5883 ;; override these, so this shouldn't interfere with any existing
5884 ;; bindings.
5886 ;; Also tell read-char how to handle these keys.
5887 (mapc
5888 (lambda (keypad-normal)
5889 (let ((keypad (nth 0 keypad-normal))
5890 (normal (nth 1 keypad-normal)))
5891 (put keypad 'ascii-character normal)
5892 (define-key function-key-map (vector keypad) (vector normal))))
5893 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5894 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5895 (kp-space ?\s)
5898 (kp-multiply ?*)
5899 (kp-add ?+)
5900 (kp-separator ?,)
5901 (kp-subtract ?-)
5902 (kp-decimal ?.)
5903 (kp-divide ?/)
5904 (kp-equal ?=)))
5905 \f
5906 ;;;;
5907 ;;;; forking a twin copy of a buffer.
5908 ;;;;
5910 (defvar clone-buffer-hook nil
5911 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5913 (defvar clone-indirect-buffer-hook nil
5914 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
5916 (defun clone-process (process &optional newname)
5917 "Create a twin copy of PROCESS.
5918 If NEWNAME is nil, it defaults to PROCESS' name;
5919 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5920 If PROCESS is associated with a buffer, the new process will be associated
5921 with the current buffer instead.
5922 Returns nil if PROCESS has already terminated."
5923 (setq newname (or newname (process-name process)))
5925 (setq newname (substring newname 0 (match-beginning 0))))
5926 (when (memq (process-status process) '(run stop open))
5927 (let* ((process-connection-type (process-tty-name process))
5928 (new-process
5929 (if (memq (process-status process) '(open))
5930 (let ((args (process-contact process t)))
5931 (setq args (plist-put args :name newname))
5932 (setq args (plist-put args :buffer
5933 (if (process-buffer process)
5934 (current-buffer))))
5935 (apply 'make-network-process args))
5936 (apply 'start-process newname
5937 (if (process-buffer process) (current-buffer))
5938 (process-command process)))))
5939 (set-process-query-on-exit-flag
5940 new-process (process-query-on-exit-flag process))
5941 (set-process-inherit-coding-system-flag
5942 new-process (process-inherit-coding-system-flag process))
5943 (set-process-filter new-process (process-filter process))
5944 (set-process-sentinel new-process (process-sentinel process))
5945 (set-process-plist new-process (copy-sequence (process-plist process)))
5946 new-process)))
5948 ;; things to maybe add (currently partly covered by `funcall mode'):
5949 ;; - syntax-table
5950 ;; - overlays
5951 (defun clone-buffer (&optional newname display-flag)
5952 "Create and return a twin copy of the current buffer.
5953 Unlike an indirect buffer, the new buffer can be edited
5954 independently of the old one (if it is not read-only).
5955 NEWNAME is the name of the new buffer. It may be modified by
5956 adding or incrementing <N> at the end as necessary to create a
5957 unique buffer name. If nil, it defaults to the name of the
5958 current buffer, with the proper suffix. If DISPLAY-FLAG is
5959 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5960 clone a file-visiting buffer, or a buffer whose major mode symbol
5961 has a non-nil `no-clone' property, results in an error.
5963 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5964 current buffer with appropriate suffix. However, if a prefix
5965 argument is given, then the command prompts for NEWNAME in the
5966 minibuffer.
5968 This runs the normal hook `clone-buffer-hook' in the new buffer
5969 after it has been set up properly in other respects."
5970 (interactive
5971 (progn
5972 (if buffer-file-name
5973 (error "Cannot clone a file-visiting buffer"))
5974 (if (get major-mode 'no-clone)
5975 (error "Cannot clone a buffer in %s mode" mode-name))
5976 (list (if current-prefix-arg
5977 (read-buffer "Name of new cloned buffer: " (current-buffer)))
5978 t)))
5979 (if buffer-file-name
5980 (error "Cannot clone a file-visiting buffer"))
5981 (if (get major-mode 'no-clone)
5982 (error "Cannot clone a buffer in %s mode" mode-name))
5983 (setq newname (or newname (buffer-name)))
5985 (setq newname (substring newname 0 (match-beginning 0))))
5986 (let ((buf (current-buffer))
5987 (ptmin (point-min))
5988 (ptmax (point-max))
5989 (pt (point))
5990 (mk (if mark-active (mark t)))
5991 (modified (buffer-modified-p))
5992 (mode major-mode)
5993 (lvars (buffer-local-variables))
5994 (process (get-buffer-process (current-buffer)))
5995 (new (generate-new-buffer (or newname (buffer-name)))))
5996 (save-restriction
5997 (widen)
5998 (with-current-buffer new
5999 (insert-buffer-substring buf)))
6000 (with-current-buffer new
6001 (narrow-to-region ptmin ptmax)
6002 (goto-char pt)
6003 (if mk (set-mark mk))
6004 (set-buffer-modified-p modified)
6006 ;; Clone the old buffer's process, if any.
6007 (when process (clone-process process))
6009 ;; Now set up the major mode.
6010 (funcall mode)
6012 ;; Set up other local variables.
6013 (mapc (lambda (v)
6014 (condition-case () ;in case var is read-only
6015 (if (symbolp v)
6016 (makunbound v)
6017 (set (make-local-variable (car v)) (cdr v)))
6018 (error nil)))
6019 lvars)
6021 ;; Run any hooks (typically set up by the major mode
6022 ;; for cloning to work properly).
6023 (run-hooks 'clone-buffer-hook))
6024 (if display-flag
6025 ;; Presumably the current buffer is shown in the selected frame, so
6026 ;; we want to display the clone elsewhere.
6027 (let ((same-window-regexps nil)
6028 (same-window-buffer-names))
6029 (pop-to-buffer new)))
6030 new))
6033 (defun clone-indirect-buffer (newname display-flag &optional norecord)
6034 "Create an indirect buffer that is a twin copy of the current buffer.
6036 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
6037 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
6038 or if not called with a prefix arg, NEWNAME defaults to the current
6039 buffer's name. The name is modified by adding a `<N>' suffix to it
6040 or by incrementing the N in an existing suffix.
6042 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
6043 This is always done when called interactively.
6045 Optional third arg NORECORD non-nil means do not put this buffer at the
6046 front of the list of recently selected ones."
6047 (interactive
6048 (progn
6049 (if (get major-mode 'no-clone-indirect)
6050 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6051 (list (if current-prefix-arg
6052 (read-buffer "Name of indirect buffer: " (current-buffer)))
6053 t)))
6054 (if (get major-mode 'no-clone-indirect)
6055 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6056 (setq newname (or newname (buffer-name)))
6058 (setq newname (substring newname 0 (match-beginning 0))))
6059 (let* ((name (generate-new-buffer-name newname))
6060 (buffer (make-indirect-buffer (current-buffer) name t)))
6061 (with-current-buffer buffer
6062 (run-hooks 'clone-indirect-buffer-hook))
6063 (when display-flag
6064 (pop-to-buffer buffer norecord))
6065 buffer))
6068 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
6069 "Like `clone-indirect-buffer' but display in another window."
6070 (interactive
6071 (progn
6072 (if (get major-mode 'no-clone-indirect)
6073 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
6074 (list (if current-prefix-arg
6075 (read-buffer "Name of indirect buffer: " (current-buffer)))
6076 t)))
6077 (let ((pop-up-windows t))
6078 (clone-indirect-buffer newname display-flag norecord)))
6080 \f
6081 ;;; Handling of Backspace and Delete keys.
6083 (defcustom normal-erase-is-backspace 'maybe
6084 "Set the default behavior of the Delete and Backspace keys.
6086 If set to t, Delete key deletes forward and Backspace key deletes
6087 backward.
6089 If set to nil, both Delete and Backspace keys delete backward.
6091 If set to 'maybe (which is the default), Emacs automatically
6092 selects a behavior. On window systems, the behavior depends on
6093 the keyboard used. If the keyboard has both a Backspace key and
6094 a Delete key, and both are mapped to their usual meanings, the
6095 option's default value is set to t, so that Backspace can be used
6096 to delete backward, and Delete can be used to delete forward.
6098 If not running under a window system, customizing this option
6099 accomplishes a similar effect by mapping C-h, which is usually
6100 generated by the Backspace key, to DEL, and by mapping DEL to C-d
6101 via `keyboard-translate'. The former functionality of C-h is
6102 available on the F1 key. You should probably not use this
6103 setting if you don't have both Backspace, Delete and F1 keys.
6105 Setting this variable with setq doesn't take effect. Programmatically,
6106 call `normal-erase-is-backspace-mode' (which see) instead."
6107 :type '(choice (const :tag "Off" nil)
6108 (const :tag "Maybe" maybe)
6109 (other :tag "On" t))
6110 :group 'editing-basics
6111 :version "21.1"
6112 :set (lambda (symbol value)
6113 ;; The fboundp is because of a problem with :set when
6114 ;; dumping Emacs. It doesn't really matter.
6115 (if (fboundp 'normal-erase-is-backspace-mode)
6116 (normal-erase-is-backspace-mode (or value 0))
6117 (set-default symbol value))))
6119 (defun normal-erase-is-backspace-setup-frame (&optional frame)
6120 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
6121 (unless frame (setq frame (selected-frame)))
6122 (with-selected-frame frame
6123 (unless (terminal-parameter nil 'normal-erase-is-backspace)
6124 (normal-erase-is-backspace-mode
6125 (if (if (eq normal-erase-is-backspace 'maybe)
6126 (and (not noninteractive)
6127 (or (memq system-type '(ms-dos windows-nt))
6128 (and (memq window-system '(x))
6129 (fboundp 'x-backspace-delete-keys-p)
6130 (x-backspace-delete-keys-p))
6131 ;; If the terminal Emacs is running on has erase char
6132 ;; set to ^H, use the Backspace key for deleting
6133 ;; backward, and the Delete key for deleting forward.
6134 (and (null window-system)
6135 (eq tty-erase-char ?\^H))))
6136 normal-erase-is-backspace)
6137 1 0)))))
6139 (defun normal-erase-is-backspace-mode (&optional arg)
6140 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
6142 With numeric arg, turn the mode on if and only if ARG is positive.
6144 On window systems, when this mode is on, Delete is mapped to C-d
6145 and Backspace is mapped to DEL; when this mode is off, both
6146 Delete and Backspace are mapped to DEL. (The remapping goes via
6147 `local-function-key-map', so binding Delete or Backspace in the
6148 global or local keymap will override that.)
6150 In addition, on window systems, the bindings of C-Delete, M-Delete,
6151 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
6152 the global keymap in accordance with the functionality of Delete and
6153 Backspace. For example, if Delete is remapped to C-d, which deletes
6154 forward, C-Delete is bound to `kill-word', but if Delete is remapped
6155 to DEL, which deletes backward, C-Delete is bound to
6156 `backward-kill-word'.
6158 If not running on a window system, a similar effect is accomplished by
6159 remapping C-h (normally produced by the Backspace key) and DEL via
6160 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
6161 to C-d; if it's off, the keys are not remapped.
6163 When not running on a window system, and this mode is turned on, the
6164 former functionality of C-h is available on the F1 key. You should
6165 probably not turn on this mode on a text-only terminal if you don't
6166 have both Backspace, Delete and F1 keys.
6168 See also `normal-erase-is-backspace'."
6169 (interactive "P")
6170 (let ((enabled (or (and arg (> (prefix-numeric-value arg) 0))
6171 (and (not arg)
6172 (not (eq 1 (terminal-parameter
6173 nil 'normal-erase-is-backspace)))))))
6174 (set-terminal-parameter nil 'normal-erase-is-backspace
6175 (if enabled 1 0))
6177 (cond ((or (memq window-system '(x w32 ns pc))
6178 (memq system-type '(ms-dos windows-nt)))
6179 (let* ((bindings
6180 `(([C-delete] [C-backspace])
6181 ([M-delete] [M-backspace])
6182 ([C-M-delete] [C-M-backspace])
6183 (,esc-map
6184 [C-delete] [C-backspace])))
6185 (old-state (lookup-key local-function-key-map [delete])))
6187 (if enabled
6188 (progn
6189 (define-key local-function-key-map [delete] [?\C-d])
6190 (define-key local-function-key-map [kp-delete] [?\C-d])
6191 (define-key local-function-key-map [backspace] [?\C-?]))
6192 (define-key local-function-key-map [delete] [?\C-?])
6193 (define-key local-function-key-map [kp-delete] [?\C-?])
6194 (define-key local-function-key-map [backspace] [?\C-?]))
6196 ;; Maybe swap bindings of C-delete and C-backspace, etc.
6197 (unless (equal old-state (lookup-key local-function-key-map [delete]))
6198 (dolist (binding bindings)
6199 (let ((map global-map))
6200 (when (keymapp (car binding))
6201 (setq map (car binding) binding (cdr binding)))
6202 (let* ((key1 (nth 0 binding))
6203 (key2 (nth 1 binding))
6204 (binding1 (lookup-key map key1))
6205 (binding2 (lookup-key map key2)))
6206 (define-key map key1 binding2)
6207 (define-key map key2 binding1)))))))
6208 (t
6209 (if enabled
6210 (progn
6211 (keyboard-translate ?\C-h ?\C-?)
6212 (keyboard-translate ?\C-? ?\C-d))
6213 (keyboard-translate ?\C-h ?\C-h)
6214 (keyboard-translate ?\C-? ?\C-?))))
6216 (run-hooks 'normal-erase-is-backspace-hook)
6217 (if (interactive-p)
6218 (message "Delete key deletes %s"
6219 (if (terminal-parameter nil 'normal-erase-is-backspace)
6220 "forward" "backward")))))
6221 \f
6222 (defvar vis-mode-saved-buffer-invisibility-spec nil
6223 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
6225 (define-minor-mode visible-mode
6226 "Toggle Visible mode.
6227 With argument ARG turn Visible mode on if ARG is positive, otherwise
6228 turn it off.
6230 Enabling Visible mode makes all invisible text temporarily visible.
6231 Disabling Visible mode turns off that effect. Visible mode
6232 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
6233 :lighter " Vis"
6234 :group 'editing-basics
6235 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
6236 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
6237 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
6238 (when visible-mode
6239 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
6240 buffer-invisibility-spec)
6241 (setq buffer-invisibility-spec nil)))
6242 \f
6243 ;; Minibuffer prompt stuff.
6245 ;(defun minibuffer-prompt-modification (start end)
6246 ; (error "You cannot modify the prompt"))
6247 ;
6248 ;
6249 ;(defun minibuffer-prompt-insertion (start end)
6250 ; (let ((inhibit-modification-hooks t))
6251 ; (delete-region start end)
6252 ; ;; Discard undo information for the text insertion itself
6253 ; ;; and for the text deletion.above.
6254 ; (when (consp buffer-undo-list)
6255 ; (setq buffer-undo-list (cddr buffer-undo-list)))
6256 ; (message "You cannot modify the prompt")))
6257 ;
6258 ;
6259 ;(setq minibuffer-prompt-properties
6260 ; (list 'modification-hooks '(minibuffer-prompt-modification)
6261 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
6262 ;
6264 \f
6265 ;;;; Problematic external packages.
6267 ;; rms says this should be done by specifying symbols that define
6268 ;; versions together with bad values. This is therefore not as
6269 ;; flexible as it could be. See the thread:
6270 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
6271 (defconst bad-packages-alist
6272 ;; Not sure exactly which semantic versions have problems.
6273 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
6275 "The version of `semantic' loaded does not work in Emacs 22.
6276 It can cause constant high CPU load.
6277 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
6278 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
6279 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
6280 ;; provided the `CUA-mode' feature. Since this is no longer true,
6281 ;; we can warn the user if the `CUA-mode' feature is ever provided.
6282 (CUA-mode t nil
6283 "CUA-mode is now part of the standard GNU Emacs distribution,
6284 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
6286 You have loaded an older version of CUA-mode which does not work
6287 correctly with this version of Emacs. You should remove the old
6288 version and use the one distributed with Emacs."))
6289 "Alist of packages known to cause problems in this version of Emacs.
6290 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
6291 PACKAGE is either a regular expression to match file names, or a
6292 symbol (a feature name); see the documentation of
6293 `after-load-alist', to which this variable adds functions.
6294 SYMBOL is either the name of a string variable, or `t'. Upon
6295 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
6296 warning using STRING as the message.")
6298 (defun bad-package-check (package)
6299 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
6300 (condition-case nil
6301 (let* ((list (assoc package bad-packages-alist))
6302 (symbol (nth 1 list)))
6303 (and list
6304 (boundp symbol)
6305 (or (eq symbol t)
6306 (and (stringp (setq symbol (eval symbol)))
6307 (string-match (nth 2 list) symbol)))
6308 (display-warning :warning (nth 3 list))))
6309 (error nil)))
6311 (mapc (lambda (elem)
6312 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
6313 bad-packages-alist)
6316 (provide 'simple)
6318 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
6319 ;;; simple.el ends here