| blob | 7082c7c4cdd545ae3852f1c87b911867eb3127fd |
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
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, or (at your option)
15 ;; 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; A grab-bag of basic Emacs commands not specifically related to some
30 ;; major mode or to file-handling.
32 ;;; Code:
41 "*Idle time delay before updating various things on the screen.
42 Various Emacs features that update auxiliary information when point moves
43 wait this many seconds after Emacs becomes idle before doing an update."
49 "Killing and yanking commands."
53 "Highlight (un)matching of parens and expressions."
57 "Search LIST for a valid buffer to display in FRAME.
58 Return nil when all buffers in LIST are undesirable for display,
59 otherwise return the first suitable buffer in LIST.
61 Buffers not visible in windows are preferred to visible buffers,
62 unless VISIBLE-OK is non-nil.
63 If the optional argument FRAME is nil, it defaults to the selected frame.
64 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
65 ;; This logic is more or less copied from other-buffer.
68 found buf)
81 "Return the last non-hidden displayable buffer in the buffer list.
82 If BUFFER is non-nil, last-buffer will ignore that buffer.
83 Buffers not visible in windows are preferred to visible buffers,
84 unless optional argument VISIBLE-OK is non-nil.
85 If the optional third argument FRAME is non-nil, use that frame's
86 buffer list instead of the selected frame's buffer list.
87 If no other buffer exists, the buffer `*scratch*' is returned."
90 buffer visible-ok frame)
95 "Switch to the next buffer in cyclic order."
102 "Switch to the previous buffer in cyclic order."
106 \f
107 ;;; next-error support framework
110 "`next-error' support framework."
116 "Face used to highlight next error locus."
121 "*Highlighting of locations in selected source buffers.
122 If a number, highlight the locus in `next-error' face for the given time
123 in seconds, or until the next command is executed.
124 If t, highlight the locus until the next command is executed, or until
125 some other locus replaces it.
126 If nil, don't highlight the locus in the source buffer.
127 If `fringe-arrow', indicate the locus by the fringe arrow."
136 "*Highlighting of locations in `next-error-no-select'.
137 If number, highlight the locus in `next-error' face for given time in seconds.
138 If t, highlight the locus indefinitely until some other locus replaces it.
139 If nil, don't highlight the locus in the source buffer.
140 If `fringe-arrow', indicate the locus by the fringe arrow."
149 "*Display the line in the visited source file recentered as specified.
150 If non-nil, the value is passed directly to `recenter'."
158 "*List of hook functions run by `next-error' after visiting source file."
169 "The most recent `next-error' buffer.
170 A buffer becomes most recent when its compilation, grep, or
175 "Function to use to find the next error in the current buffer.
176 The function is called with 2 parameters:
177 ARG is an integer specifying by how many errors to move.
178 RESET is a boolean which, if non-nil, says to go back to the beginning
179 of the errors before moving.
180 Major modes providing compile-like functionality should set this variable
181 to indicate to `next-error' that this is a candidate buffer and how
187 &optional avoid-current
188 extra-test-inclusive
189 extra-test-exclusive)
190 "Test if BUFFER is a `next-error' capable buffer.
192 If AVOID-CURRENT is non-nil, treat the current buffer
193 as an absolute last resort only.
195 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
196 that normally would not qualify. If it returns t, the buffer
197 in question is treated as usable.
199 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
200 that would normally be considered usable. If it returns nil,
201 that buffer is rejected."
206 ;; Optionally reject some buffers.
209 t)
210 ;; Optionally accept some other buffers.
215 extra-test-inclusive
216 extra-test-exclusive)
217 "Return a `next-error' capable buffer.
219 If AVOID-CURRENT is non-nil, treat the current buffer
220 as an absolute last resort only.
222 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
223 that normally would not qualify. If it returns t, the buffer
224 in question is treated as usable.
226 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
227 that would normally be considered usable. If it returns nil,
228 that buffer is rejected."
230 ;; 1. If one window on the selected frame displays such buffer, return it.
236 avoid-current
237 extra-test-inclusive extra-test-exclusive)
242 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
245 extra-test-inclusive extra-test-exclusive))
246 next-error-last-buffer)
247 ;; 3. If the current buffer is acceptable, choose it.
249 extra-test-inclusive extra-test-exclusive)
251 ;; 4. Look for any acceptable buffer.
256 extra-test-inclusive extra-test-exclusive)))
259 ;; 5. Use the current buffer as a last resort if it qualifies,
260 ;; even despite AVOID-CURRENT.
263 extra-test-inclusive extra-test-exclusive)
267 ;; 6. Give up.
271 "Visit next `next-error' message and corresponding source code.
273 If all the error messages parsed so far have been processed already,
274 the message buffer is checked for new ones.
276 A prefix ARG specifies how many error messages to move;
277 negative means move back to previous error messages.
279 and start at the first error.
281 The RESET argument specifies that we should restart from the beginning.
284 compilation, grep, or occur buffer. It can also operate on any
286 more generally, on any buffer in Compilation mode or with
287 Compilation Minor mode enabled, or any buffer in which
288 `next-error-function' is bound to an appropriate function.
289 To specify use of a particular buffer for error messages, type
291 in the current frame.
294 runs `next-error-hook' with `run-hooks', and stays with that buffer
295 until you use it in some other buffer which uses Compilation mode
296 or Compilation Minor mode.
298 See variables `compilation-parse-errors-function' and
299 \`compilation-error-regexp-alist' for customization ideas."
303 ;; we know here that next-error-function is a valid symbol we can funcall
311 "Visit the source code corresponding to the `next-error' message at point."
313 ;; we know here that next-error-function is a valid symbol we can funcall
324 "Visit previous `next-error' message and corresponding source code.
326 Prefix arg N says how many error messages to move backwards (or
327 forwards, if negative).
334 "Restart at the first error.
335 Visit corresponding source code.
336 With prefix arg N, visit the source code of the Nth error.
342 "Move point to the next error in the `next-error' buffer and highlight match.
343 Prefix arg N says how many error messages to move forwards (or
344 backwards, if negative).
346 select the source buffer."
353 "Move point to the previous error in the `next-error' buffer and highlight match.
354 Prefix arg N says how many error messages to move backwards (or
355 forwards, if negative).
357 select the source buffer."
361 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
365 "Minor mode for compilation, occur and diff modes.
366 When turned on, cursor motion in the compilation, grep, occur or diff
367 buffer causes automatic display of the corresponding source code
368 location."
375 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
376 ;;; for the *Compilation* *grep* and *Occur* buffers.
386 \f
387 ;;;
390 "Major mode not specialized for anything in particular.
391 Other major modes are defined by comparison with this one."
397 ;; Making and deleting lines.
402 "Insert a newline, and move to left margin of the new line if it's blank.
403 If `use-hard-newlines' is non-nil, the newline is marked with the
404 text-property `hard'.
405 With ARG, insert that many newlines.
406 Call `auto-fill-function' if the current column number is greater
407 than the value of `fill-column' and ARG is nil."
410 ;; Inserting a newline at the end of a line produces better redisplay in
411 ;; try_window_id than inserting at the beginning of a line, and the textual
412 ;; result is the same. So, if we're at beginning of line, pretend to be at
413 ;; the end of the previous line.
416 ;; Make sure no functions want to be told about
417 ;; the range of the changes.
420 ;; Make sure there are no markers here.
423 ;; Make sure no text properties want to know
424 ;; where the change was.
429 ;; Make sure the newline before point isn't intangible.
431 ;; Make sure the newline before point isn't read-only.
433 ;; Make sure the newline before point isn't invisible.
435 ;; Make sure the newline before point has the same
436 ;; properties as the char before it (if any).
443 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
444 ;; Set last-command-char to tell self-insert what to insert.
446 ;; Don't auto-fill if we have a numeric argument.
447 ;; Also not if flag is true (it would fill wrong line);
448 ;; there is no need to since we're at BOL.
452 ;; If we get an error in self-insert-command, put point at right place.
454 ;; Even if we did *not* get an error, keep that forward-char;
455 ;; all further processing should apply to the newline that the user
456 ;; thinks he inserted.
458 ;; Mark the newline(s) `hard'.
462 ;; If the newline leaves the previous line blank,
463 ;; and we have a left margin, delete that from the blank line.
471 ;; Indent the line after the newline, except in one case:
472 ;; when we added the newline at the beginning of a line
473 ;; which starts a page.
476 nil)
481 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
487 "Insert a newline and leave point before it.
488 If there is a fill prefix and/or a `left-margin', insert them
489 on the new line if the line would have been blank.
490 With arg N, insert N newlines."
495 ;; Don't expand an abbrev before point.
509 "Split current line, moving portion beyond point vertically down.
510 If the current line starts with `fill-prefix', insert it on the new
511 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
513 When called from Lisp code, ARG may be a prefix string to copy."
518 ;; What prefix should we check for (nil means don't).
522 ;; Does this line start with it?
533 "Join this line to previous and fix up whitespace at join.
534 If there is a fill prefix, delete it from the beginning of this line.
535 With argument, join this line to following line."
542 ;; If the second line started with the fill prefix,
543 ;; delete the prefix.
555 "On blank line, delete all surrounding blank lines, leaving just one.
556 On isolated blank line, delete that one.
557 On nonblank line, delete any immediately following blank lines."
563 ;; Set singleblank if there is just one blank line here.
570 ;; Delete preceding blank lines, and this one too if it's the only one.
579 ;; Delete following blank lines, unless the current line is blank
580 ;; and there are no following blank lines.
589 ;; Handle the special case where point is followed by newline and eob.
590 ;; Delete the line, leaving point at eob.
595 "Delete all the trailing whitespace across the current buffer.
596 All whitespace after the last non-whitespace character in a line is deleted.
598 A formfeed is not considered whitespace by this function."
605 ;; Don't delete formfeeds, even if they are considered whitespace.
612 "Insert a newline, then indent according to major mode.
613 Indentation is done using the value of `indent-line-function'.
614 In programming language modes, this is the same as TAB.
615 In some text modes, where TAB inserts a tab, this command indents to the
616 column specified by the function `current-left-margin'."
623 "Reindent current line, insert newline, then indent the new line.
624 Indentation of both lines is done according to the current major mode,
625 which means calling the current value of `indent-line-function'.
626 In programming language modes, this is the same as TAB.
627 In some text modes, where TAB inserts a tab, this indents to the
628 column specified by the function `current-left-margin'."
631 ;; Be careful to insert the newline before indenting the line.
632 ;; Otherwise, the indentation might be wrong.
636 ;; We are at EOL before the call to indent-according-to-mode, and
637 ;; after it we usually are as well, but not always. We tried to
638 ;; address it with `save-excursion' but that uses a normal marker
639 ;; whereas we need `move after insertion', so we do the save/restore
640 ;; by hand.
644 ;; Remove the trailing white-space after indentation because
645 ;; indentation may introduce the whitespace.
650 "Read next input character and insert it.
651 This is useful for inserting control characters.
653 If the first character you type after this command is an octal digit,
654 you should type a sequence of octal digits which specify a character code.
655 Any nondigit terminates the sequence. If the terminator is a RET,
656 it is discarded; any other terminator is used itself as input.
657 The variable `read-quoted-char-radix' specifies the radix for this feature;
658 set it to 10 or 16 to use decimal or hex instead of octal.
660 In overwrite mode, this function inserts the character anyway, and
661 does not handle octal digits specially. This means that if you use
662 overwrite as your normal editing mode, you can use this function to
663 insert characters when necessary.
665 In binary overwrite mode, this function does overwrite, and octal
666 digits are interpreted as a character code. This is intended to be
667 useful for editing binary files."
674 ;; Assume character codes 0240 - 0377 stand for characters in some
675 ;; single-byte character set, and convert them to Emacs
676 ;; characters.
689 "Move forward ARG lines and position at first nonblank character."
695 "Move backward ARG lines and position at first nonblank character."
701 "Move point to the first non-whitespace character on this line."
705 ;; Move back over chars that have whitespace syntax but have the p flag.
709 "Fixup white space between objects around point.
710 Leave one space or none, according to the context."
717 nil
721 "Delete all spaces and tabs around point.
722 If BACKWARD-ONLY is non-nil, only delete them before point."
727 orig-pos
736 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
750 \f
752 "Move point to the beginning of the buffer; leave mark at previous position.
754 With numeric arg N, put point N/10 of the way from the beginning.
756 If the buffer is narrowed, this command uses the beginning and size
757 of the accessible part of the buffer.
759 Don't use this command in Lisp programs!
760 \(goto-char (point-min)) is faster and avoids clobbering the mark."
769 ;; Avoid overflow for large buffer sizes!
777 "Move point to the end of the buffer; leave mark at previous position.
779 With numeric arg N, put point N/10 of the way from the end.
781 If the buffer is narrowed, this command uses the beginning and size
782 of the accessible part of the buffer.
784 Don't use this command in Lisp programs!
785 \(goto-char (point-max)) is faster and avoids clobbering the mark."
794 ;; Avoid overflow for large buffer sizes!
799 ;; If we went to a place in the middle of the buffer,
800 ;; adjust it to the beginning of a line.
803 ;; If the end of the buffer is not already on the screen,
804 ;; then scroll specially to put it near, but not at, the bottom.
809 "Put point at beginning and mark at end of buffer.
810 You probably should not use this function in Lisp programs;
811 it is usually a mistake for a Lisp function to use any subroutine
812 that uses or sets the mark."
817 \f
819 ;; Counting lines, one way or another.
822 "Goto line ARG, counting from line 1 at beginning of buffer.
823 Normally, move point in the current buffer.
825 displayed other buffer, and switch to it. When called from Lisp code,
826 the optional argument BUFFER specifies a buffer to switch to.
828 If there's a number in the buffer at point, it is the default for ARG."
832 ;; Look for a default, a number in the buffer at point.
841 ;; Decide if we're switching buffers.
849 ;; Read the argument, offering that number (if any) as default.
852 buffer-prompt
853 default)
854 nil nil t
855 'minibuffer-history
856 default)
857 buffer))))
858 ;; Switch to the desired buffer, one way or another.
863 ;; Move to the specified line number in that buffer.
872 "Print number of lines and characters in the region."
878 "Print the current buffer line number and narrowed line number of point."
891 "Return number of lines between START and END.
892 This is usually the number of newlines between them,
893 but can be one more if START is not equal to END
894 and the greater of them is not at the start of a line."
910 done)))
914 "Return (narrowed) buffer line number at position POS.
915 If POS is nil, use current buffer location.
916 Counting starts at (point-min), so the value refers
917 to the contents of the accessible portion of the buffer."
927 "Print info on cursor position (on screen and within buffer).
928 Also describe the character after point, and give its character code
929 in octal, decimal and hex.
931 For a non-ASCII multibyte character, also give its encoding in the
932 buffer's selected coding system if the coding system encodes the
933 character safely. If the character is encoded into one byte, that
934 code is shown in hex. If the character is encoded into more than one
937 In addition, with prefix argument, show details about that character
938 in *Help* buffer. See also the command `describe-char'."
946 ;; Avoid overflow from multiplying by 100!
950 ""
956 pos total percent beg end col hscroll)
958 pos total col hscroll))
960 encoded encoding-msg display-prop under-display)
967 ;; Check if the character is displayed with some `display'
968 ;; text property. In that case, set under-display to the
969 ;; buffer substring covered by that property.
980 under-display)))
986 char char char under-display)
988 char char char under-display display-prop))
991 char char char
993 "..."
997 ;; We show the detailed information about CHAR.
1004 encoding-msg pos total percent beg end col hscroll)
1011 encoding-msg pos total percent col hscroll))))))
1012 \f
1013 ;; Initialize read-expression-map. It is defined at C level.
1025 "Value for `print-level' while printing value in `eval-expression'.
1026 A value of nil means no limit."
1032 "Value for `print-length' while printing value in `eval-expression'.
1033 A value of nil means no limit."
1039 "If non-nil set `debug-on-error' to t in `eval-expression'.
1040 If nil, don't change the value of `debug-on-error'."
1046 "Format VALUE as a result of evaluated expression.
1047 Return a formatted string which is displayed in the echo area
1048 in addition to the value printed by prin1 in functions which
1049 display the result of expression evaluation."
1062 ;; We define this, rather than making `eval' interactive,
1063 ;; for the sake of completion of names like eval-region, eval-buffer.
1066 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1067 Value is also consed on to front of the variable `values'.
1068 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1069 insert the result into the current buffer instead of printing it in
1070 the echo area.
1072 If `eval-expression-debug-on-error' is non-nil, which is the default,
1073 this command arranges for all errors to enter the debugger."
1077 nil read-expression-map t
1079 current-prefix-arg))
1084 ;; Bind debug-on-error to something unique so that we can
1085 ;; detect when evaled code changes it.
1089 ;; If evaled code has changed the value of debug-on-error,
1090 ;; propagate that change to the global binding.
1106 "Prompting with PROMPT, let user edit COMMAND and eval result.
1107 COMMAND is a Lisp expression. Let user edit that expression in
1108 the minibuffer, then read and evaluate the result."
1115 read-expression-map t
1117 ;; If command was added to command-history as a string,
1118 ;; get rid of that. We want only evaluable expressions there.
1122 ;; If command to be redone does not match front of history,
1123 ;; add it to the history.
1129 "Edit and re-evaluate last complex command, or ARGth from last.
1130 A complex command is one which used the minibuffer.
1131 The command is placed in the minibuffer as a Lisp form for editing.
1132 The result is executed, repeating the command as changed.
1133 If the command has been changed or is not the most recent previous command
1134 it is added to the front of the command history.
1135 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1136 to get different commands to edit and resubmit."
1139 newcmd)
1151 ;; If command was added to command-history as a
1152 ;; string, get rid of that. We want only
1153 ;; evaluable expressions there.
1157 ;; If command to be redone does not match front of history,
1158 ;; add it to the history.
1165 \f
1167 "Default minibuffer history list.
1168 This is used for all minibuffer input
1171 "Control whether history list elements are expressions or strings.
1172 If the value of this variable equals current minibuffer depth,
1173 they are expressions; otherwise they are strings.
1174 \(That convention is designed to do the right thing for
1181 "Text that was in this minibuffer before any history commands.
1182 This is nil if there have not yet been any history commands
1191 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1195 "*Minibuffer history variables for which matching should ignore case.
1196 If a history variable is a member of this list, then the
1198 commands ignore case when searching it, regardless of `case-fold-search'."
1203 "Find the previous history element that matches REGEXP.
1204 \(Previous history elements refer to earlier actions.)
1205 With prefix argument N, search for Nth previous match.
1206 If N is negative, find the next or Nth next match.
1207 Normally, history elements are matched case-insensitively if
1208 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1209 makes the search case-sensitive.
1210 See also `minibuffer-history-case-insensitive-variables'."
1214 nil
1215 minibuffer-local-map
1216 nil
1217 'minibuffer-history-search-history
1219 ;; Use the last regexp specified, by default, if input is empty.
1224 regexp)
1234 ;; On some systems, ignore case for file names.
1236 minibuffer-history-case-insensitive-variables)
1237 t
1238 ;; Respect the user's setting for case-fold-search:
1239 case-fold-search)
1240 nil))
1241 prevpos
1242 match-string
1243 match-offset
1250 "No later matching history item"
1271 next-matching-history-element))
1275 "Find the next history element that matches REGEXP.
1276 \(The next history element refers to a more recent action.)
1277 With prefix argument N, search for Nth next match.
1278 If N is negative, find the previous or Nth previous match.
1279 Normally, history elements are matched case-insensitively if
1280 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1281 makes the search case-sensitive."
1285 nil
1286 minibuffer-local-map
1287 nil
1288 'minibuffer-history-search-history
1290 ;; Use the last regexp specified, by default, if input is empty.
1295 regexp)
1302 "Puts element of the minibuffer history in the minibuffer.
1303 The argument NABS specifies the absolute history position."
1310 elt minibuffer-returned-to-present)
1322 previous-history-element))
1334 minibuffer-default)))
1346 elt))
1350 "Puts next element of the minibuffer history in the minibuffer.
1351 With argument N, it uses the Nth following element."
1357 "Puts previous element of the minibuffer history in the minibuffer.
1358 With argument N, it uses the Nth previous element."
1364 "Get next history element which completes the minibuffer before the point.
1365 The contents of the minibuffer after the point are deleted, and replaced
1366 by the new completion."
1372 n)
1373 ;; next-matching-history-element always puts us at (point-min).
1374 ;; Move to the position we were at before changing the buffer contents.
1375 ;; This is still sensical, because the text before point has not changed.
1379 "\
1380 Get previous history element which completes the minibuffer before the point.
1381 The contents of the minibuffer after the point are deleted, and replaced
1382 by the new completion."
1386 ;; For compatibility with the old subr of the same name.
1388 "Return the display width of the minibuffer prompt.
1389 Return 0 if current buffer is not a minibuffer."
1390 ;; Return the width of everything before the field at the end of
1391 ;; the buffer; this should be 0 for normal buffers.
1393 \f
1394 ;; isearch minibuffer history
1401 "Set up a minibuffer for using isearch to search the minibuffer history.
1402 Intended to be added to `minibuffer-setup-hook'."
1414 "Clean up the minibuffer after terminating isearch in the minibuffer."
1419 "Return the proper search function, for isearch in minibuffer history."
1426 ;; Use standard functions to search within minibuffer text
1432 found)
1433 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1434 ;; searching forward. Lazy-highlight calls this lambda with the
1435 ;; bound arg, so skip the minibuffer prompt.
1439 ;; 1. First try searching in the initial minibuffer text
1442 noerror)
1443 ;; 2. If the above search fails, start putting next/prev history
1444 ;; elements in the minibuffer successively, and search the string
1445 ;; in them. Do this only when bound is nil (i.e. not while
1446 ;; lazy-highlighting search strings in the current minibuffer text).
1458 ;; After putting the next/prev history element, search
1459 ;; the string in them again, until next-history-element
1460 ;; or previous-history-element raises an error at the
1461 ;; beginning/end of history.
1464 ;; For backward search, don't search
1465 ;; in the minibuffer prompt
1467 noerror)))
1468 ;; Return point of the new search result
1470 ;; Return nil when next(prev)-history-element fails
1474 "Display the minibuffer history search prompt.
1475 If there are no search errors, this function displays an overlay with
1476 the isearch prompt which replaces the original minibuffer prompt.
1477 Otherwise, it displays the standard isearch message returned from
1478 `isearch-message'."
1480 ;; Use standard function `isearch-message' when not in the minibuffer,
1481 ;; or search fails, or has an error (like incomplete regexp).
1482 ;; This function overwrites minibuffer text with isearch message,
1483 ;; so it's possible to see what is wrong in the search string.
1485 ;; Otherwise, put the overlay with the standard isearch prompt over
1486 ;; the initial minibuffer prompt.
1495 ;; And clear any previous isearch message.
1499 "Wrap the minibuffer history search when search is failed.
1500 Move point to the first history element for a forward search,
1501 or to the last history element for a backward search."
1503 ;; When `minibuffer-history-isearch-search' fails on reaching the
1504 ;; beginning/end of the history, wrap the search to the first/last
1505 ;; minibuffer history element.
1513 "Save a function restoring the state of minibuffer history search.
1514 Save `minibuffer-history-position' to the additional state parameter
1515 in the search status stack."
1520 "Restore the minibuffer history search state.
1521 Go to the history element by the absolute history position `hist-pos'."
1524 \f
1525 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1529 "Table mapping redo records to the corresponding undo one.
1530 A redo record for undo-in-region maps to t.
1540 "Within a run of consecutive undo commands, list remaining to be undone.
1544 "Undo some previous changes.
1545 Repeat this command to undo more changes.
1546 A numeric argument serves as a repeat count.
1548 In Transient Mark mode when the mark is active, only undo changes within
1550 as an argument limits undo to changes within the current region."
1552 ;; Make last-command indicate for the next command that this was an undo.
1553 ;; That way, another undo will undo more.
1554 ;; If we get to the end of the undo history and get an error,
1555 ;; another undo command will find the undo history empty
1556 ;; and will get another error. To begin undoing the undos,
1557 ;; you must type some other command.
1560 message)
1561 ;; If we get an error in undo-start,
1562 ;; the next command should not be a "consecutive undo".
1563 ;; So set `this-command' to something other than `undo'.
1568 ;; If something (a timer or filter?) changed the buffer
1569 ;; since the previous command, don't continue the undo seq.
1573 ;; If the last undo record made was made by undo
1574 ;; it shows nothing else happened in between.
1581 ;; get rid of initial undo boundary
1583 ;; If we got this far, the next command should be a consecutive undo.
1585 ;; Check to see whether we're hitting a redo record, and if
1586 ;; so, ask the user whether she wants to skip the redo/undo pair.
1593 ;; The equiv entry might point to another redo record if we have done
1594 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1602 ;; Record the fact that the just-generated undo records come from an
1603 ;; undo operation--that is, they are redo records.
1604 ;; In the ordinary case (not within a region), map the redo
1605 ;; record to the following undos.
1606 ;; I don't know how to do that in the undo-in-region case.
1609 undo-equiv-table)
1610 ;; Don't specify a position in the undo record for the undo command.
1611 ;; Instead, undoing this should move point to where the change is.
1630 ;; Record what the current undo list says,
1631 ;; so the next command can tell if the buffer was modified in between.
1634 ;; Display a message announcing success.
1639 "Make BUFFER stop keeping undo information.
1640 No argument or nil as argument means do this for the current buffer."
1646 "Undo some previous changes.
1647 Repeat this command to undo more changes.
1648 A numeric argument serves as a repeat count.
1649 Contrary to `undo', this will not redo a previous undo."
1654 "Non-nil while performing an undo.
1658 "Undo back N undo-boundaries beyond what was already undone recently.
1659 Call `undo-start' to get ready to undo recent changes,
1660 then call `undo-more' one or more times to undo them."
1669 ;; Deep copy of a list
1671 "Make a copy of undo list LIST."
1677 elt))
1680 "Set `pending-undo-list' to the front of the undo list.
1681 The next call to `undo-more' will undo the most recently made change.
1682 If BEG and END are specified, then only undo elements
1683 that apply to text between BEG and END are used; other undo elements
1684 are ignored. If BEG and END are nil, all undo elements are used."
1690 buffer-undo-list)))
1695 "Return a list of undo elements for the region START to END.
1696 The elements come from `buffer-undo-list', but we keep only
1697 the elements inside this region, and discard those outside this region.
1698 If we find an element that crosses an edge of this region,
1699 we stop and ignore all further elements."
1702 undo-adjusted-markers
1703 some-rejected
1704 undo-elt undo-elt temp-undo-list delta)
1709 ;; This is a "was unmodified" element.
1710 ;; Keep it if we have kept everything thus far.
1717 ;; Don't put two nils together in the list
1731 ;; Loop down the earlier events adjusting their buffer
1732 ;; positions to reflect the fact that a change to the buffer
1733 ;; isn't being undone. We only need to process those element
1734 ;; types which undo-elt-in-region will return as being in
1735 ;; the region since only those types can ever get into the
1736 ;; output
1745 ;; (TEXT . POSITION)
1752 ;; (BEGIN . END)
1757 ;; (nil PROPERTY VALUE BEG . END)
1767 "Determine whether UNDO-ELT falls inside the region START ... END.
1768 If it crosses the edge, we return nil."
1773 t)
1775 nil)
1777 ;; (TEXT . POSITION)
1781 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1782 ;; See if MARKER is inside the region.
1793 ;; (nil PROPERTY VALUE BEG . END)
1798 ;; (BEGIN . END)
1803 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1804 This assumes we have already decided that UNDO-ELT
1805 is not *inside* the region START...END."
1808 ;; (nil PROPERTY VALUE BEG . END)
1813 ;; (BEGIN . END)
1817 ;; Return the first affected buffer position and the delta for an undo element
1818 ;; delta is defined as the change in subsequent buffer positions if we *did*
1819 ;; the undo.
1823 ;; (TEXT . POSITION)
1826 ;; (BEGIN . END)
1833 "If non-nil ask about discarding undo info for the current command.
1834 Normally, Emacs discards the undo info for the current command if
1835 it exceeds `undo-outer-limit'. But if you set this option
1836 non-nil, it asks in the echo area whether to discard the info.
1837 If you answer no, there is a slight risk that Emacs might crash, so
1838 only do it if you really want to undo the command.
1840 This option is mainly intended for debugging. You have to be
1841 careful if you use it for other purposes. Garbage collection is
1842 inhibited while the question is asked, meaning that Emacs might
1843 leak memory. So you should make sure that you do not wait
1844 excessively long before answering the question."
1850 "If non-nil, an extra level of size that's ok in an undo item.
1851 We don't ask the user about truncating the undo list until the
1852 current item gets bigger than this amount.
1857 ;; When the first undo batch in an undo list is longer than
1858 ;; undo-outer-limit, this function gets called to warn the user that
1859 ;; the undo info for the current command was discarded. Garbage
1860 ;; collection is inhibited around the call, so it had better not do a
1861 ;; lot of consing.
1867 ;; Don't ask the question again unless it gets even bigger.
1868 ;; This applies, in particular, if the user quits from the question.
1869 ;; Such a quit quits out of GC, but something else will call GC
1870 ;; again momentarily. It will call this function again,
1871 ;; but we don't want to ask the question again.
1878 t)
1879 nil))
1884 "The undo info was discarded because it exceeded \
1885 `undo-outer-limit'.
1887 This is normal if you executed a command that made a huge change
1888 to the buffer. In that case, to prevent similar problems in the
1889 future, set `undo-outer-limit' to a value that is large enough to
1890 cover the maximum size of normal changes you expect a single
1891 command to make, but not so large that it might exceed the
1892 maximum memory allotted to Emacs.
1894 If you did not execute any such command, the situation is
1895 probably due to a bug and you should report it.
1897 You can disable the popping up of this buffer by adding the entry
1901 t))
1902 \f
1910 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1911 This buffer is used when `shell-command' or `shell-command-on-region'
1912 is run interactively. A value of nil means that output to stderr and
1916 "Execute string COMMAND in inferior shell; display output, if any.
1917 With prefix argument, insert the COMMAND's output at point.
1919 If COMMAND ends in ampersand, execute it asynchronously.
1920 The output appears in the buffer `*Async Shell Command*'.
1921 That buffer is in shell mode.
1923 Otherwise, COMMAND is executed synchronously. The output appears in
1924 the buffer `*Shell Command Output*'. If the output is short enough to
1925 display in the echo area (which is determined by the variables
1926 `resize-mini-windows' and `max-mini-window-height'), it is shown
1927 there, but it is nonetheless available in buffer `*Shell Command
1928 Output*' even though that buffer is not automatically displayed.
1930 To specify a coding system for converting non-ASCII characters
1932 before this command.
1934 Noninteractive callers can specify coding systems by binding
1935 `coding-system-for-read' and `coding-system-for-write'.
1937 The optional second argument OUTPUT-BUFFER, if non-nil,
1938 says to put the output in some other buffer.
1939 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1940 If OUTPUT-BUFFER is not a buffer and not nil,
1941 insert output in current buffer. (This cannot be done asynchronously.)
1942 In either case, the output is inserted after point (leaving mark after it).
1944 If the command terminates without error, but generates output,
1946 the output can be displayed in the echo area or in its buffer.
1947 If the output is short enough to display in the echo area
1948 \(determined by the variable `max-mini-window-height' if
1949 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1950 the buffer containing the output is displayed.
1954 of the output.
1956 If there is no output, or if output is inserted in the current buffer,
1957 then `*Shell Command Output*' is deleted.
1959 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1960 or buffer name to which to direct the command's standard error output.
1961 If it is nil, error output is mingled with regular output.
1962 In an interactive call, the variable `shell-command-default-error-buffer'
1963 specifies the value of ERROR-BUFFER."
1967 current-prefix-arg
1968 shell-command-default-error-buffer))
1969 ;; Look for a handler in case default-directory is a remote file name.
1977 ;; Output goes in current buffer.
1983 temporary-file-directory)))
1984 nil)))
1987 ;; We do not use -f for csh; we will not support broken use of
1988 ;; .cshrcs. Even the BSD csh manual says to use
1989 ;; "if ($?prompt) exit" before things which are not useful
1990 ;; non-interactively. Besides, if someone wants their other
1991 ;; aliases for shell commands then they can still have them.
1995 t)
1996 nil shell-command-switch command)
2003 ;; Do no formatting while reading error file,
2004 ;; because that can run a shell command, and we
2005 ;; don't want that to cause an infinite recursion.
2007 ;; Put point after the inserted errors.
2011 ;; This is like exchange-point-and-mark, but doesn't
2012 ;; activate the mark. It is cleaner to avoid activation,
2013 ;; even though the command loop would deactivate the mark
2014 ;; because we inserted text.
2018 ;; Output goes in a separate buffer.
2019 ;; Preserve the match data in case called from a program.
2022 ;; Command ending with ampersand means asynchronous.
2026 proc)
2027 ;; Remove the ampersand.
2029 ;; If will kill a process, query first.
2041 shell-command-switch command))
2045 ))
2047 output-buffer nil error-buffer)))))))
2051 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2052 MESSAGE may be either a string or a buffer.
2054 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2055 the maximum height of the echo area, as defined by `max-mini-window-height'
2056 if `resize-mini-windows' is non-nil.
2058 Returns either the string shown in the echo area, or when a pop-up
2059 buffer is used, the window used to display it.
2061 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2062 name of the buffer used to display it in the case where a pop-up buffer
2063 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2064 string and it is displayed in the echo area, it is not specified whether
2065 the contents are inserted into the buffer anyway.
2067 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2068 and only used if a buffer is displayed."
2070 ;; Trivial case where we can use the echo area
2074 ;; Trivial case where we can just remove single trailing newline
2077 ;; General case
2080 message
2089 0
2093 (<= lines
2097 max-mini-window-height))
2099 max-mini-window-height)
2103 ;; Don't use the echo area if the output buffer is
2104 ;; already dispayed in the selected frame.
2106 ;; Echo area
2112 ;; Buffer
2115 not-this-window frame))))))))
2118 ;; We have a sentinel to prevent insertion of a termination message
2119 ;; in the buffer itself.
2127 &optional output-buffer replace
2128 error-buffer display-error-buffer)
2129 "Execute string COMMAND in inferior shell with region as input.
2130 Normally display output (if any) in temp buffer `*Shell Command Output*';
2131 Prefix arg means replace the region with it. Return the exit code of
2132 COMMAND.
2134 To specify a coding system for converting non-ASCII characters
2136 before this command. By default, the input (from the current buffer)
2137 is encoded in the same coding system that will be used to save the file,
2138 `buffer-file-coding-system'. If the output is going to replace the region,
2139 then it is decoded from that same coding system.
2141 The noninteractive arguments are START, END, COMMAND,
2142 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2143 Noninteractive callers can specify coding systems by binding
2144 `coding-system-for-read' and `coding-system-for-write'.
2146 If the command generates output, the output may be displayed
2147 in the echo area or in a buffer.
2148 If the output is short enough to display in the echo area
2149 \(determined by the variable `max-mini-window-height' if
2150 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2151 it is displayed in the buffer `*Shell Command Output*'. The output
2152 is available in that buffer in both cases.
2154 If there is output and an error, a message about the error
2155 appears at the end of the output.
2157 If there is no output, or if output is inserted in the current buffer,
2158 then `*Shell Command Output*' is deleted.
2160 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2161 that says to put the output in some other buffer.
2162 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2163 If OUTPUT-BUFFER is not a buffer and not nil,
2164 insert output in the current buffer.
2165 In either case, the output is inserted after point (leaving mark after it).
2167 If REPLACE, the optional fifth argument, is non-nil, that means insert
2168 the output in place of text from START to END, putting point and mark
2169 around it.
2171 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2172 or buffer name to which to direct the command's standard error output.
2173 If it is nil, error output is mingled with regular output.
2174 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2175 were any errors. (This is always t, interactively.)
2176 In an interactive call, the variable `shell-command-default-error-buffer'
2177 specifies the value of ERROR-BUFFER."
2181 ;; Do this before calling region-beginning
2182 ;; and region-end, in case subprocess output
2183 ;; relocates them while we are in the minibuffer.
2185 nil nil nil
2187 ;; call-interactively recognizes region-beginning and
2188 ;; region-end specially, leaving them in the history.
2190 string
2191 current-prefix-arg
2192 current-prefix-arg
2193 shell-command-default-error-buffer
2194 t)))
2200 temporary-file-directory)))
2201 nil))
2202 exit-status)
2206 ;; Replace specified region with output from command.
2208 ;; Don't muck with mark unless REPLACE says we should.
2215 t)
2216 nil shell-command-switch command))
2217 ;; It is rude to delete a buffer which the command is not using.
2218 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2219 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2220 ;; (kill-buffer shell-buffer)))
2221 ;; Don't muck with mark unless REPLACE says we should.
2223 ;; No prefix argument: put the output in a temp buffer,
2224 ;; replacing its entire contents.
2229 ;; If the input is the same buffer as the output,
2230 ;; delete everything but the specified region,
2231 ;; then replace that region with the output.
2237 shell-file-name t
2240 t)
2241 nil shell-command-switch
2242 command)))
2243 ;; Clear the output buffer, then run the command with
2244 ;; output there.
2256 buffer)
2257 nil shell-command-switch command)))
2258 ;; Report the output.
2268 ;; There's some output, display it
2270 ;; No output; error?
2274 "some error output"
2280 output))
2283 exit-status))
2286 exit-status output))))
2287 ;; Don't kill: there might be useful info in the undo-log.
2288 ;; (kill-buffer buffer)
2289 ))))
2297 ;; Do no formatting while reading error file,
2298 ;; because that can run a shell command, and we
2299 ;; don't want that to cause an infinite recursion.
2301 ;; Put point after the inserted errors.
2306 exit-status))
2309 "Execute shell command COMMAND and return its output as a string."
2312 standard-output
2316 "Process files synchronously in a separate process.
2317 Similar to `call-process', but may invoke a file handler based on
2318 `default-directory'. The current working directory of the
2319 subprocess is `default-directory'.
2321 File names in INFILE and BUFFER are handled normally, but file
2322 names in ARGS should be relative to `default-directory', as they
2323 are passed to the process verbatim. \(This is a difference to
2324 `call-process' which does not support file handlers for INFILE
2325 and BUFFER.\)
2327 Some file handlers might not support all variants, for example
2328 they might behave as if DISPLAY was nil, regardless of the actual
2329 value passed."
2331 lc stderr-file)
2341 display args)
2347 "Start a program in a subprocess. Return the process object for it.
2348 Similar to `start-process', but may invoke a file handler based on
2349 `default-directory'. The current working directory of the
2350 subprocess is `default-directory'.
2352 PROGRAM and PROGRAM-ARGS might be file names. They are not
2353 objects of file handler invocation."
2359 \f
2363 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2364 (define-key map [switch-frame] nil)
2365 (define-key map [?\C-u] 'universal-argument-more)
2366 (define-key map [?-] 'universal-argument-minus)
2367 (define-key map [?0] 'digit-argument)
2368 (define-key map [?1] 'digit-argument)
2369 (define-key map [?2] 'digit-argument)
2370 (define-key map [?3] 'digit-argument)
2371 (define-key map [?4] 'digit-argument)
2372 (define-key map [?5] 'digit-argument)
2373 (define-key map [?6] 'digit-argument)
2374 (define-key map [?7] 'digit-argument)
2375 (define-key map [?8] 'digit-argument)
2376 (define-key map [?9] 'digit-argument)
2377 (define-key map [kp-0] 'digit-argument)
2378 (define-key map [kp-1] 'digit-argument)
2379 (define-key map [kp-2] 'digit-argument)
2380 (define-key map [kp-3] 'digit-argument)
2381 (define-key map [kp-4] 'digit-argument)
2382 (define-key map [kp-5] 'digit-argument)
2383 (define-key map [kp-6] 'digit-argument)
2384 (define-key map [kp-7] 'digit-argument)
2385 (define-key map [kp-8] 'digit-argument)
2386 (define-key map [kp-9] 'digit-argument)
2387 (define-key map [kp-subtract] 'universal-argument-minus)
2388 map)
2391 (defvar universal-argument-num-events nil
2392 "Number of argument-specifying events read by `universal-argument'.
2393 `universal-argument-other-key' uses this to discard those events
2394 from (this-command-keys), and reread only the final command.")
2396 (defvar overriding-map-is-bound nil
2397 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2399 (defvar saved-overriding-map nil
2400 "The saved value of `overriding-terminal-local-map'.
2404 (defun ensure-overriding-map-is-bound ()
2405 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2406 (unless overriding-map-is-bound
2407 (setq saved-overriding-map overriding-terminal-local-map)
2408 (setq overriding-terminal-local-map universal-argument-map)
2409 (setq overriding-map-is-bound t)))
2411 (defun restore-overriding-map ()
2412 "Restore `overriding-terminal-local-map' to its saved value."
2413 (setq overriding-terminal-local-map saved-overriding-map)
2414 (setq overriding-map-is-bound nil))
2416 (defun universal-argument ()
2417 "Begin a numeric argument for the following command.
2422 multiplies the argument by 4 each time.
2424 which is different in effect from any particular numeric argument.
2426 (interactive)
2427 (setq prefix-arg (list 4))
2428 (setq universal-argument-num-events (length (this-command-keys)))
2429 (ensure-overriding-map-is-bound))
2431 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2432 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2433 (defun universal-argument-more (arg)
2434 (interactive "P")
2435 (if (consp arg)
2436 (setq prefix-arg (list (* 4 (car arg))))
2437 (if (eq arg '-)
2438 (setq prefix-arg (list -4))
2439 (setq prefix-arg arg)
2440 (restore-overriding-map)))
2441 (setq universal-argument-num-events (length (this-command-keys))))
2443 (defun negative-argument (arg)
2444 "Begin a negative numeric argument for the next command.
2446 (interactive "P")
2447 (cond ((integerp arg)
2448 (setq prefix-arg (- arg)))
2449 ((eq arg '-)
2450 (setq prefix-arg nil))
2451 (t
2452 (setq prefix-arg '-)))
2453 (setq universal-argument-num-events (length (this-command-keys)))
2454 (ensure-overriding-map-is-bound))
2456 (defun digit-argument (arg)
2457 "Part of the numeric argument for the next command.
2459 (interactive "P")
2460 (let* ((char (if (integerp last-command-char)
2461 last-command-char
2462 (get last-command-char 'ascii-character)))
2464 (cond ((integerp arg)
2465 (setq prefix-arg (+ (* arg 10)
2466 (if (< arg 0) (- digit) digit))))
2467 ((eq arg '-)
2468 ;; Treat -0 as just -, so that -01 will work.
2469 (setq prefix-arg (if (zerop digit) '- (- digit))))
2470 (t
2471 (setq prefix-arg digit))))
2472 (setq universal-argument-num-events (length (this-command-keys)))
2473 (ensure-overriding-map-is-bound))
2475 ;; For backward compatibility, minus with no modifiers is an ordinary
2476 ;; command if digits have already been entered.
2477 (defun universal-argument-minus (arg)
2478 (interactive "P")
2479 (if (integerp arg)
2480 (universal-argument-other-key arg)
2481 (negative-argument arg)))
2483 ;; Anything else terminates the argument and is left in the queue to be
2484 ;; executed as a command.
2485 (defun universal-argument-other-key (arg)
2486 (interactive "P")
2487 (setq prefix-arg arg)
2488 (let* ((key (this-command-keys))
2489 (keylist (listify-key-sequence key)))
2490 (setq unread-command-events
2491 (append (nthcdr universal-argument-num-events keylist)
2492 unread-command-events)))
2493 (reset-this-command-lengths)
2494 (restore-overriding-map))
2495 \f
2496 (defvar buffer-substring-filters nil
2497 "List of filter functions for `filter-buffer-substring'.
2498 Each function must accept a single argument, a string, and return
2499 a string. The buffer substring is passed to the first function
2500 in the list, and the return value of each function is passed to
2501 the next. The return value of the last function is used as the
2502 return value of `filter-buffer-substring'.
2504 If this variable is nil, no filtering is performed.")
2506 (defun filter-buffer-substring (beg end &optional delete noprops)
2507 "Return the buffer substring between BEG and END, after filtering.
2508 The buffer substring is passed through each of the filter
2509 functions in `buffer-substring-filters', and the value from the
2510 last filter function is returned. If `buffer-substring-filters'
2511 is nil, the buffer substring is returned unaltered.
2513 If DELETE is non-nil, the text between BEG and END is deleted
2514 from the buffer.
2516 If NOPROPS is non-nil, final string returned does not include
2517 text properties, while the string passed to the filters still
2518 includes text properties from the buffer text.
2520 Point is temporarily set to BEG before calling
2521 `buffer-substring-filters', in case the functions need to know
2522 where the text came from.
2524 This function should be used instead of `buffer-substring',
2525 `buffer-substring-no-properties', or `delete-and-extract-region'
2526 when you want to allow filtering to take place. For example,
2527 major or minor modes can use `buffer-substring-filters' to
2528 extract characters that are special to a buffer, and should not
2529 be copied into other buffers."
2530 (cond
2531 ((or delete buffer-substring-filters)
2532 (save-excursion
2533 (goto-char beg)
2534 (let ((string (if delete (delete-and-extract-region beg end)
2535 (buffer-substring beg end))))
2536 (dolist (filter buffer-substring-filters)
2537 (setq string (funcall filter string)))
2538 (if noprops
2539 (set-text-properties 0 (length string) nil string))
2540 string)))
2541 (noprops
2542 (buffer-substring-no-properties beg end))
2543 (t
2544 (buffer-substring beg end))))
2547 ;;;; Window system cut and paste hooks.
2549 (defvar interprogram-cut-function nil
2550 "Function to call to make a killed region available to other programs.
2552 Most window systems provide some sort of facility for cutting and
2553 pasting text between the windows of different programs.
2554 This variable holds a function that Emacs calls whenever text
2555 is put in the kill ring, to make the new kill available to other
2556 programs.
2558 The function takes one or two arguments.
2559 The first argument, TEXT, is a string containing
2560 the text which should be made available.
2561 The second, optional, argument PUSH, has the same meaning as the
2562 similar argument to `x-set-cut-buffer', which see.")
2564 (defvar interprogram-paste-function nil
2565 "Function to call to get text cut from other programs.
2567 Most window systems provide some sort of facility for cutting and
2568 pasting text between the windows of different programs.
2569 This variable holds a function that Emacs calls to obtain
2570 text that other programs have provided for pasting.
2572 The function should be called with no arguments. If the function
2573 returns nil, then no other program has provided such text, and the top
2574 of the Emacs kill ring should be used. If the function returns a
2575 string, then the caller of the function \(usually `current-kill')
2576 should put this string in the kill ring as the latest kill.
2578 This function may also return a list of strings if the window
2579 system supports multiple selections. The first string will be
2580 used as the pasted text, but the other will be placed in the
2581 kill ring for easy access via `yank-pop'.
2583 Note that the function should return a string only if a program other
2584 than Emacs has provided a string for pasting; if Emacs provided the
2585 most recent string, the function should return nil. If it is
2586 difficult to tell whether Emacs or some other program provided the
2587 current string, it is probably good enough to return nil if the string
2588 is equal (according to `string=') to the last text Emacs provided.")
2589 \f
2592 ;;;; The kill ring data structure.
2594 (defvar kill-ring nil
2595 "List of killed text sequences.
2596 Since the kill ring is supposed to interact nicely with cut-and-paste
2597 facilities offered by window systems, use of this variable should
2598 interact nicely with `interprogram-cut-function' and
2599 `interprogram-paste-function'. The functions `kill-new',
2600 `kill-append', and `current-kill' are supposed to implement this
2601 interaction; you may want to use them instead of manipulating the kill
2602 ring directly.")
2604 (defcustom kill-ring-max 60
2605 "*Maximum length of kill ring before oldest elements are thrown away."
2606 :type 'integer
2607 :group 'killing)
2609 (defvar kill-ring-yank-pointer nil
2610 "The tail of the kill ring whose car is the last thing yanked.")
2612 (defun kill-new (string &optional replace yank-handler)
2613 "Make STRING the latest kill in the kill ring.
2614 Set `kill-ring-yank-pointer' to point to it.
2615 If `interprogram-cut-function' is non-nil, apply it to STRING.
2616 Optional second argument REPLACE non-nil means that STRING will replace
2617 the front of the kill ring, rather than being added to the list.
2619 Optional third arguments YANK-HANDLER controls how the STRING is later
2620 inserted into a buffer; see `insert-for-yank' for details.
2621 When a yank handler is specified, STRING must be non-empty (the yank
2622 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2624 When the yank handler has a non-nil PARAM element, the original STRING
2625 argument is not used by `insert-for-yank'. However, since Lisp code
2626 may access and use elements from the kill ring directly, the STRING
2628 (if (> (length string) 0)
2629 (if yank-handler
2630 (put-text-property 0 (length string)
2631 'yank-handler yank-handler string))
2632 (if yank-handler
2633 (signal 'args-out-of-range
2634 (list string "yank-handler specified for empty string"))))
2635 (if (fboundp 'menu-bar-update-yank-menu)
2636 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2637 (if (and replace kill-ring)
2638 (setcar kill-ring string)
2639 (push string kill-ring)
2640 (if (> (length kill-ring) kill-ring-max)
2641 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2642 (setq kill-ring-yank-pointer kill-ring)
2643 (if interprogram-cut-function
2644 (funcall interprogram-cut-function string (not replace))))
2646 (defun kill-append (string before-p &optional yank-handler)
2647 "Append STRING to the end of the latest kill in the kill ring.
2648 If BEFORE-P is non-nil, prepend STRING to the kill.
2649 Optional third argument YANK-HANDLER, if non-nil, specifies the
2650 yank-handler text property to be set on the combined kill ring
2651 string. If the specified yank-handler arg differs from the
2652 yank-handler property of the latest kill string, this function
2653 adds the combined string to the kill ring as a new element,
2654 instead of replacing the last kill with it.
2655 If `interprogram-cut-function' is set, pass the resulting kill to it."
2656 (let* ((cur (car kill-ring)))
2657 (kill-new (if before-p (concat string cur) (concat cur string))
2658 (or (= (length cur) 0)
2659 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2660 yank-handler)))
2662 (defcustom yank-pop-change-selection nil
2663 "If non-nil, rotating the kill ring changes the window system selection."
2664 :type 'boolean
2665 :group 'killing
2666 :version "23.1")
2668 (defun current-kill (n &optional do-not-move)
2669 "Rotate the yanking point by N places, and then return that kill.
2670 If N is zero, `interprogram-paste-function' is set, and calling it returns a
2671 string or list of strings, then that string (or list) is added to the front
2672 of the kill ring and the string (or first string in the list) is returned as
2673 the latest kill.
2675 If N is not zero, and if `yank-pop-change-selection' is
2676 non-nil, use `interprogram-cut-function' to transfer the
2677 kill at the new yank point into the window system selection.
2679 If optional arg DO-NOT-MOVE is non-nil, then don't actually
2680 move the yanking point; just return the Nth kill forward."
2682 (let ((interprogram-paste (and (= n 0)
2683 interprogram-paste-function
2684 (funcall interprogram-paste-function))))
2685 (if interprogram-paste
2686 (progn
2687 ;; Disable the interprogram cut function when we add the new
2688 ;; text to the kill ring, so Emacs doesn't try to own the
2689 ;; selection, with identical text.
2690 (let ((interprogram-cut-function nil))
2691 (if (listp interprogram-paste)
2692 (mapc 'kill-new (nreverse interprogram-paste))
2693 (kill-new interprogram-paste)))
2694 (car kill-ring))
2695 (or kill-ring (error "Kill ring is empty"))
2696 (let ((ARGth-kill-element
2697 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2698 (length kill-ring))
2699 kill-ring)))
2700 (unless do-not-move
2701 (setq kill-ring-yank-pointer ARGth-kill-element)
2702 (when (and yank-pop-change-selection
2703 (> n 0)
2704 interprogram-cut-function)
2705 (funcall interprogram-cut-function (car ARGth-kill-element))))
2706 (car ARGth-kill-element)))))
2710 ;;;; Commands for manipulating the kill ring.
2712 (defcustom kill-read-only-ok nil
2713 "*Non-nil means don't signal an error for killing read-only text."
2714 :type 'boolean
2715 :group 'killing)
2717 (put 'text-read-only 'error-conditions
2718 '(text-read-only buffer-read-only error))
2719 (put 'text-read-only 'error-message "Text is read-only")
2721 (defun kill-region (beg end &optional yank-handler)
2723 This deletes the text from the buffer and saves it in the kill ring.
2727 If you want to append the killed region to the last killed text,
2730 If the buffer is read-only, Emacs will beep and refrain from deleting
2731 the text, but put the text in the kill ring anyway. This means that
2732 you can use the killing commands to copy text from a read-only buffer.
2734 This is the primitive for programs to kill text (as opposed to deleting it).
2735 Supply two arguments, character positions indicating the stretch of text
2736 to be killed.
2738 If the previous command was also a kill command,
2739 the text killed this time appends to the text killed last time
2740 to make one entry in the kill ring.
2742 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2743 specifies the yank-handler text property to be set on the killed
2744 text. See `insert-for-yank'."
2745 ;; Pass point first, then mark, because the order matters
2746 ;; when calling kill-append.
2747 (interactive (list (point) (mark)))
2748 (unless (and beg end)
2749 (error "The mark is not set now, so there is no region"))
2750 (condition-case nil
2751 (let ((string (filter-buffer-substring beg end t)))
2752 (when string ;STRING is nil if BEG = END
2753 ;; Add that string to the kill ring, one way or another.
2754 (if (eq last-command 'kill-region)
2755 (kill-append string (< end beg) yank-handler)
2756 (kill-new string nil yank-handler)))
2757 (when (or string (eq last-command 'kill-region))
2758 (setq this-command 'kill-region))
2759 nil)
2760 ((buffer-read-only text-read-only)
2761 ;; The code above failed because the buffer, or some of the characters
2762 ;; in the region, are read-only.
2763 ;; We should beep, in case the user just isn't aware of this.
2764 ;; However, there's no harm in putting
2765 ;; the region's text in the kill ring, anyway.
2766 (copy-region-as-kill beg end)
2767 ;; Set this-command now, so it will be set even if we get an error.
2768 (setq this-command 'kill-region)
2769 ;; This should barf, if appropriate, and give us the correct error.
2770 (if kill-read-only-ok
2771 (progn (message "Read only text copied to kill ring") nil)
2772 ;; Signal an error if the buffer is read-only.
2773 (barf-if-buffer-read-only)
2774 ;; If the buffer isn't read-only, the text is.
2775 (signal 'text-read-only (list (current-buffer)))))))
2777 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2778 ;; to get two copies of the text when the user accidentally types M-w and
2779 ;; then corrects it with the intended C-w.
2780 (defun copy-region-as-kill (beg end)
2781 "Save the region as if killed, but don't kill it.
2782 In Transient Mark mode, deactivate the mark.
2783 If `interprogram-cut-function' is non-nil, also save the text for a window
2784 system cut and paste.
2786 This command's old key binding has been given to `kill-ring-save'."
2787 (interactive "r")
2788 (if (eq last-command 'kill-region)
2789 (kill-append (filter-buffer-substring beg end) (< end beg))
2790 (kill-new (filter-buffer-substring beg end)))
2791 (if transient-mark-mode
2792 (setq deactivate-mark t))
2793 nil)
2795 (defun kill-ring-save (beg end)
2796 "Save the region as if killed, but don't kill it.
2797 In Transient Mark mode, deactivate the mark.
2798 If `interprogram-cut-function' is non-nil, also save the text for a window
2799 system cut and paste.
2801 If you want to append the killed line to the last killed text,
2804 This command is similar to `copy-region-as-kill', except that it gives
2805 visual feedback indicating the extent of the region being copied."
2806 (interactive "r")
2807 (copy-region-as-kill beg end)
2808 ;; This use of interactive-p is correct
2809 ;; because the code it controls just gives the user visual feedback.
2810 (if (interactive-p)
2811 (let ((other-end (if (= (point) beg) end beg))
2812 (opoint (point))
2813 ;; Inhibit quitting so we can make a quit here
2814 ;; look like a C-g typed as a command.
2815 (inhibit-quit t))
2816 (if (pos-visible-in-window-p other-end (selected-window))
2817 (unless (and transient-mark-mode
2818 (face-background 'region))
2819 ;; Swap point and mark.
2820 (set-marker (mark-marker) (point) (current-buffer))
2821 (goto-char other-end)
2822 (sit-for blink-matching-delay)
2823 ;; Swap back.
2824 (set-marker (mark-marker) other-end (current-buffer))
2825 (goto-char opoint)
2826 ;; If user quit, deactivate the mark
2827 ;; as C-g would as a command.
2828 (and quit-flag mark-active
2829 (deactivate-mark)))
2830 (let* ((killed-text (current-kill 0))
2831 (message-len (min (length killed-text) 40)))
2832 (if (= (point) beg)
2833 ;; Don't say "killed"; that is misleading.
2835 (substring killed-text (- message-len)))
2837 (substring killed-text 0 message-len))))))))
2839 (defun append-next-kill (&optional interactive)
2840 "Cause following command, if it kills, to append to previous kill.
2841 The argument is used for internal purposes; do not supply one."
2842 (interactive "p")
2843 ;; We don't use (interactive-p), since that breaks kbd macros.
2844 (if interactive
2845 (progn
2846 (setq this-command 'kill-region)
2847 (message "If the next command is a kill, it will append"))
2848 (setq last-command 'kill-region)))
2849 \f
2850 ;; Yanking.
2852 ;; This is actually used in subr.el but defcustom does not work there.
2853 (defcustom yank-excluded-properties
2854 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2855 yank-handler follow-link fontified)
2856 "Text properties to discard when yanking.
2857 The value should be a list of text properties to discard or t,
2858 which means to discard all text properties."
2859 :type '(choice (const :tag "All" t) (repeat symbol))
2860 :group 'killing
2861 :version "22.1")
2863 (defvar yank-window-start nil)
2864 (defvar yank-undo-function nil
2865 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2866 Function is called with two parameters, START and END corresponding to
2867 the value of the mark and point; it is guaranteed that START <= END.
2868 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2870 (defun yank-pop (&optional arg)
2871 "Replace just-yanked stretch of killed text with a different stretch.
2872 This command is allowed only immediately after a `yank' or a `yank-pop'.
2873 At such a time, the region contains a stretch of reinserted
2874 previously-killed text. `yank-pop' deletes that text and inserts in its
2875 place a different stretch of killed text.
2877 With no argument, the previous kill is inserted.
2878 With argument N, insert the Nth previous kill.
2879 If N is negative, this is a more recent kill.
2881 The sequence of kills wraps around, so that after the oldest one
2882 comes the newest one.
2884 When this command inserts killed text into the buffer, it honors
2885 `yank-excluded-properties' and `yank-handler' as described in the
2886 doc string for `insert-for-yank-1', which see."
2887 (interactive "*p")
2888 (if (not (eq last-command 'yank))
2889 (error "Previous command was not a yank"))
2890 (setq this-command 'yank)
2891 (unless arg (setq arg 1))
2892 (let ((inhibit-read-only t)
2893 (before (< (point) (mark t))))
2894 (if before
2895 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2896 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2897 (setq yank-undo-function nil)
2898 (set-marker (mark-marker) (point) (current-buffer))
2899 (insert-for-yank (current-kill arg))
2900 ;; Set the window start back where it was in the yank command,
2901 ;; if possible.
2902 (set-window-start (selected-window) yank-window-start t)
2903 (if before
2904 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2905 ;; It is cleaner to avoid activation, even though the command
2906 ;; loop would deactivate the mark because we inserted text.
2907 (goto-char (prog1 (mark t)
2908 (set-marker (mark-marker) (point) (current-buffer))))))
2909 nil)
2911 (defun yank (&optional arg)
2913 More precisely, reinsert the stretch of killed text most recently
2914 killed OR yanked. Put point at end, and set mark at beginning.
2915 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2916 With argument N, reinsert the Nth most recently killed stretch of killed
2917 text.
2919 When this command inserts killed text into the buffer, it honors
2920 `yank-excluded-properties' and `yank-handler' as described in the
2921 doc string for `insert-for-yank-1', which see.
2924 (interactive "*P")
2925 (setq yank-window-start (window-start))
2926 ;; If we don't get all the way thru, make last-command indicate that
2927 ;; for the following command.
2928 (setq this-command t)
2929 (push-mark (point))
2930 (insert-for-yank (current-kill (cond
2931 ((listp arg) 0)
2932 ((eq arg '-) -2)
2933 (t (1- arg)))))
2934 (if (consp arg)
2935 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2936 ;; It is cleaner to avoid activation, even though the command
2937 ;; loop would deactivate the mark because we inserted text.
2938 (goto-char (prog1 (mark t)
2939 (set-marker (mark-marker) (point) (current-buffer)))))
2940 ;; If we do get all the way thru, make this-command indicate that.
2941 (if (eq this-command t)
2942 (setq this-command 'yank))
2943 nil)
2945 (defun rotate-yank-pointer (arg)
2946 "Rotate the yanking point in the kill ring.
2947 With argument, rotate that many kills forward (or backward, if negative)."
2948 (interactive "p")
2949 (current-kill arg))
2950 \f
2951 ;; Some kill commands.
2953 ;; Internal subroutine of delete-char
2954 (defun kill-forward-chars (arg)
2955 (if (listp arg) (setq arg (car arg)))
2956 (if (eq arg '-) (setq arg -1))
2957 (kill-region (point) (forward-point arg)))
2959 ;; Internal subroutine of backward-delete-char
2960 (defun kill-backward-chars (arg)
2961 (if (listp arg) (setq arg (car arg)))
2962 (if (eq arg '-) (setq arg -1))
2963 (kill-region (point) (forward-point (- arg))))
2965 (defcustom backward-delete-char-untabify-method 'untabify
2966 "*The method for untabifying when deleting backward.
2967 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2968 `hungry' -- delete all whitespace, both tabs and spaces;
2969 `all' -- delete all whitespace, including tabs, spaces and newlines;
2970 nil -- just delete one character."
2971 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2972 :version "20.3"
2973 :group 'killing)
2975 (defun backward-delete-char-untabify (arg &optional killp)
2976 "Delete characters backward, changing tabs into spaces.
2977 The exact behavior depends on `backward-delete-char-untabify-method'.
2978 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2979 Interactively, ARG is the prefix arg (default 1)
2980 and KILLP is t if a prefix arg was specified."
2982 (when (eq backward-delete-char-untabify-method 'untabify)
2983 (let ((count arg))
2984 (save-excursion
2985 (while (and (> count 0) (not (bobp)))
2987 (let ((col (current-column)))
2988 (forward-char -1)
2989 (setq col (- col (current-column)))
2990 (insert-char ?\s col)
2991 (delete-char 1)))
2992 (forward-char -1)
2993 (setq count (1- count))))))
2994 (delete-backward-char
2996 ((eq backward-delete-char-untabify-method 'all)
2998 (if skip
2999 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3000 (point)))))
3001 (+ arg (if (zerop wh) 0 (1- wh))))
3002 arg))
3003 killp))
3005 (defun zap-to-char (arg char)
3006 "Kill up to and including ARG'th occurrence of CHAR.
3007 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3008 Goes backward if ARG is negative; error if CHAR not found."
3010 (if (char-table-p translation-table-for-input)
3011 (setq char (or (aref translation-table-for-input char) char)))
3012 (kill-region (point) (progn
3013 (search-forward (char-to-string char) nil nil arg)
3014 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3015 (point))))
3017 ;; kill-line and its subroutines.
3019 (defcustom kill-whole-line nil
3020 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3021 :type 'boolean
3022 :group 'killing)
3024 (defun kill-line (&optional arg)
3025 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3026 With prefix argument, kill that many lines from point.
3027 Negative arguments kill lines backward.
3028 With zero argument, kills the text before point on the current line.
3031 a number counts as a prefix arg.
3033 To kill a whole line, when point is not at the beginning, type \
3036 If `kill-whole-line' is non-nil, then this command kills the whole line
3037 including its terminating newline, when used at the beginning of a line
3038 with no argument. As a consequence, you can always kill a whole line
3041 If you want to append the killed line to the last killed text,
3044 If the buffer is read-only, Emacs will beep and refrain from deleting
3045 the line, but put the line in the kill ring anyway. This means that
3046 you can use this command to copy text from a read-only buffer.
3047 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3048 even beep.)"
3049 (interactive "P")
3050 (kill-region (point)
3051 ;; It is better to move point to the other end of the kill
3052 ;; before killing. That way, in a read-only buffer, point
3053 ;; moves across the text that is copied to the kill ring.
3054 ;; The choice has no effect on undo now that undo records
3055 ;; the value of point from before the command was run.
3056 (progn
3057 (if arg
3058 (forward-visible-line (prefix-numeric-value arg))
3059 (if (eobp)
3060 (signal 'end-of-buffer nil))
3061 (let ((end
3062 (save-excursion
3063 (end-of-visible-line) (point))))
3064 (if (or (save-excursion
3065 ;; If trailing whitespace is visible,
3066 ;; don't treat it as nothing.
3067 (unless show-trailing-whitespace
3069 (= (point) end))
3070 (and kill-whole-line (bolp)))
3071 (forward-visible-line 1)
3072 (goto-char end))))
3073 (point))))
3075 (defun kill-whole-line (&optional arg)
3076 "Kill current line.
3077 With prefix arg, kill that many lines starting from the current line.
3078 If arg is negative, kill backward. Also kill the preceding newline.
3080 If arg is zero, kill current line but exclude the trailing newline."
3081 (interactive "p")
3082 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3083 (signal 'end-of-buffer nil))
3084 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3085 (signal 'beginning-of-buffer nil))
3086 (unless (eq last-command 'kill-region)
3087 (kill-new "")
3088 (setq last-command 'kill-region))
3089 (cond ((zerop arg)
3090 ;; We need to kill in two steps, because the previous command
3091 ;; could have been a kill command, in which case the text
3092 ;; before point needs to be prepended to the current kill
3093 ;; ring entry and the text after point appended. Also, we
3094 ;; need to use save-excursion to avoid copying the same text
3095 ;; twice to the kill ring in read-only buffers.
3096 (save-excursion
3097 (kill-region (point) (progn (forward-visible-line 0) (point))))
3098 (kill-region (point) (progn (end-of-visible-line) (point))))
3099 ((< arg 0)
3100 (save-excursion
3101 (kill-region (point) (progn (end-of-visible-line) (point))))
3102 (kill-region (point)
3103 (progn (forward-visible-line (1+ arg))
3104 (unless (bobp) (backward-char))
3105 (point))))
3106 (t
3107 (save-excursion
3108 (kill-region (point) (progn (forward-visible-line 0) (point))))
3109 (kill-region (point)
3110 (progn (forward-visible-line arg) (point))))))
3112 (defun forward-visible-line (arg)
3113 "Move forward by ARG lines, ignoring currently invisible newlines only.
3114 If ARG is negative, move backward -ARG lines.
3115 If ARG is zero, move to the beginning of the current line."
3116 (condition-case nil
3117 (if (> arg 0)
3118 (progn
3119 (while (> arg 0)
3120 (or (zerop (forward-line 1))
3121 (signal 'end-of-buffer nil))
3122 ;; If the newline we just skipped is invisible,
3123 ;; don't count it.
3124 (let ((prop
3125 (get-char-property (1- (point)) 'invisible)))
3126 (if (if (eq buffer-invisibility-spec t)
3127 prop
3128 (or (memq prop buffer-invisibility-spec)
3129 (assq prop buffer-invisibility-spec)))
3130 (setq arg (1+ arg))))
3131 (setq arg (1- arg)))
3132 ;; If invisible text follows, and it is a number of complete lines,
3133 ;; skip it.
3134 (let ((opoint (point)))
3135 (while (and (not (eobp))
3136 (let ((prop
3137 (get-char-property (point) 'invisible)))
3138 (if (eq buffer-invisibility-spec t)
3139 prop
3140 (or (memq prop buffer-invisibility-spec)
3141 (assq prop buffer-invisibility-spec)))))
3142 (goto-char
3143 (if (get-text-property (point) 'invisible)
3144 (or (next-single-property-change (point) 'invisible)
3145 (point-max))
3146 (next-overlay-change (point)))))
3147 (unless (bolp)
3148 (goto-char opoint))))
3149 (let ((first t))
3150 (while (or first (<= arg 0))
3151 (if first
3152 (beginning-of-line)
3153 (or (zerop (forward-line -1))
3154 (signal 'beginning-of-buffer nil)))
3155 ;; If the newline we just moved to is invisible,
3156 ;; don't count it.
3157 (unless (bobp)
3158 (let ((prop
3159 (get-char-property (1- (point)) 'invisible)))
3160 (unless (if (eq buffer-invisibility-spec t)
3161 prop
3162 (or (memq prop buffer-invisibility-spec)
3163 (assq prop buffer-invisibility-spec)))
3164 (setq arg (1+ arg)))))
3165 (setq first nil))
3166 ;; If invisible text follows, and it is a number of complete lines,
3167 ;; skip it.
3168 (let ((opoint (point)))
3169 (while (and (not (bobp))
3170 (let ((prop
3171 (get-char-property (1- (point)) 'invisible)))
3172 (if (eq buffer-invisibility-spec t)
3173 prop
3174 (or (memq prop buffer-invisibility-spec)
3175 (assq prop buffer-invisibility-spec)))))
3176 (goto-char
3177 (if (get-text-property (1- (point)) 'invisible)
3178 (or (previous-single-property-change (point) 'invisible)
3179 (point-min))
3180 (previous-overlay-change (point)))))
3181 (unless (bolp)
3182 (goto-char opoint)))))
3183 ((beginning-of-buffer end-of-buffer)
3184 nil)))
3186 (defun end-of-visible-line ()
3187 "Move to end of current visible line."
3188 (end-of-line)
3189 ;; If the following character is currently invisible,
3190 ;; skip all characters with that same `invisible' property value,
3191 ;; then find the next newline.
3192 (while (and (not (eobp))
3193 (save-excursion
3195 (let ((prop
3196 (get-char-property (point) 'invisible)))
3197 (if (eq buffer-invisibility-spec t)
3198 prop
3199 (or (memq prop buffer-invisibility-spec)
3200 (assq prop buffer-invisibility-spec))))))
3202 (if (get-text-property (point) 'invisible)
3203 (goto-char (next-single-property-change (point) 'invisible))
3204 (goto-char (next-overlay-change (point))))
3205 (end-of-line)))
3206 \f
3207 (defun insert-buffer (buffer)
3208 "Insert after point the contents of BUFFER.
3209 Puts mark after the inserted text.
3210 BUFFER may be a buffer or a buffer name.
3212 This function is meant for the user to run interactively.
3213 Don't call it from programs: use `insert-buffer-substring' instead!"
3214 (interactive
3215 (list
3216 (progn
3217 (barf-if-buffer-read-only)
3218 (read-buffer "Insert buffer: "
3219 (if (eq (selected-window) (next-window (selected-window)))
3220 (other-buffer (current-buffer))
3221 (window-buffer (next-window (selected-window))))
3222 t))))
3223 (push-mark
3224 (save-excursion
3225 (insert-buffer-substring (get-buffer buffer))
3226 (point)))
3227 nil)
3229 (defun append-to-buffer (buffer start end)
3230 "Append to specified buffer the text of the region.
3231 It is inserted into that buffer before its point.
3233 When calling from a program, give three arguments:
3234 BUFFER (or buffer name), START and END.
3235 START and END specify the portion of the current buffer to be copied."
3236 (interactive
3237 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3238 (region-beginning) (region-end)))
3239 (let ((oldbuf (current-buffer)))
3240 (save-excursion
3241 (let* ((append-to (get-buffer-create buffer))
3242 (windows (get-buffer-window-list append-to t t))
3243 point)
3244 (set-buffer append-to)
3245 (setq point (point))
3246 (barf-if-buffer-read-only)
3247 (insert-buffer-substring oldbuf start end)
3248 (dolist (window windows)
3249 (when (= (window-point window) point)
3250 (set-window-point window (point))))))))
3252 (defun prepend-to-buffer (buffer start end)
3253 "Prepend to specified buffer the text of the region.
3254 It is inserted into that buffer after its point.
3256 When calling from a program, give three arguments:
3257 BUFFER (or buffer name), START and END.
3258 START and END specify the portion of the current buffer to be copied."
3260 (let ((oldbuf (current-buffer)))
3261 (save-excursion
3262 (set-buffer (get-buffer-create buffer))
3263 (barf-if-buffer-read-only)
3264 (save-excursion
3265 (insert-buffer-substring oldbuf start end)))))
3267 (defun copy-to-buffer (buffer start end)
3268 "Copy to specified buffer the text of the region.
3269 It is inserted into that buffer, replacing existing text there.
3271 When calling from a program, give three arguments:
3272 BUFFER (or buffer name), START and END.
3273 START and END specify the portion of the current buffer to be copied."
3275 (let ((oldbuf (current-buffer)))
3276 (with-current-buffer (get-buffer-create buffer)
3277 (barf-if-buffer-read-only)
3278 (erase-buffer)
3279 (save-excursion
3280 (insert-buffer-substring oldbuf start end)))))
3281 \f
3282 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3283 (put 'mark-inactive 'error-message "The mark is not active now")
3285 (defvar activate-mark-hook nil
3286 "Hook run when the mark becomes active.
3287 It is also run at the end of a command, if the mark is active and
3288 it is possible that the region may have changed.")
3290 (defvar deactivate-mark-hook nil
3291 "Hook run when the mark becomes inactive.")
3293 (defun mark (&optional force)
3294 "Return this buffer's mark value as integer, or nil if never set.
3296 In Transient Mark mode, this function signals an error if
3297 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3298 or the argument FORCE is non-nil, it disregards whether the mark
3299 is active, and returns an integer or nil in the usual way.
3301 If you are using this in an editing command, you are most likely making
3302 a mistake; see the documentation of `set-mark'."
3303 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3304 (marker-position (mark-marker))
3305 (signal 'mark-inactive nil)))
3307 ;; Many places set mark-active directly, and several of them failed to also
3308 ;; run deactivate-mark-hook. This shorthand should simplify.
3309 (defsubst deactivate-mark ()
3310 "Deactivate the mark by setting `mark-active' to nil.
3311 \(That makes a difference only in Transient Mark mode.)
3312 Also runs the hook `deactivate-mark-hook'."
3313 (cond
3314 ((eq transient-mark-mode 'lambda)
3315 (setq transient-mark-mode nil))
3316 (transient-mark-mode
3317 (setq mark-active nil)
3318 (run-hooks 'deactivate-mark-hook))))
3320 (defcustom select-active-regions nil
3321 "If non-nil, an active region automatically becomes the window selection."
3322 :type 'boolean
3323 :group 'killing
3324 :version "23.1")
3326 (defun set-mark (pos)
3327 "Set this buffer's mark to POS. Don't use this function!
3328 That is to say, don't use this function unless you want
3329 the user to see that the mark has moved, and you want the previous
3330 mark position to be lost.
3332 Normally, when a new mark is set, the old one should go on the stack.
3333 This is why most applications should use `push-mark', not `set-mark'.
3335 Novice Emacs Lisp programmers often try to use the mark for the wrong
3336 purposes. The mark saves a location for the user's convenience.
3337 Most editing commands should not alter the mark.
3338 To remember a location for internal use in the Lisp program,
3339 store it in a Lisp variable. Example:
3341 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3343 (if pos
3344 (progn
3345 (setq mark-active t)
3346 (run-hooks 'activate-mark-hook)
3347 (and select-active-regions
3348 (x-set-selection
3349 nil (buffer-substring (region-beginning) (region-end))))
3350 (set-marker (mark-marker) pos (current-buffer)))
3351 ;; Normally we never clear mark-active except in Transient Mark mode.
3352 ;; But when we actually clear out the mark value too,
3353 ;; we must clear mark-active in any mode.
3354 (setq mark-active nil)
3355 (run-hooks 'deactivate-mark-hook)
3356 (set-marker (mark-marker) nil)))
3358 (defcustom use-empty-active-region nil
3359 "If non-nil, an active region takes control even if empty.
3360 This applies to certain commands which, in Transient Mark mode,
3361 apply to the active region if there is one. If the setting is t,
3362 these commands apply to an empty active region if there is one.
3363 If the setting is nil, these commands treat an empty active
3364 region as if it were not active."
3365 :type 'boolean
3366 :version "23.1"
3367 :group 'editing-basics)
3369 (defun use-region-p ()
3370 "Return t if certain commands should apply to the region.
3371 Certain commands normally apply to text near point,
3372 but in Transient Mark mode when the mark is active they apply
3373 to the region instead. Such commands should use this subroutine to
3374 test whether to do that.
3376 This function also obeys `use-empty-active-region'."
3377 (and transient-mark-mode mark-active
3378 (or use-empty-active-region (> (region-end) (region-beginning)))))
3380 (defvar mark-ring nil
3381 "The list of former marks of the current buffer, most recent first.")
3382 (make-variable-buffer-local 'mark-ring)
3383 (put 'mark-ring 'permanent-local t)
3385 (defcustom mark-ring-max 16
3386 "*Maximum size of mark ring. Start discarding off end if gets this big."
3387 :type 'integer
3388 :group 'editing-basics)
3390 (defvar global-mark-ring nil
3391 "The list of saved global marks, most recent first.")
3393 (defcustom global-mark-ring-max 16
3394 "*Maximum size of global mark ring. \
3395 Start discarding off end if gets this big."
3396 :type 'integer
3397 :group 'editing-basics)
3399 (defun pop-to-mark-command ()
3400 "Jump to mark, and pop a new position for mark off the ring
3401 \(does not affect global mark ring\)."
3402 (interactive)
3403 (if (null (mark t))
3404 (error "No mark set in this buffer")
3405 (if (= (point) (mark t))
3406 (message "Mark popped"))
3407 (goto-char (mark t))
3408 (pop-mark)))
3410 (defun push-mark-command (arg &optional nomsg)
3411 "Set mark at where point is.
3412 If no prefix arg and mark is already set there, just activate it.
3413 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3414 (interactive "P")
3415 (let ((mark (marker-position (mark-marker))))
3416 (if (or arg (null mark) (/= mark (point)))
3417 (push-mark nil nomsg t)
3418 (setq mark-active t)
3419 (run-hooks 'activate-mark-hook)
3420 (unless nomsg
3421 (message "Mark activated")))))
3423 (defcustom set-mark-command-repeat-pop nil
3426 will pop the mark twice, and
3428 will pop the mark three times.
3432 :type 'boolean
3433 :group 'editing-basics)
3435 (defun set-mark-command (arg)
3436 "Set the mark where point is, or jump to the mark.
3437 Setting the mark also alters the region, which is the text
3438 between point and mark; this is the closest equivalent in
3441 With no prefix argument, set the mark at point, and push the
3442 old mark position on local mark ring. Also push the old mark on
3443 global mark ring, if the previous mark was set in another buffer.
3445 Immediately repeating this command activates `transient-mark-mode' temporarily.
3448 jump to the mark, and set the mark from
3449 position popped off the local mark ring \(this does not affect the global
3451 mark ring \(see `pop-global-mark'\).
3453 If `set-mark-command-repeat-pop' is non-nil, repeating
3455 off the local (or global) mark ring and jumps there.
3458 argument, unconditionally set mark where point is, even if
3459 `set-mark-command-repeat-pop' is non-nil.
3461 Novice Emacs Lisp programmers often try to use the mark for the wrong
3462 purposes. See the documentation of `set-mark' for more information."
3463 (interactive "P")
3464 (if (eq transient-mark-mode 'lambda)
3465 (setq transient-mark-mode nil))
3466 (cond
3467 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3468 (push-mark-command nil))
3469 ((not (eq this-command 'set-mark-command))
3470 (if arg
3471 (pop-to-mark-command)
3472 (push-mark-command t)))
3473 ((and set-mark-command-repeat-pop
3474 (eq last-command 'pop-to-mark-command))
3475 (setq this-command 'pop-to-mark-command)
3476 (pop-to-mark-command))
3477 ((and set-mark-command-repeat-pop
3478 (eq last-command 'pop-global-mark)
3479 (not arg))
3480 (setq this-command 'pop-global-mark)
3481 (pop-global-mark))
3482 (arg
3483 (setq this-command 'pop-to-mark-command)
3484 (pop-to-mark-command))
3485 ((and (eq last-command 'set-mark-command)
3486 mark-active (null transient-mark-mode))
3487 (setq transient-mark-mode 'lambda)
3488 (message "Transient-mark-mode temporarily enabled"))
3489 (t
3490 (push-mark-command nil))))
3492 (defun push-mark (&optional location nomsg activate)
3493 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3494 If the last global mark pushed was not in the current buffer,
3495 also push LOCATION on the global mark ring.
3496 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3498 Novice Emacs Lisp programmers often try to use the mark for the wrong
3499 purposes. See the documentation of `set-mark' for more information.
3501 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3502 (unless (null (mark t))
3503 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3504 (when (> (length mark-ring) mark-ring-max)
3505 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3506 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3507 (set-marker (mark-marker) (or location (point)) (current-buffer))
3508 ;; Now push the mark on the global mark ring.
3509 (if (and global-mark-ring
3510 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3511 ;; The last global mark pushed was in this same buffer.
3512 ;; Don't push another one.
3513 nil
3514 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3515 (when (> (length global-mark-ring) global-mark-ring-max)
3516 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3517 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3518 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3519 (message "Mark set"))
3520 (if (or activate (not transient-mark-mode))
3521 (set-mark (mark t)))
3522 nil)
3524 (defun pop-mark ()
3525 "Pop off mark ring into the buffer's actual mark.
3526 Does not set point. Does nothing if mark ring is empty."
3527 (when mark-ring
3528 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3529 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3530 (move-marker (car mark-ring) nil)
3531 (if (null (mark t)) (ding))
3532 (setq mark-ring (cdr mark-ring)))
3533 (deactivate-mark))
3535 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3536 (defun exchange-point-and-mark (&optional arg)
3537 "Put the mark where point is now, and point where the mark is now.
3538 This command works even when the mark is not active,
3539 and it reactivates the mark.
3540 With prefix arg, `transient-mark-mode' is enabled temporarily."
3541 (interactive "P")
3542 (if arg
3543 (if mark-active
3544 (if (null transient-mark-mode)
3545 (setq transient-mark-mode 'lambda))
3546 (setq arg nil)))
3547 (unless arg
3548 (let ((omark (mark t)))
3549 (if (null omark)
3550 (error "No mark set in this buffer"))
3551 (set-mark (point))
3552 (goto-char omark)
3553 nil)))
3555 (define-minor-mode transient-mark-mode
3556 "Toggle Transient Mark mode.
3557 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3559 In Transient Mark mode, when the mark is active, the region is highlighted.
3561 So do certain other operations that set the mark
3562 but whose main purpose is something else--for example,
3568 Many commands change their behavior when Transient Mark mode is in effect
3569 and the mark is active, by acting on the region instead of their usual
3570 default part of the buffer's text. Examples of such commands include
3575 commands which are sensitive to the Transient Mark mode."
3576 :global t :group 'editing-basics)
3578 (defvar widen-automatically t
3579 "Non-nil means it is ok for commands to call `widen' when they want to.
3580 Some commands will do this in order to go to positions outside
3581 the current accessible part of the buffer.
3583 If `widen-automatically' is nil, these commands will do something else
3584 as a fallback, and won't change the buffer bounds.")
3586 (defun pop-global-mark ()
3587 "Pop off global mark ring and jump to the top location."
3588 (interactive)
3589 ;; Pop entries which refer to non-existent buffers.
3590 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3591 (setq global-mark-ring (cdr global-mark-ring)))
3592 (or global-mark-ring
3593 (error "No global mark set"))
3594 (let* ((marker (car global-mark-ring))
3595 (buffer (marker-buffer marker))
3596 (position (marker-position marker)))
3597 (setq global-mark-ring (nconc (cdr global-mark-ring)
3598 (list (car global-mark-ring))))
3599 (set-buffer buffer)
3600 (or (and (>= position (point-min))
3601 (<= position (point-max)))
3602 (if widen-automatically
3603 (widen)
3604 (error "Global mark position is outside accessible part of buffer")))
3605 (goto-char position)
3606 (switch-to-buffer buffer)))
3607 \f
3608 (defcustom next-line-add-newlines nil
3609 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3610 :type 'boolean
3611 :version "21.1"
3612 :group 'editing-basics)
3614 (defun next-line (&optional arg try-vscroll)
3615 "Move cursor vertically down ARG lines.
3616 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3617 If there is no character in the target line exactly under the current column,
3618 the cursor is positioned after the character in that line which spans this
3619 column, or at the end of the line if it is not long enough.
3620 If there is no line in the buffer after this one, behavior depends on the
3621 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3622 to create a line, and moves the cursor to that line. Otherwise it moves the
3623 cursor to the end of the buffer.
3626 a semipermanent goal column for this command.
3627 Then instead of trying to move exactly vertically (or as close as possible),
3628 this command moves to the specified goal column (or as close as possible).
3629 The goal column is stored in the variable `goal-column', which is nil
3630 when there is no goal column.
3632 If you are thinking of using this in a Lisp program, consider
3633 using `forward-line' instead. It is usually easier to use
3634 and more reliable (no dependence on goal column, etc.)."
3636 (or arg (setq arg 1))
3637 (if (and next-line-add-newlines (= arg 1))
3638 (if (save-excursion (end-of-line) (eobp))
3639 ;; When adding a newline, don't expand an abbrev.
3640 (let ((abbrev-mode nil))
3641 (end-of-line)
3643 (line-move arg nil nil try-vscroll))
3644 (if (interactive-p)
3645 (condition-case nil
3646 (line-move arg nil nil try-vscroll)
3647 ((beginning-of-buffer end-of-buffer) (ding)))
3648 (line-move arg nil nil try-vscroll)))
3649 nil)
3651 (defun previous-line (&optional arg try-vscroll)
3652 "Move cursor vertically up ARG lines.
3653 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3654 If there is no character in the target line exactly over the current column,
3655 the cursor is positioned after the character in that line which spans this
3656 column, or at the end of the line if it is not long enough.
3659 a semipermanent goal column for this command.
3660 Then instead of trying to move exactly vertically (or as close as possible),
3661 this command moves to the specified goal column (or as close as possible).
3662 The goal column is stored in the variable `goal-column', which is nil
3663 when there is no goal column.
3665 If you are thinking of using this in a Lisp program, consider using
3666 `forward-line' with a negative argument instead. It is usually easier
3667 to use and more reliable (no dependence on goal column, etc.)."
3669 (or arg (setq arg 1))
3670 (if (interactive-p)
3671 (condition-case nil
3672 (line-move (- arg) nil nil try-vscroll)
3673 ((beginning-of-buffer end-of-buffer) (ding)))
3674 (line-move (- arg) nil nil try-vscroll))
3675 nil)
3677 (defcustom track-eol nil
3678 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3679 This means moving to the end of each line moved onto.
3680 The beginning of a blank line does not count as the end of a line."
3681 :type 'boolean
3682 :group 'editing-basics)
3684 (defcustom goal-column nil
3686 :type '(choice integer
3687 (const :tag "None" nil))
3688 :group 'editing-basics)
3689 (make-variable-buffer-local 'goal-column)
3691 (defvar temporary-goal-column 0
3692 "Current goal column for vertical motion.
3693 It is the column where point was
3694 at the start of current run of vertical motion commands.
3695 When the `track-eol' feature is doing its job, the value is `most-positive-fixnum'.")
3697 (defcustom line-move-ignore-invisible t
3699 Outline mode sets this."
3700 :type 'boolean
3701 :group 'editing-basics)
3703 ;; Returns non-nil if partial move was done.
3704 (defun line-move-partial (arg noerror to-end)
3705 (if (< arg 0)
3706 ;; Move backward (up).
3707 ;; If already vscrolled, reduce vscroll
3708 (let ((vs (window-vscroll nil t)))
3709 (when (> vs (frame-char-height))
3710 (set-window-vscroll nil (- vs (frame-char-height)) t)))
3712 ;; Move forward (down).
3713 (let* ((lh (window-line-height -1))
3714 (vpos (nth 1 lh))
3715 (ypos (nth 2 lh))
3716 (rbot (nth 3 lh))
3717 py vs)
3718 (when (or (null lh)
3719 (>= rbot (frame-char-height))
3720 (<= ypos (- (frame-char-height))))
3721 (unless lh
3722 (let ((wend (pos-visible-in-window-p t nil t)))
3723 (setq rbot (nth 3 wend)
3724 vpos (nth 5 wend))))
3725 (cond
3726 ;; If last line of window is fully visible, move forward.
3727 ((or (null rbot) (= rbot 0))
3728 nil)
3729 ;; If cursor is not in the bottom scroll margin, move forward.
3730 ((and (> vpos 0)
3731 (< (setq py
3732 (or (nth 1 (window-line-height))
3733 (let ((ppos (posn-at-point)))
3734 (cdr (or (posn-actual-col-row ppos)
3735 (posn-col-row ppos))))))
3736 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
3737 nil)
3738 ;; When already vscrolled, we vscroll some more if we can,
3739 ;; or clear vscroll and move forward at end of tall image.
3740 ((> (setq vs (window-vscroll nil t)) 0)
3741 (when (> rbot 0)
3742 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
3743 ;; If cursor just entered the bottom scroll margin, move forward,
3744 ;; but also vscroll one line so redisplay wont recenter.
3745 ((and (> vpos 0)
3746 (= py (min (- (window-text-height) scroll-margin 1)
3747 (1- vpos))))
3748 (set-window-vscroll nil (frame-char-height) t)
3749 (line-move-1 arg noerror to-end)
3750 t)
3751 ;; If there are lines above the last line, scroll-up one line.
3752 ((> vpos 0)
3753 (scroll-up 1)
3754 t)
3755 ;; Finally, start vscroll.
3756 (t
3757 (set-window-vscroll nil (frame-char-height) t)))))))
3760 ;; This is like line-move-1 except that it also performs
3761 ;; vertical scrolling of tall images if appropriate.
3762 ;; That is not really a clean thing to do, since it mixes
3763 ;; scrolling with cursor motion. But so far we don't have
3764 ;; a cleaner solution to the problem of making C-n do something
3765 ;; useful given a tall image.
3766 (defun line-move (arg &optional noerror to-end try-vscroll)
3767 (unless (and auto-window-vscroll try-vscroll
3768 ;; Only vscroll for single line moves
3769 (= (abs arg) 1)
3770 ;; But don't vscroll in a keyboard macro.
3771 (not defining-kbd-macro)
3772 (not executing-kbd-macro)
3773 (line-move-partial arg noerror to-end))
3774 (set-window-vscroll nil 0 t)
3775 (line-move-1 arg noerror to-end)))
3777 ;; This is the guts of next-line and previous-line.
3778 ;; Arg says how many lines to move.
3779 ;; The value is t if we can move the specified number of lines.
3780 (defun line-move-1 (arg &optional noerror to-end)
3781 ;; Don't run any point-motion hooks, and disregard intangibility,
3782 ;; for intermediate positions.
3783 (let ((inhibit-point-motion-hooks t)
3784 (opoint (point))
3785 (orig-arg arg))
3786 (unwind-protect
3787 (progn
3788 (if (not (memq last-command '(next-line previous-line)))
3789 (setq temporary-goal-column
3790 (if (and track-eol (eolp)
3791 ;; Don't count beg of empty line as end of line
3792 ;; unless we just did explicit end-of-line.
3793 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3794 most-positive-fixnum
3795 (current-column))))
3797 (if (not (or (integerp selective-display)
3798 line-move-ignore-invisible))
3799 ;; Use just newline characters.
3800 ;; Set ARG to 0 if we move as many lines as requested.
3801 (or (if (> arg 0)
3802 (progn (if (> arg 1) (forward-line (1- arg)))
3803 ;; This way of moving forward ARG lines
3804 ;; verifies that we have a newline after the last one.
3805 ;; It doesn't get confused by intangible text.
3806 (end-of-line)
3807 (if (zerop (forward-line 1))
3808 (setq arg 0)))
3809 (and (zerop (forward-line arg))
3810 (bolp)
3811 (setq arg 0)))
3812 (unless noerror
3813 (signal (if (< arg 0)
3814 'beginning-of-buffer
3815 'end-of-buffer)
3816 nil)))
3817 ;; Move by arg lines, but ignore invisible ones.
3818 (let (done)
3819 (while (and (> arg 0) (not done))
3820 ;; If the following character is currently invisible,
3821 ;; skip all characters with that same `invisible' property value.
3822 (while (and (not (eobp)) (invisible-p (point)))
3823 (goto-char (next-char-property-change (point))))
3824 ;; Move a line.
3825 ;; We don't use `end-of-line', since we want to escape
3826 ;; from field boundaries ocurring exactly at point.
3827 (goto-char (constrain-to-field
3828 (let ((inhibit-field-text-motion t))
3829 (line-end-position))
3830 (point) t t
3831 'inhibit-line-move-field-capture))
3832 ;; If there's no invisibility here, move over the newline.
3833 (cond
3834 ((eobp)
3835 (if (not noerror)
3836 (signal 'end-of-buffer nil)
3837 (setq done t)))
3838 ((and (> arg 1) ;; Use vertical-motion for last move
3839 (not (integerp selective-display))
3840 (not (invisible-p (point))))
3841 ;; We avoid vertical-motion when possible
3842 ;; because that has to fontify.
3843 (forward-line 1))
3844 ;; Otherwise move a more sophisticated way.
3845 ((zerop (vertical-motion 1))
3846 (if (not noerror)
3847 (signal 'end-of-buffer nil)
3848 (setq done t))))
3849 (unless done
3850 (setq arg (1- arg))))
3851 ;; The logic of this is the same as the loop above,
3852 ;; it just goes in the other direction.
3853 (while (and (< arg 0) (not done))
3854 ;; For completely consistency with the forward-motion
3855 ;; case, we should call beginning-of-line here.
3856 ;; However, if point is inside a field and on a
3857 ;; continued line, the call to (vertical-motion -1)
3858 ;; below won't move us back far enough; then we return
3859 ;; to the same column in line-move-finish, and point
3860 ;; gets stuck -- cyd
3861 (forward-line 0)
3862 (cond
3863 ((bobp)
3864 (if (not noerror)
3865 (signal 'beginning-of-buffer nil)
3866 (setq done t)))
3867 ((and (< arg -1) ;; Use vertical-motion for last move
3868 (not (integerp selective-display))
3869 (not (invisible-p (1- (point)))))
3870 (forward-line -1))
3871 ((zerop (vertical-motion -1))
3872 (if (not noerror)
3873 (signal 'beginning-of-buffer nil)
3874 (setq done t))))
3875 (unless done
3876 (setq arg (1+ arg))
3877 (while (and ;; Don't move over previous invis lines
3878 ;; if our target is the middle of this line.
3879 (or (zerop (or goal-column temporary-goal-column))
3880 (< arg 0))
3881 (not (bobp)) (invisible-p (1- (point))))
3882 (goto-char (previous-char-property-change (point))))))))
3883 ;; This is the value the function returns.
3884 (= arg 0))
3886 (cond ((> arg 0)
3887 ;; If we did not move down as far as desired,
3888 ;; at least go to end of line.
3889 (end-of-line))
3890 ((< arg 0)
3891 ;; If we did not move up as far as desired,
3892 ;; at least go to beginning of line.
3893 (beginning-of-line))
3894 (t
3895 (line-move-finish (or goal-column temporary-goal-column)
3896 opoint (> orig-arg 0)))))))
3898 (defun line-move-finish (column opoint forward)
3899 (let ((repeat t))
3900 (while repeat
3901 ;; Set REPEAT to t to repeat the whole thing.
3902 (setq repeat nil)
3904 (let (new
3905 (old (point))
3906 (line-beg (save-excursion (beginning-of-line) (point)))
3907 (line-end
3908 ;; Compute the end of the line
3909 ;; ignoring effectively invisible newlines.
3910 (save-excursion
3911 ;; Like end-of-line but ignores fields.
3913 (while (and (not (eobp)) (invisible-p (point)))
3914 (goto-char (next-char-property-change (point)))
3916 (point))))
3918 ;; Move to the desired column.
3919 (line-move-to-column column)
3921 ;; Corner case: suppose we start out in a field boundary in
3922 ;; the middle of a continued line. When we get to
3923 ;; line-move-finish, point is at the start of a new *screen*
3924 ;; line but the same text line; then line-move-to-column would
3925 ;; move us backwards. Test using C-n with point on the "x" in
3926 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
3927 (and forward
3928 (< (point) old)
3929 (goto-char old))
3931 (setq new (point))
3933 ;; Process intangibility within a line.
3934 ;; With inhibit-point-motion-hooks bound to nil, a call to
3935 ;; goto-char moves point past intangible text.
3937 ;; However, inhibit-point-motion-hooks controls both the
3938 ;; intangibility and the point-entered/point-left hooks. The
3939 ;; following hack avoids calling the point-* hooks
3940 ;; unnecessarily. Note that we move *forward* past intangible
3941 ;; text when the initial and final points are the same.
3942 (goto-char new)
3943 (let ((inhibit-point-motion-hooks nil))
3944 (goto-char new)
3946 ;; If intangibility moves us to a different (later) place
3947 ;; in the same line, use that as the destination.
3948 (if (<= (point) line-end)
3949 (setq new (point))
3950 ;; If that position is "too late",
3951 ;; try the previous allowable position.
3952 ;; See if it is ok.
3953 (backward-char)
3954 (if (if forward
3955 ;; If going forward, don't accept the previous
3956 ;; allowable position if it is before the target line.
3957 (< line-beg (point))
3958 ;; If going backward, don't accept the previous
3959 ;; allowable position if it is still after the target line.
3960 (<= (point) line-end))
3961 (setq new (point))
3962 ;; As a last resort, use the end of the line.
3963 (setq new line-end))))
3965 ;; Now move to the updated destination, processing fields
3966 ;; as well as intangibility.
3967 (goto-char opoint)
3968 (let ((inhibit-point-motion-hooks nil))
3969 (goto-char
3970 ;; Ignore field boundaries if the initial and final
3971 ;; positions have the same `field' property, even if the
3972 ;; fields are non-contiguous. This seems to be "nicer"
3973 ;; behavior in many situations.
3974 (if (eq (get-char-property new 'field)
3975 (get-char-property opoint 'field))
3976 new
3977 (constrain-to-field new opoint t t
3978 'inhibit-line-move-field-capture))))
3980 ;; If all this moved us to a different line,
3981 ;; retry everything within that new line.
3982 (when (or (< (point) line-beg) (> (point) line-end))
3983 ;; Repeat the intangibility and field processing.
3984 (setq repeat t))))))
3986 (defun line-move-to-column (col)
3987 "Try to find column COL, considering invisibility.
3988 This function works only in certain cases,
3989 because what we really need is for `move-to-column'
3990 and `current-column' to be able to ignore invisible text."
3991 (if (zerop col)
3992 (beginning-of-line)
3993 (move-to-column col))
3995 (when (and line-move-ignore-invisible
3996 (not (bolp)) (invisible-p (1- (point))))
3997 (let ((normal-location (point))
3998 (normal-column (current-column)))
3999 ;; If the following character is currently invisible,
4000 ;; skip all characters with that same `invisible' property value.
4001 (while (and (not (eobp))
4002 (invisible-p (point)))
4003 (goto-char (next-char-property-change (point))))
4004 ;; Have we advanced to a larger column position?
4005 (if (> (current-column) normal-column)
4006 ;; We have made some progress towards the desired column.
4007 ;; See if we can make any further progress.
4008 (line-move-to-column (+ (current-column) (- col normal-column)))
4009 ;; Otherwise, go to the place we originally found
4010 ;; and move back over invisible text.
4011 ;; that will get us to the same place on the screen
4012 ;; but with a more reasonable buffer position.
4013 (goto-char normal-location)
4014 (let ((line-beg (save-excursion (beginning-of-line) (point))))
4015 (while (and (not (bolp)) (invisible-p (1- (point))))
4016 (goto-char (previous-char-property-change (point) line-beg))))))))
4018 (defun move-end-of-line (arg)
4019 "Move point to end of current line as displayed.
4020 \(If there's an image in the line, this disregards newlines
4021 which are part of the text that the image rests on.)
4023 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4024 If point reaches the beginning or end of buffer, it stops there.
4025 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4026 (interactive "p")
4027 (or arg (setq arg 1))
4028 (let (done)
4029 (while (not done)
4030 (let ((newpos
4031 (save-excursion
4032 (let ((goal-column 0))
4033 (and (line-move arg t)
4034 (not (bobp))
4035 (progn
4036 (while (and (not (bobp)) (invisible-p (1- (point))))
4037 (goto-char (previous-single-char-property-change
4038 (point) 'invisible)))
4039 (backward-char 1)))
4040 (point)))))
4041 (goto-char newpos)
4042 (if (and (> (point) newpos)
4044 (backward-char 1)
4045 (if (and (> (point) newpos) (not (eobp))
4047 ;; If we skipped something intangible
4048 ;; and now we're not really at eol,
4049 ;; keep going.
4050 (setq arg 1)
4051 (setq done t)))))))
4053 (defun move-beginning-of-line (arg)
4054 "Move point to beginning of current line as displayed.
4055 \(If there's an image in the line, this disregards newlines
4056 which are part of the text that the image rests on.)
4058 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4059 If point reaches the beginning or end of buffer, it stops there.
4060 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4061 (interactive "p")
4062 (or arg (setq arg 1))
4064 (let ((orig (point))
4065 first-vis first-vis-field-value)
4067 ;; Move by lines, if ARG is not 1 (the default).
4068 (if (/= arg 1)
4069 (line-move (1- arg) t))
4071 ;; Move to beginning-of-line, ignoring fields and invisibles.
4073 (while (and (not (bobp)) (invisible-p (1- (point))))
4074 (goto-char (previous-char-property-change (point)))
4077 ;; Now find first visible char in the line
4078 (while (and (not (eobp)) (invisible-p (point)))
4079 (goto-char (next-char-property-change (point))))
4080 (setq first-vis (point))
4082 ;; See if fields would stop us from reaching FIRST-VIS.
4083 (setq first-vis-field-value
4084 (constrain-to-field first-vis orig (/= arg 1) t nil))
4086 (goto-char (if (/= first-vis-field-value first-vis)
4087 ;; If yes, obey them.
4088 first-vis-field-value
4089 ;; Otherwise, move to START with attention to fields.
4090 ;; (It is possible that fields never matter in this case.)
4091 (constrain-to-field (point) orig
4092 (/= arg 1) t nil)))))
4095 ;;; Many people have said they rarely use this feature, and often type
4096 ;;; it by accident. Maybe it shouldn't even be on a key.
4097 (put 'set-goal-column 'disabled t)
4099 (defun set-goal-column (arg)
4101 Those commands will move to this position in the line moved to
4102 rather than trying to keep the same horizontal position.
4103 With a non-nil argument, clears out the goal column
4105 The goal column is stored in the variable `goal-column'."
4106 (interactive "P")
4107 (if arg
4108 (progn
4109 (setq goal-column nil)
4110 (message "No goal column"))
4111 (setq goal-column (current-column))
4112 ;; The older method below can be erroneous if `set-goal-column' is bound
4113 ;; to a sequence containing %
4114 ;;(message (substitute-command-keys
4116 ;;goal-column)
4117 (message "%s"
4118 (concat
4119 (format "Goal column %d " goal-column)
4120 (substitute-command-keys
4123 )
4124 nil)
4125 \f
4127 (defun scroll-other-window-down (lines)
4129 For more details, see the documentation for `scroll-other-window'."
4130 (interactive "P")
4131 (scroll-other-window
4132 ;; Just invert the argument's meaning.
4133 ;; We can do that without knowing which window it will be.
4134 (if (eq lines '-) nil
4135 (if (null lines) '-
4136 (- (prefix-numeric-value lines))))))
4138 (defun beginning-of-buffer-other-window (arg)
4139 "Move point to the beginning of the buffer in the other window.
4140 Leave mark at previous position.
4141 With arg N, put point N/10 of the way from the true beginning."
4142 (interactive "P")
4143 (let ((orig-window (selected-window))
4144 (window (other-window-for-scrolling)))
4145 ;; We use unwind-protect rather than save-window-excursion
4146 ;; because the latter would preserve the things we want to change.
4147 (unwind-protect
4148 (progn
4149 (select-window window)
4150 ;; Set point and mark in that window's buffer.
4151 (with-no-warnings
4152 (beginning-of-buffer arg))
4153 ;; Set point accordingly.
4154 (recenter '(t)))
4155 (select-window orig-window))))
4157 (defun end-of-buffer-other-window (arg)
4158 "Move point to the end of the buffer in the other window.
4159 Leave mark at previous position.
4160 With arg N, put point N/10 of the way from the true end."
4161 (interactive "P")
4162 ;; See beginning-of-buffer-other-window for comments.
4163 (let ((orig-window (selected-window))
4164 (window (other-window-for-scrolling)))
4165 (unwind-protect
4166 (progn
4167 (select-window window)
4168 (with-no-warnings
4169 (end-of-buffer arg))
4170 (recenter '(t)))
4171 (select-window orig-window))))
4172 \f
4173 (defun transpose-chars (arg)
4174 "Interchange characters around point, moving forward one character.
4175 With prefix arg ARG, effect is to take character before point
4176 and drag it forward past ARG other characters (backward if ARG negative).
4177 If no argument and at end of line, the previous two chars are exchanged."
4178 (interactive "*P")
4179 (and (null arg) (eolp) (forward-char -1))
4180 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4182 (defun transpose-words (arg)
4183 "Interchange words around point, leaving point at end of them.
4184 With prefix arg ARG, effect is to take word before or around point
4185 and drag it forward past ARG other words (backward if ARG negative).
4186 If ARG is zero, the words around or after point and around or after mark
4187 are interchanged."
4188 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4189 (interactive "*p")
4190 (transpose-subr 'forward-word arg))
4192 (defun transpose-sexps (arg)
4194 Does not work on a sexp that point is in the middle of
4195 if it is a list or string."
4196 (interactive "*p")
4197 (transpose-subr
4198 (lambda (arg)
4199 ;; Here we should try to simulate the behavior of
4200 ;; (cons (progn (forward-sexp x) (point))
4201 ;; (progn (forward-sexp (- x)) (point)))
4202 ;; Except that we don't want to rely on the second forward-sexp
4203 ;; putting us back to where we want to be, since forward-sexp-function
4204 ;; might do funny things like infix-precedence.
4205 (if (if (> arg 0)
4207 (and (not (bobp))
4209 ;; Jumping over a symbol. We might be inside it, mind you.
4210 (progn (funcall (if (> arg 0)
4211 'skip-syntax-backward 'skip-syntax-forward)
4212 "w_")
4213 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4214 ;; Otherwise, we're between sexps. Take a step back before jumping
4215 ;; to make sure we'll obey the same precedence no matter which direction
4216 ;; we're going.
4217 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4218 (cons (save-excursion (forward-sexp arg) (point))
4219 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4220 (not (zerop (funcall (if (> arg 0)
4221 'skip-syntax-forward
4222 'skip-syntax-backward)
4223 ".")))))
4224 (point)))))
4225 arg 'special))
4227 (defun transpose-lines (arg)
4228 "Exchange current line and previous line, leaving point after both.
4229 With argument ARG, takes previous line and moves it past ARG lines.
4230 With argument 0, interchanges line point is in with line mark is in."
4231 (interactive "*p")
4232 (transpose-subr (function
4233 (lambda (arg)
4234 (if (> arg 0)
4235 (progn
4236 ;; Move forward over ARG lines,
4237 ;; but create newlines if necessary.
4238 (setq arg (forward-line arg))
4240 (setq arg (1+ arg)))
4241 (if (> arg 0)
4242 (newline arg)))
4243 (forward-line arg))))
4244 arg))
4246 (defun transpose-subr (mover arg &optional special)
4247 (let ((aux (if special mover
4248 (lambda (x)
4249 (cons (progn (funcall mover x) (point))
4250 (progn (funcall mover (- x)) (point))))))
4251 pos1 pos2)
4252 (cond
4253 ((= arg 0)
4254 (save-excursion
4255 (setq pos1 (funcall aux 1))
4256 (goto-char (mark))
4257 (setq pos2 (funcall aux 1))
4258 (transpose-subr-1 pos1 pos2))
4259 (exchange-point-and-mark))
4260 ((> arg 0)
4261 (setq pos1 (funcall aux -1))
4262 (setq pos2 (funcall aux arg))
4263 (transpose-subr-1 pos1 pos2)
4264 (goto-char (car pos2)))
4265 (t
4266 (setq pos1 (funcall aux -1))
4267 (goto-char (car pos1))
4268 (setq pos2 (funcall aux arg))
4269 (transpose-subr-1 pos1 pos2)))))
4271 (defun transpose-subr-1 (pos1 pos2)
4272 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4273 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4274 (when (> (car pos1) (car pos2))
4275 (let ((swap pos1))
4276 (setq pos1 pos2 pos2 swap)))
4277 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
4278 (atomic-change-group
4279 (let (word2)
4280 ;; FIXME: We first delete the two pieces of text, so markers that
4281 ;; used to point to after the text end up pointing to before it :-(
4282 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
4283 (goto-char (car pos2))
4284 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
4285 (goto-char (car pos1))
4286 (insert word2))))
4287 \f
4288 (defun backward-word (&optional arg)
4289 "Move backward until encountering the beginning of a word.
4290 With argument, do this that many times."
4291 (interactive "p")
4292 (forward-word (- (or arg 1))))
4294 (defun mark-word (&optional arg allow-extend)
4295 "Set mark ARG words away from point.
4297 move to with the same argument.
4298 Interactively, if this command is repeated
4299 or (in Transient Mark mode) if the mark is active,
4300 it marks the next ARG words after the ones already marked."
4302 (cond ((and allow-extend
4303 (or (and (eq last-command this-command) (mark t))
4304 (and transient-mark-mode mark-active)))
4305 (setq arg (if arg (prefix-numeric-value arg)
4306 (if (< (mark) (point)) -1 1)))
4307 (set-mark
4308 (save-excursion
4309 (goto-char (mark))
4310 (forward-word arg)
4311 (point))))
4312 (t
4313 (push-mark
4314 (save-excursion
4315 (forward-word (prefix-numeric-value arg))
4316 (point))
4317 nil t))))
4319 (defun kill-word (arg)
4320 "Kill characters forward until encountering the end of a word.
4321 With argument, do this that many times."
4322 (interactive "p")
4323 (kill-region (point) (progn (forward-word arg) (point))))
4325 (defun backward-kill-word (arg)
4326 "Kill characters backward until encountering the beginning of a word.
4327 With argument, do this that many times."
4328 (interactive "p")
4329 (kill-word (- arg)))
4331 (defun current-word (&optional strict really-word)
4332 "Return the symbol or word that point is on (or a nearby one) as a string.
4333 The return value includes no text properties.
4334 If optional arg STRICT is non-nil, return nil unless point is within
4335 or adjacent to a symbol or word. In all cases the value can be nil
4336 if there is no word nearby.
4337 The function, belying its name, normally finds a symbol.
4338 If optional arg REALLY-WORD is non-nil, it finds just a word."
4339 (save-excursion
4340 (let* ((oldpoint (point)) (start (point)) (end (point))
4341 (syntaxes (if really-word "w" "w_"))
4342 (not-syntaxes (concat "^" syntaxes)))
4343 (skip-syntax-backward syntaxes) (setq start (point))
4344 (goto-char oldpoint)
4345 (skip-syntax-forward syntaxes) (setq end (point))
4346 (when (and (eq start oldpoint) (eq end oldpoint)
4347 ;; Point is neither within nor adjacent to a word.
4348 (not strict))
4349 ;; Look for preceding word in same line.
4350 (skip-syntax-backward not-syntaxes
4351 (save-excursion (beginning-of-line)
4352 (point)))
4353 (if (bolp)
4354 ;; No preceding word in same line.
4355 ;; Look for following word in same line.
4356 (progn
4357 (skip-syntax-forward not-syntaxes
4358 (save-excursion (end-of-line)
4359 (point)))
4360 (setq start (point))
4361 (skip-syntax-forward syntaxes)
4362 (setq end (point)))
4363 (setq end (point))
4364 (skip-syntax-backward syntaxes)
4365 (setq start (point))))
4366 ;; If we found something nonempty, return it as a string.
4367 (unless (= start end)
4368 (buffer-substring-no-properties start end)))))
4369 \f
4370 (defcustom fill-prefix nil
4371 "*String for filling to insert at front of new line, or nil for none."
4372 :type '(choice (const :tag "None" nil)
4373 string)
4374 :group 'fill)
4375 (make-variable-buffer-local 'fill-prefix)
4376 ;;;###autoload(put 'fill-prefix 'safe-local-variable 'string-or-null-p)
4378 (defcustom auto-fill-inhibit-regexp nil
4379 "*Regexp to match lines which should not be auto-filled."
4380 :type '(choice (const :tag "None" nil)
4381 regexp)
4382 :group 'fill)
4384 ;; This function is used as the auto-fill-function of a buffer
4385 ;; when Auto-Fill mode is enabled.
4386 ;; It returns t if it really did any work.
4387 ;; (Actually some major modes use a different auto-fill function,
4388 ;; but this one is the default one.)
4389 (defun do-auto-fill ()
4390 (let (fc justify give-up
4391 (fill-prefix fill-prefix))
4392 (if (or (not (setq justify (current-justification)))
4393 (null (setq fc (current-fill-column)))
4394 (and (eq justify 'left)
4395 (<= (current-column) fc))
4396 (and auto-fill-inhibit-regexp
4397 (save-excursion (beginning-of-line)
4398 (looking-at auto-fill-inhibit-regexp))))
4399 nil ;; Auto-filling not required
4400 (if (memq justify '(full center right))
4401 (save-excursion (unjustify-current-line)))
4403 ;; Choose a fill-prefix automatically.
4404 (when (and adaptive-fill-mode
4405 (or (null fill-prefix) (string= fill-prefix "")))
4406 (let ((prefix
4407 (fill-context-prefix
4408 (save-excursion (backward-paragraph 1) (point))
4409 (save-excursion (forward-paragraph 1) (point)))))
4410 (and prefix (not (equal prefix ""))
4411 ;; Use auto-indentation rather than a guessed empty prefix.
4412 (not (and fill-indent-according-to-mode
4414 (setq fill-prefix prefix))))
4416 (while (and (not give-up) (> (current-column) fc))
4417 ;; Determine where to split the line.
4418 (let* (after-prefix
4419 (fill-point
4420 (save-excursion
4421 (beginning-of-line)
4422 (setq after-prefix (point))
4423 (and fill-prefix
4424 (looking-at (regexp-quote fill-prefix))
4425 (setq after-prefix (match-end 0)))
4426 (move-to-column (1+ fc))
4427 (fill-move-to-break-point after-prefix)
4428 (point))))
4430 ;; See whether the place we found is any good.
4431 (if (save-excursion
4432 (goto-char fill-point)
4433 (or (bolp)
4434 ;; There is no use breaking at end of line.
4435 (save-excursion (skip-chars-forward " ") (eolp))
4436 ;; It is futile to split at the end of the prefix
4437 ;; since we would just insert the prefix again.
4438 (and after-prefix (<= (point) after-prefix))
4439 ;; Don't split right after a comment starter
4440 ;; since we would just make another comment starter.
4441 (and comment-start-skip
4442 (let ((limit (point)))
4443 (beginning-of-line)
4444 (and (re-search-forward comment-start-skip
4445 limit t)
4446 (eq (point) limit))))))
4447 ;; No good place to break => stop trying.
4448 (setq give-up t)
4449 ;; Ok, we have a useful place to break the line. Do it.
4450 (let ((prev-column (current-column)))
4451 ;; If point is at the fill-point, do not `save-excursion'.
4452 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4453 ;; point will end up before it rather than after it.
4454 (if (save-excursion
4456 (= (point) fill-point))
4457 (default-indent-new-line t)
4458 (save-excursion
4459 (goto-char fill-point)
4460 (default-indent-new-line t)))
4461 ;; Now do justification, if required
4462 (if (not (eq justify 'left))
4463 (save-excursion
4464 (end-of-line 0)
4465 (justify-current-line justify nil t)))
4466 ;; If making the new line didn't reduce the hpos of
4467 ;; the end of the line, then give up now;
4468 ;; trying again will not help.
4469 (if (>= (current-column) prev-column)
4470 (setq give-up t))))))
4471 ;; Justify last line.
4472 (justify-current-line justify t t)
4473 t)))
4475 (defvar comment-line-break-function 'comment-indent-new-line
4476 "*Mode-specific function which line breaks and continues a comment.
4477 This function is called during auto-filling when a comment syntax
4478 is defined.
4479 The function should take a single optional argument, which is a flag
4480 indicating whether it should use soft newlines.")
4482 (defun default-indent-new-line (&optional soft)
4483 "Break line at point and indent.
4484 If a comment syntax is defined, call `comment-indent-new-line'.
4486 The inserted newline is marked hard if variable `use-hard-newlines' is true,
4487 unless optional argument SOFT is non-nil."
4488 (interactive)
4489 (if comment-start
4490 (funcall comment-line-break-function soft)
4491 ;; Insert the newline before removing empty space so that markers
4492 ;; get preserved better.
4494 (save-excursion (forward-char -1) (delete-horizontal-space))
4495 (delete-horizontal-space)
4497 (if (and fill-prefix (not adaptive-fill-mode))
4498 ;; Blindly trust a non-adaptive fill-prefix.
4499 (progn
4500 (indent-to-left-margin)
4501 (insert-before-markers-and-inherit fill-prefix))
4503 (cond
4504 ;; If there's an adaptive prefix, use it unless we're inside
4505 ;; a comment and the prefix is not a comment starter.
4506 (fill-prefix
4507 (indent-to-left-margin)
4508 (insert-and-inherit fill-prefix))
4509 ;; If we're not inside a comment, just try to indent.
4510 (t (indent-according-to-mode))))))
4512 (defvar normal-auto-fill-function 'do-auto-fill
4513 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4514 Some major modes set this.")
4516 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4517 ;; FIXME: turn into a proper minor mode.
4518 ;; Add a global minor mode version of it.
4519 (defun auto-fill-mode (&optional arg)
4520 "Toggle Auto Fill mode.
4521 With arg, turn Auto Fill mode on if and only if arg is positive.
4522 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4523 automatically breaks the line at a previous space.
4525 The value of `normal-auto-fill-function' specifies the function to use
4526 for `auto-fill-function' when turning Auto Fill mode on."
4527 (interactive "P")
4528 (prog1 (setq auto-fill-function
4529 (if (if (null arg)
4530 (not auto-fill-function)
4531 (> (prefix-numeric-value arg) 0))
4532 normal-auto-fill-function
4533 nil))
4534 (force-mode-line-update)))
4536 ;; This holds a document string used to document auto-fill-mode.
4537 (defun auto-fill-function ()
4538 "Automatically break line at a previous space, in insertion of text."
4539 nil)
4541 (defun turn-on-auto-fill ()
4542 "Unconditionally turn on Auto Fill mode."
4543 (auto-fill-mode 1))
4545 (defun turn-off-auto-fill ()
4546 "Unconditionally turn off Auto Fill mode."
4547 (auto-fill-mode -1))
4549 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4551 (defun set-fill-column (arg)
4552 "Set `fill-column' to specified argument.
4555 (interactive "P")
4556 (if (consp arg)
4557 (setq arg (current-column)))
4558 (if (not (integerp arg))
4559 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4560 (error "set-fill-column requires an explicit argument")
4561 (message "Fill column set to %d (was %d)" arg fill-column)
4562 (setq fill-column arg)))
4563 \f
4564 (defun set-selective-display (arg)
4565 "Set `selective-display' to ARG; clear it if no arg.
4566 When the value of `selective-display' is a number > 0,
4567 lines whose indentation is >= that value are not displayed.
4568 The variable `selective-display' has a separate value for each buffer."
4569 (interactive "P")
4570 (if (eq selective-display t)
4571 (error "selective-display already in use for marked lines"))
4572 (let ((current-vpos
4573 (save-restriction
4574 (narrow-to-region (point-min) (point))
4575 (goto-char (window-start))
4576 (vertical-motion (window-height)))))
4577 (setq selective-display
4578 (and arg (prefix-numeric-value arg)))
4579 (recenter current-vpos))
4580 (set-window-start (selected-window) (window-start (selected-window)))
4581 (princ "selective-display set to " t)
4582 (prin1 selective-display t)
4583 (princ "." t))
4585 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4586 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4588 (defun toggle-truncate-lines (&optional arg)
4589 "Toggle whether to fold or truncate long lines for the current buffer.
4590 With prefix argument ARG, truncate long lines if ARG is positive,
4591 otherwise don't truncate them. Note that in side-by-side
4592 windows, truncation is always enabled."
4593 (interactive "P")
4594 (setq truncate-lines
4595 (if (null arg)
4596 (not truncate-lines)
4597 (> (prefix-numeric-value arg) 0)))
4598 (force-mode-line-update)
4599 (unless truncate-lines
4600 (let ((buffer (current-buffer)))
4601 (walk-windows (lambda (window)
4602 (if (eq buffer (window-buffer window))
4603 (set-window-hscroll window 0)))
4604 nil t)))
4605 (message "Truncate long lines %s"
4606 (if truncate-lines "enabled" "disabled")))
4608 (defvar overwrite-mode-textual " Ovwrt"
4609 "The string displayed in the mode line when in overwrite mode.")
4610 (defvar overwrite-mode-binary " Bin Ovwrt"
4611 "The string displayed in the mode line when in binary overwrite mode.")
4613 (defun overwrite-mode (arg)
4614 "Toggle overwrite mode.
4615 With prefix argument ARG, turn overwrite mode on if ARG is positive,
4616 otherwise turn it off. In overwrite mode, printing characters typed
4617 in replace existing text on a one-for-one basis, rather than pushing
4618 it to the right. At the end of a line, such characters extend the line.
4619 Before a tab, such characters insert until the tab is filled in.
4621 is supposed to make it easier to insert characters when necessary."
4622 (interactive "P")
4623 (setq overwrite-mode
4624 (if (if (null arg) (not overwrite-mode)
4625 (> (prefix-numeric-value arg) 0))
4626 'overwrite-mode-textual))
4627 (force-mode-line-update))
4629 (defun binary-overwrite-mode (arg)
4630 "Toggle binary overwrite mode.
4631 With prefix argument ARG, turn binary overwrite mode on if ARG is
4632 positive, otherwise turn it off. In binary overwrite mode, printing
4633 characters typed in replace existing text. Newlines are not treated
4634 specially, so typing at the end of a line joins the line to the next,
4635 with the typed character between them. Typing before a tab character
4637 replaces the text at the cursor, just as ordinary typing characters do.
4639 Note that binary overwrite mode is not its own minor mode; it is a
4640 specialization of overwrite mode, entered by setting the
4641 `overwrite-mode' variable to `overwrite-mode-binary'."
4642 (interactive "P")
4643 (setq overwrite-mode
4644 (if (if (null arg)
4645 (not (eq overwrite-mode 'overwrite-mode-binary))
4646 (> (prefix-numeric-value arg) 0))
4647 'overwrite-mode-binary))
4648 (force-mode-line-update))
4650 (define-minor-mode line-number-mode
4651 "Toggle Line Number mode.
4652 With arg, turn Line Number mode on if arg is positive, otherwise
4653 turn it off. When Line Number mode is enabled, the line number
4654 appears in the mode line.
4656 Line numbers do not appear for very large buffers and buffers
4657 with very long lines; see variables `line-number-display-limit'
4658 and `line-number-display-limit-width'."
4659 :init-value t :global t :group 'mode-line)
4661 (define-minor-mode column-number-mode
4662 "Toggle Column Number mode.
4663 With arg, turn Column Number mode on if arg is positive,
4664 otherwise turn it off. When Column Number mode is enabled, the
4665 column number appears in the mode line."
4666 :global t :group 'mode-line)
4668 (define-minor-mode size-indication-mode
4669 "Toggle Size Indication mode.
4670 With arg, turn Size Indication mode on if arg is positive,
4671 otherwise turn it off. When Size Indication mode is enabled, the
4672 size of the accessible part of the buffer appears in the mode line."
4673 :global t :group 'mode-line)
4674 \f
4675 (defgroup paren-blinking nil
4676 "Blinking matching of parens and expressions."
4677 :prefix "blink-matching-"
4678 :group 'paren-matching)
4680 (defcustom blink-matching-paren t
4681 "*Non-nil means show matching open-paren when close-paren is inserted."
4682 :type 'boolean
4683 :group 'paren-blinking)
4685 (defcustom blink-matching-paren-on-screen t
4686 "*Non-nil means show matching open-paren when it is on screen.
4687 If nil, don't show it (but the open-paren can still be shown
4688 when it is off screen).
4690 This variable has no effect if `blink-matching-paren' is nil.
4691 \(In that case, the open-paren is never shown.)
4692 It is also ignored if `show-paren-mode' is enabled."
4693 :type 'boolean
4694 :group 'paren-blinking)
4696 (defcustom blink-matching-paren-distance (* 25 1024)
4697 "*If non-nil, maximum distance to search backwards for matching open-paren.
4698 If nil, search stops at the beginning of the accessible portion of the buffer."
4699 :type '(choice (const nil) integer)
4700 :group 'paren-blinking)
4702 (defcustom blink-matching-delay 1
4703 "*Time in seconds to delay after showing a matching paren."
4704 :type 'number
4705 :group 'paren-blinking)
4707 (defcustom blink-matching-paren-dont-ignore-comments nil
4708 "*If nil, `blink-matching-paren' ignores comments.
4709 More precisely, when looking for the matching parenthesis,
4710 it skips the contents of comments that end before point."
4711 :type 'boolean
4712 :group 'paren-blinking)
4714 (defun blink-matching-open ()
4715 "Move cursor momentarily to the beginning of the sexp before point."
4716 (interactive)
4717 (when (and (> (point) (point-min))
4718 blink-matching-paren
4719 ;; Verify an even number of quoting characters precede the close.
4720 (= 1 (logand 1 (- (point)
4721 (save-excursion
4722 (forward-char -1)
4724 (point))))))
4725 (let* ((oldpos (point))
4726 (message-log-max nil) ; Don't log messages about paren matching.
4727 (atdollar (eq (syntax-class (syntax-after (1- oldpos))) 8))
4728 (isdollar)
4729 (blinkpos
4730 (save-excursion
4731 (save-restriction
4732 (if blink-matching-paren-distance
4733 (narrow-to-region
4734 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
4735 (- (point) blink-matching-paren-distance))
4736 oldpos))
4737 (let ((parse-sexp-ignore-comments
4738 (and parse-sexp-ignore-comments
4739 (not blink-matching-paren-dont-ignore-comments))))
4740 (condition-case ()
4741 (scan-sexps oldpos -1)
4742 (error nil))))))
4743 (matching-paren
4744 (and blinkpos
4745 ;; Not syntax '$'.
4746 (not (setq isdollar
4747 (eq (syntax-class (syntax-after blinkpos)) 8)))
4748 (let ((syntax (syntax-after blinkpos)))
4749 (and (consp syntax)
4750 (eq (syntax-class syntax) 4)
4751 (cdr syntax))))))
4752 (cond
4753 ;; isdollar is for:
4754 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00871.html
4755 ((not (or (and isdollar blinkpos)
4756 (and atdollar (not blinkpos)) ; see below
4757 (eq matching-paren (char-before oldpos))
4758 ;; The cdr might hold a new paren-class info rather than
4759 ;; a matching-char info, in which case the two CDRs
4760 ;; should match.
4761 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
4762 (message "Mismatched parentheses"))
4763 ((not blinkpos)
4764 (or blink-matching-paren-distance
4765 ;; Don't complain when `$' with no blinkpos, because it
4766 ;; could just be the first one typed in the buffer.
4767 atdollar
4768 (message "Unmatched parenthesis")))
4769 ((pos-visible-in-window-p blinkpos)
4770 ;; Matching open within window, temporarily move to blinkpos but only
4771 ;; if `blink-matching-paren-on-screen' is non-nil.
4772 (and blink-matching-paren-on-screen
4773 (not show-paren-mode)
4774 (save-excursion
4775 (goto-char blinkpos)
4776 (sit-for blink-matching-delay))))
4777 (t
4778 (save-excursion
4779 (goto-char blinkpos)
4780 (let ((open-paren-line-string
4781 ;; Show what precedes the open in its line, if anything.
4782 (cond
4784 (buffer-substring (line-beginning-position)
4785 (1+ blinkpos)))
4786 ;; Show what follows the open in its line, if anything.
4787 ((save-excursion
4788 (forward-char 1)
4790 (not (eolp)))
4791 (buffer-substring blinkpos
4792 (line-end-position)))
4793 ;; Otherwise show the previous nonblank line,
4794 ;; if there is one.
4796 (concat
4797 (buffer-substring (progn
4799 (line-beginning-position))
4800 (progn (end-of-line)
4802 (point)))
4803 ;; Replace the newline and other whitespace with `...'.
4804 "..."
4805 (buffer-substring blinkpos (1+ blinkpos))))
4806 ;; There is nothing to show except the char itself.
4807 (t (buffer-substring blinkpos (1+ blinkpos))))))
4808 (message "Matches %s"
4809 (substring-no-properties open-paren-line-string)))))))))
4811 ;; Turned off because it makes dbx bomb out.
4812 (setq blink-paren-function 'blink-matching-open)
4813 \f
4814 ;; This executes C-g typed while Emacs is waiting for a command.
4815 ;; Quitting out of a program does not go through here;
4816 ;; that happens in the QUIT macro at the C code level.
4817 (defun keyboard-quit ()
4818 "Signal a `quit' condition.
4819 During execution of Lisp code, this character causes a quit directly.
4820 At top-level, as an editor command, this simply beeps."
4821 (interactive)
4822 (deactivate-mark)
4823 (if (fboundp 'kmacro-keyboard-quit)
4824 (kmacro-keyboard-quit))
4825 (setq defining-kbd-macro nil)
4826 (signal 'quit nil))
4828 (defvar buffer-quit-function nil
4831 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4833 (defun keyboard-escape-quit ()
4835 This command can exit an interactive command such as `query-replace',
4836 can clear out a prefix argument or a region,
4837 can get out of the minibuffer or other recursive edit,
4838 cancel the use of the current buffer (for special-purpose buffers),
4839 or go back to just one window (by deleting all but the selected window)."
4840 (interactive)
4841 (cond ((eq last-command 'mode-exited) nil)
4842 ((> (minibuffer-depth) 0)
4843 (abort-recursive-edit))
4844 (current-prefix-arg
4845 nil)
4846 ((and transient-mark-mode mark-active)
4847 (deactivate-mark))
4848 ((> (recursion-depth) 0)
4849 (exit-recursive-edit))
4850 (buffer-quit-function
4851 (funcall buffer-quit-function))
4852 ((not (one-window-p t))
4853 (delete-other-windows))
4855 (bury-buffer))))
4857 (defun play-sound-file (file &optional volume device)
4858 "Play sound stored in FILE.
4859 VOLUME and DEVICE correspond to the keywords of the sound
4860 specification for `play-sound'."
4861 (interactive "fPlay sound file: ")
4862 (let ((sound (list :file file)))
4863 (if volume
4864 (plist-put sound :volume volume))
4865 (if device
4866 (plist-put sound :device device))
4867 (push 'sound sound)
4868 (play-sound sound)))
4870 \f
4871 (defcustom read-mail-command 'rmail
4872 "*Your preference for a mail reading package.
4873 This is used by some keybindings which support reading mail.
4874 See also `mail-user-agent' concerning sending mail."
4875 :type '(choice (function-item rmail)
4876 (function-item gnus)
4877 (function-item mh-rmail)
4878 (function :tag "Other"))
4879 :version "21.1"
4880 :group 'mail)
4882 (defcustom mail-user-agent 'sendmail-user-agent
4883 "*Your preference for a mail composition package.
4884 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4885 outgoing email message. This variable lets you specify which
4886 mail-sending package you prefer.
4888 Valid values include:
4890 `sendmail-user-agent' -- use the default Emacs Mail package.
4891 See Info node `(emacs)Sending Mail'.
4892 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4893 See Info node `(mh-e)'.
4894 `message-user-agent' -- use the Gnus Message package.
4895 See Info node `(message)'.
4896 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4897 paraphernalia, particularly the Gcc: header for
4898 archiving.
4900 Additional valid symbols may be available; check with the author of
4901 your package for details. The function should return non-nil if it
4902 succeeds.
4904 See also `read-mail-command' concerning reading mail."
4905 :type '(radio (function-item :tag "Default Emacs mail"
4907 sendmail-user-agent)
4908 (function-item :tag "Emacs interface to MH"
4910 mh-e-user-agent)
4911 (function-item :tag "Gnus Message package"
4913 message-user-agent)
4914 (function-item :tag "Gnus Message with full Gnus features"
4916 gnus-user-agent)
4917 (function :tag "Other"))
4918 :group 'mail)
4920 (define-mail-user-agent 'sendmail-user-agent
4921 'sendmail-user-agent-compose
4922 'mail-send-and-exit)
4924 (defun rfc822-goto-eoh ()
4925 ;; Go to header delimiter line in a mail message, following RFC822 rules
4926 (goto-char (point-min))
4927 (when (re-search-forward
4929 (goto-char (match-beginning 0))))
4931 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4932 switch-function yank-action
4933 send-actions)
4934 (if switch-function
4935 (let ((special-display-buffer-names nil)
4936 (special-display-regexps nil)
4937 (same-window-buffer-names nil)
4938 (same-window-regexps nil))
4939 (funcall switch-function "*mail*")))
4940 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4941 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4942 (body (cdr (assoc-string "body" other-headers t))))
4943 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4944 continue
4945 (error "Message aborted"))
4946 (save-excursion
4947 (rfc822-goto-eoh)
4948 (while other-headers
4949 (unless (member-ignore-case (car (car other-headers))
4950 '("in-reply-to" "cc" "body"))
4951 (insert (car (car other-headers)) ": "
4952 (cdr (car other-headers))
4954 (setq other-headers (cdr other-headers)))
4955 (when body
4956 (forward-line 1)
4957 (insert body))
4958 t)))
4960 (defun compose-mail (&optional to subject other-headers continue
4961 switch-function yank-action send-actions)
4962 "Start composing a mail message to send.
4963 This uses the user's chosen mail composition package
4964 as selected with the variable `mail-user-agent'.
4965 The optional arguments TO and SUBJECT specify recipients
4966 and the initial Subject field, respectively.
4968 OTHER-HEADERS is an alist specifying additional
4969 header fields. Elements look like (HEADER . VALUE) where both
4970 HEADER and VALUE are strings.
4972 CONTINUE, if non-nil, says to continue editing a message already
4973 being composed.
4975 SWITCH-FUNCTION, if non-nil, is a function to use to
4976 switch to and display the buffer used for mail composition.
4978 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4979 to insert the raw text of the message being replied to.
4980 It has the form (FUNCTION . ARGS). The user agent will apply
4981 FUNCTION to ARGS, to insert the raw text of the original message.
4982 \(The user agent will also run `mail-citation-hook', *after* the
4983 original text has been inserted in this way.)
4985 SEND-ACTIONS is a list of actions to call when the message is sent.
4986 Each action has the form (FUNCTION . ARGS)."
4987 (interactive
4988 (list nil nil nil current-prefix-arg))
4989 (let ((function (get mail-user-agent 'composefunc)))
4990 (funcall function to subject other-headers continue
4991 switch-function yank-action send-actions)))
4993 (defun compose-mail-other-window (&optional to subject other-headers continue
4994 yank-action send-actions)
4996 (interactive
4997 (list nil nil nil current-prefix-arg))
4998 (compose-mail to subject other-headers continue
4999 'switch-to-buffer-other-window yank-action send-actions))
5002 (defun compose-mail-other-frame (&optional to subject other-headers continue
5003 yank-action send-actions)
5005 (interactive
5006 (list nil nil nil current-prefix-arg))
5007 (compose-mail to subject other-headers continue
5008 'switch-to-buffer-other-frame yank-action send-actions))
5009 \f
5010 (defvar set-variable-value-history nil
5011 "History of values entered with `set-variable'.")
5013 (defun set-variable (variable value &optional make-local)
5014 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5015 VARIABLE should be a user option variable name, a Lisp variable
5016 meant to be customized by users. You should enter VALUE in Lisp syntax,
5017 so if you want VALUE to be a string, you must surround it with doublequotes.
5018 VALUE is used literally, not evaluated.
5020 If VARIABLE has a `variable-interactive' property, that is used as if
5021 it were the arg to `interactive' (which see) to interactively read VALUE.
5023 If VARIABLE has been defined with `defcustom', then the type information
5024 in the definition is used to check that VALUE is valid.
5026 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5027 (interactive
5028 (let* ((default-var (variable-at-point))
5029 (var (if (user-variable-p default-var)
5030 (read-variable (format "Set variable (default %s): " default-var)
5031 default-var)
5032 (read-variable "Set variable: ")))
5033 (minibuffer-help-form '(describe-variable var))
5034 (prop (get var 'variable-interactive))
5035 (obsolete (car (get var 'byte-obsolete-variable)))
5036 (prompt (format "Set %s %s to value: " var
5037 (cond ((local-variable-p var)
5038 "(buffer-local)")
5039 ((or current-prefix-arg
5040 (local-variable-if-set-p var))
5041 "buffer-locally")
5042 (t "globally"))))
5043 (val (progn
5044 (when obsolete
5045 (message (concat "`%S' is obsolete; "
5046 (if (symbolp obsolete) "use `%S' instead" "%s"))
5047 var obsolete)
5048 (sit-for 3))
5049 (if prop
5050 ;; Use VAR's `variable-interactive' property
5051 ;; as an interactive spec for prompting.
5052 (call-interactively `(lambda (arg)
5053 (interactive ,prop)
5054 arg))
5055 (read
5056 (read-string prompt nil
5057 'set-variable-value-history
5058 (format "%S" (symbol-value var))))))))
5059 (list var val current-prefix-arg)))
5061 (and (custom-variable-p variable)
5062 (not (get variable 'custom-type))
5063 (custom-load-symbol variable))
5064 (let ((type (get variable 'custom-type)))
5065 (when type
5066 ;; Match with custom type.
5067 (require 'cus-edit)
5068 (setq type (widget-convert type))
5069 (unless (widget-apply type :match value)
5070 (error "Value `%S' does not match type %S of %S"
5071 value (car type) variable))))
5073 (if make-local
5074 (make-local-variable variable))
5076 (set variable value)
5078 ;; Force a thorough redisplay for the case that the variable
5079 ;; has an effect on the display, like `tab-width' has.
5080 (force-mode-line-update))
5081 \f
5082 ;; Define the major mode for lists of completions.
5084 (defvar completion-list-mode-map nil
5085 "Local map for completion list buffers.")
5086 (or completion-list-mode-map
5087 (let ((map (make-sparse-keymap)))
5088 (define-key map [mouse-2] 'mouse-choose-completion)
5089 (define-key map [follow-link] 'mouse-face)
5090 (define-key map [down-mouse-2] nil)
5091 (define-key map "\C-m" 'choose-completion)
5092 (define-key map "\e\e\e" 'delete-completion-window)
5093 (define-key map [left] 'previous-completion)
5094 (define-key map [right] 'next-completion)
5095 (setq completion-list-mode-map map)))
5097 ;; Completion mode is suitable only for specially formatted data.
5098 (put 'completion-list-mode 'mode-class 'special)
5100 (defvar completion-reference-buffer nil
5101 "Record the buffer that was current when the completion list was requested.
5102 This is a local variable in the completion list buffer.
5103 Initial value is nil to avoid some compiler warnings.")
5105 (defvar completion-no-auto-exit nil
5106 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5107 This also applies to other functions such as `choose-completion'
5108 and `mouse-choose-completion'.")
5110 (defvar completion-base-size nil
5111 "Number of chars at beginning of minibuffer not involved in completion.
5112 This is a local variable in the completion list buffer
5113 but it talks about the buffer in `completion-reference-buffer'.
5114 If this is nil, it means to compare text to determine which part
5115 of the tail end of the buffer's text is involved in completion.")
5117 (defun delete-completion-window ()
5118 "Delete the completion list window.
5119 Go to the window from which completion was requested."
5120 (interactive)
5121 (let ((buf completion-reference-buffer))
5122 (if (one-window-p t)
5123 (if (window-dedicated-p (selected-window))
5124 (delete-frame (selected-frame)))
5125 (delete-window (selected-window))
5126 (if (get-buffer-window buf)
5127 (select-window (get-buffer-window buf))))))
5129 (defun previous-completion (n)
5130 "Move to the previous item in the completion list."
5131 (interactive "p")
5132 (next-completion (- n)))
5134 (defun next-completion (n)
5135 "Move to the next item in the completion list.
5136 With prefix argument N, move N items (negative N means move backward)."
5137 (interactive "p")
5138 (let ((beg (point-min)) (end (point-max)))
5139 (while (and (> n 0) (not (eobp)))
5140 ;; If in a completion, move to the end of it.
5141 (when (get-text-property (point) 'mouse-face)
5142 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5143 ;; Move to start of next one.
5144 (unless (get-text-property (point) 'mouse-face)
5145 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5146 (setq n (1- n)))
5147 (while (and (< n 0) (not (bobp)))
5148 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5149 ;; If in a completion, move to the start of it.
5150 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5151 (goto-char (previous-single-property-change
5152 (point) 'mouse-face nil beg)))
5153 ;; Move to end of the previous completion.
5154 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5155 (goto-char (previous-single-property-change
5156 (point) 'mouse-face nil beg)))
5157 ;; Move to the start of that one.
5158 (goto-char (previous-single-property-change
5159 (point) 'mouse-face nil beg))
5160 (setq n (1+ n))))))
5162 (defun choose-completion ()
5163 "Choose the completion that point is in or next to."
5164 (interactive)
5165 (let (beg end completion (buffer completion-reference-buffer)
5166 (base-size completion-base-size))
5167 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
5168 (setq end (point) beg (1+ (point))))
5169 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
5170 (setq end (1- (point)) beg (point)))
5171 (if (null beg)
5172 (error "No completion here"))
5173 (setq beg (previous-single-property-change beg 'mouse-face))
5174 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
5175 (setq completion (buffer-substring-no-properties beg end))
5176 (let ((owindow (selected-window)))
5177 (if (and (one-window-p t 'selected-frame)
5178 (window-dedicated-p (selected-window)))
5179 ;; This is a special buffer's frame
5180 (iconify-frame (selected-frame))
5181 (or (window-dedicated-p (selected-window))
5182 (bury-buffer)))
5183 (select-window owindow))
5184 (choose-completion-string completion buffer base-size)))
5186 ;; Delete the longest partial match for STRING
5187 ;; that can be found before POINT.
5188 (defun choose-completion-delete-max-match (string)
5189 (let ((opoint (point))
5190 len)
5191 ;; Try moving back by the length of the string.
5192 (goto-char (max (- (point) (length string))
5193 (minibuffer-prompt-end)))
5194 ;; See how far back we were actually able to move. That is the
5195 ;; upper bound on how much we can match and delete.
5196 (setq len (- opoint (point)))
5197 (if completion-ignore-case
5198 (setq string (downcase string)))
5199 (while (and (> len 0)
5200 (let ((tail (buffer-substring (point) opoint)))
5201 (if completion-ignore-case
5202 (setq tail (downcase tail)))
5203 (not (string= tail (substring string 0 len)))))
5204 (setq len (1- len))
5205 (forward-char 1))
5206 (delete-char len)))
5208 (defvar choose-completion-string-functions nil
5209 "Functions that may override the normal insertion of a completion choice.
5210 These functions are called in order with four arguments:
5211 CHOICE - the string to insert in the buffer,
5212 BUFFER - the buffer in which the choice should be inserted,
5213 MINI-P - non-nil if BUFFER is a minibuffer, and
5214 BASE-SIZE - the number of characters in BUFFER before
5215 the string being completed.
5217 If a function in the list returns non-nil, that function is supposed
5218 to have inserted the CHOICE in the BUFFER, and possibly exited
5219 the minibuffer; no further functions will be called.
5221 If all functions in the list return nil, that means to use
5222 the default method of inserting the completion in BUFFER.")
5224 (defun choose-completion-string (choice &optional buffer base-size)
5225 "Switch to BUFFER and insert the completion choice CHOICE.
5226 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
5227 to keep. If it is nil, we call `choose-completion-delete-max-match'
5228 to decide what to delete."
5230 ;; If BUFFER is the minibuffer, exit the minibuffer
5231 ;; unless it is reading a file name and CHOICE is a directory,
5232 ;; or completion-no-auto-exit is non-nil.
5234 (let* ((buffer (or buffer completion-reference-buffer))
5235 (mini-p (minibufferp buffer)))
5236 ;; If BUFFER is a minibuffer, barf unless it's the currently
5237 ;; active minibuffer.
5238 (if (and mini-p
5239 (or (not (active-minibuffer-window))
5240 (not (equal buffer
5241 (window-buffer (active-minibuffer-window))))))
5242 (error "Minibuffer is not active for completion")
5243 ;; Set buffer so buffer-local choose-completion-string-functions works.
5244 (set-buffer buffer)
5245 (unless (run-hook-with-args-until-success
5246 'choose-completion-string-functions
5247 choice buffer mini-p base-size)
5248 ;; Insert the completion into the buffer where it was requested.
5249 (if base-size
5250 (delete-region (+ base-size (if mini-p
5251 (minibuffer-prompt-end)
5252 (point-min)))
5253 (point))
5254 (choose-completion-delete-max-match choice))
5255 (insert choice)
5256 (remove-text-properties (- (point) (length choice)) (point)
5257 '(mouse-face nil))
5258 ;; Update point in the window that BUFFER is showing in.
5259 (let ((window (get-buffer-window buffer t)))
5260 (set-window-point window (point)))
5261 ;; If completing for the minibuffer, exit it with this choice.
5262 (and (not completion-no-auto-exit)
5263 (equal buffer (window-buffer (minibuffer-window)))
5264 minibuffer-completion-table
5265 ;; If this is reading a file name, and the file name chosen
5266 ;; is a directory, don't exit the minibuffer.
5267 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
5268 (file-directory-p (field-string (point-max))))
5269 (let ((mini (active-minibuffer-window)))
5270 (select-window mini)
5271 (when minibuffer-auto-raise
5272 (raise-frame (window-frame mini))))
5273 (exit-minibuffer)))))))
5275 (defun completion-list-mode ()
5276 "Major mode for buffers showing lists of possible completions.
5278 to select the completion near point.
5280 with the mouse."
5281 (interactive)
5282 (kill-all-local-variables)
5283 (use-local-map completion-list-mode-map)
5284 (setq mode-name "Completion List")
5285 (setq major-mode 'completion-list-mode)
5286 (make-local-variable 'completion-base-size)
5287 (setq completion-base-size nil)
5288 (run-mode-hooks 'completion-list-mode-hook))
5290 (defun completion-list-mode-finish ()
5291 "Finish setup of the completions buffer.
5292 Called from `temp-buffer-show-hook'."
5293 (when (eq major-mode 'completion-list-mode)
5294 (toggle-read-only 1)))
5296 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
5298 (defvar completion-setup-hook nil
5299 "Normal hook run at the end of setting up a completion list buffer.
5300 When this hook is run, the current buffer is the one in which the
5301 command to display the completion list buffer was run.
5302 The completion list buffer is available as the value of `standard-output'.
5303 The common prefix substring for completion may be available as the
5304 value of `completion-common-substring'. See also `display-completion-list'.")
5307 ;; Variables and faces used in `completion-setup-function'.
5309 (defcustom completion-show-help t
5310 "Non-nil means show help message in *Completions* buffer."
5311 :type 'boolean
5312 :version "22.1"
5313 :group 'completion)
5315 (defface completions-first-difference
5316 '((t (:inherit bold)))
5317 "Face put on the first uncommon character in completions in *Completions* buffer."
5318 :group 'completion)
5320 (defface completions-common-part
5321 '((t (:inherit default)))
5322 "Face put on the common prefix substring in completions in *Completions* buffer.
5323 The idea of `completions-common-part' is that you can use it to
5324 make the common parts less visible than normal, so that the rest
5325 of the differing parts is, by contrast, slightly highlighted."
5326 :group 'completion)
5328 ;; This is for packages that need to bind it to a non-default regexp
5329 ;; in order to make the first-differing character highlight work
5330 ;; to their liking
5331 (defvar completion-root-regexp "^/"
5332 "Regexp to use in `completion-setup-function' to find the root directory.")
5334 (defvar completion-common-substring nil
5335 "Common prefix substring to use in `completion-setup-function' to put faces.
5336 The value is set by `display-completion-list' during running `completion-setup-hook'.
5338 To put faces `completions-first-difference' and `completions-common-part'
5339 in the `*Completions*' buffer, the common prefix substring in completions
5340 is needed as a hint. (The minibuffer is a special case. The content
5341 of the minibuffer before point is always the common substring.)")
5343 ;; This function goes in completion-setup-hook, so that it is called
5344 ;; after the text of the completion list buffer is written.
5345 (defun completion-setup-function ()
5346 (let* ((mainbuf (current-buffer))
5347 (mbuf-contents (minibuffer-completion-contents))
5348 common-string-length)
5349 ;; When reading a file name in the minibuffer,
5350 ;; set default-directory in the minibuffer
5351 ;; so it will get copied into the completion list buffer.
5352 (if minibuffer-completing-file-name
5353 (with-current-buffer mainbuf
5354 (setq default-directory
5355 (file-name-directory (expand-file-name mbuf-contents)))))
5356 (with-current-buffer standard-output
5357 (completion-list-mode)
5358 (set (make-local-variable 'completion-reference-buffer) mainbuf)
5359 (setq completion-base-size
5360 (cond
5361 ((and (symbolp minibuffer-completion-table)
5362 (get minibuffer-completion-table 'completion-base-size-function))
5363 ;; To compute base size, a function can use the global value of
5364 ;; completion-common-substring or minibuffer-completion-contents.
5365 (with-current-buffer mainbuf
5366 (funcall (get minibuffer-completion-table
5367 'completion-base-size-function))))
5368 (minibuffer-completing-file-name
5369 ;; For file name completion, use the number of chars before
5370 ;; the start of the file name component at point.
5371 (with-current-buffer mainbuf
5372 (save-excursion
5373 (skip-chars-backward completion-root-regexp)
5374 (- (point) (minibuffer-prompt-end)))))
5375 (minibuffer-completing-symbol nil)
5376 ;; Otherwise, in minibuffer, the base size is 0.
5377 ((minibufferp mainbuf) 0)))
5378 (setq common-string-length
5379 (cond
5380 (completion-common-substring
5381 (length completion-common-substring))
5382 (completion-base-size
5383 (- (length mbuf-contents) completion-base-size))))
5384 ;; Put faces on first uncommon characters and common parts.
5385 (when (and (integerp common-string-length) (>= common-string-length 0))
5386 (let ((element-start (point-min))
5387 (maxp (point-max))
5388 element-common-end)
5389 (while (and (setq element-start
5390 (next-single-property-change
5391 element-start 'mouse-face))
5392 (< (setq element-common-end
5393 (+ element-start common-string-length))
5394 maxp))
5395 (when (get-char-property element-start 'mouse-face)
5396 (if (and (> common-string-length 0)
5397 (get-char-property (1- element-common-end) 'mouse-face))
5398 (put-text-property element-start element-common-end
5399 'font-lock-face 'completions-common-part))
5400 (if (get-char-property element-common-end 'mouse-face)
5401 (put-text-property element-common-end (1+ element-common-end)
5402 'font-lock-face 'completions-first-difference))))))
5403 ;; Maybe insert help string.
5404 (when completion-show-help
5405 (goto-char (point-min))
5406 (if (display-mouse-p)
5407 (insert (substitute-command-keys
5409 (insert (substitute-command-keys
5413 (add-hook 'completion-setup-hook 'completion-setup-function)
5415 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5416 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
5418 (defun switch-to-completions ()
5419 "Select the completion list window."
5420 (interactive)
5421 ;; Make sure we have a completions window.
5422 (or (get-buffer-window "*Completions*")
5423 (minibuffer-completion-help))
5424 (let ((window (get-buffer-window "*Completions*")))
5425 (when window
5426 (select-window window)
5427 (goto-char (point-min))
5429 (forward-line 1))))
5430 \f
5431 ;;; Support keyboard commands to turn on various modifiers.
5433 ;; These functions -- which are not commands -- each add one modifier
5434 ;; to the following event.
5436 (defun event-apply-alt-modifier (ignore-prompt)
5439 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5440 (defun event-apply-super-modifier (ignore-prompt)
5443 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5444 (defun event-apply-hyper-modifier (ignore-prompt)
5447 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5448 (defun event-apply-shift-modifier (ignore-prompt)
5451 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5452 (defun event-apply-control-modifier (ignore-prompt)
5455 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5456 (defun event-apply-meta-modifier (ignore-prompt)
5459 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5461 (defun event-apply-modifier (event symbol lshiftby prefix)
5462 "Apply a modifier flag to event EVENT.
5463 SYMBOL is the name of this modifier, as a symbol.
5464 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5465 PREFIX is the string that represents this modifier in an event type symbol."
5466 (if (numberp event)
5467 (cond ((eq symbol 'control)
5468 (if (and (<= (downcase event) ?z)
5469 (>= (downcase event) ?a))
5470 (- (downcase event) ?a -1)
5471 (if (and (<= (downcase event) ?Z)
5472 (>= (downcase event) ?A))
5473 (- (downcase event) ?A -1)
5474 (logior (lsh 1 lshiftby) event))))
5475 ((eq symbol 'shift)
5476 (if (and (<= (downcase event) ?z)
5477 (>= (downcase event) ?a))
5478 (upcase event)
5479 (logior (lsh 1 lshiftby) event)))
5480 (t
5481 (logior (lsh 1 lshiftby) event)))
5482 (if (memq symbol (event-modifiers event))
5483 event
5484 (let ((event-type (if (symbolp event) event (car event))))
5485 (setq event-type (intern (concat prefix (symbol-name event-type))))
5486 (if (symbolp event)
5487 event-type
5488 (cons event-type (cdr event)))))))
5490 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5491 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5492 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5493 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5494 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5495 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5496 \f
5497 ;;;; Keypad support.
5499 ;; Make the keypad keys act like ordinary typing keys. If people add
5500 ;; bindings for the function key symbols, then those bindings will
5501 ;; override these, so this shouldn't interfere with any existing
5502 ;; bindings.
5504 ;; Also tell read-char how to handle these keys.
5505 (mapc
5506 (lambda (keypad-normal)
5507 (let ((keypad (nth 0 keypad-normal))
5508 (normal (nth 1 keypad-normal)))
5509 (put keypad 'ascii-character normal)
5510 (define-key function-key-map (vector keypad) (vector normal))))
5511 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5512 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5513 (kp-space ?\s)
5516 (kp-multiply ?*)
5517 (kp-add ?+)
5518 (kp-separator ?,)
5519 (kp-subtract ?-)
5520 (kp-decimal ?.)
5521 (kp-divide ?/)
5522 (kp-equal ?=)))
5523 \f
5524 ;;;;
5525 ;;;; forking a twin copy of a buffer.
5526 ;;;;
5528 (defvar clone-buffer-hook nil
5529 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5531 (defun clone-process (process &optional newname)
5532 "Create a twin copy of PROCESS.
5533 If NEWNAME is nil, it defaults to PROCESS' name;
5534 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5535 If PROCESS is associated with a buffer, the new process will be associated
5536 with the current buffer instead.
5537 Returns nil if PROCESS has already terminated."
5538 (setq newname (or newname (process-name process)))
5540 (setq newname (substring newname 0 (match-beginning 0))))
5541 (when (memq (process-status process) '(run stop open))
5542 (let* ((process-connection-type (process-tty-name process))
5543 (new-process
5544 (if (memq (process-status process) '(open))
5545 (let ((args (process-contact process t)))
5546 (setq args (plist-put args :name newname))
5547 (setq args (plist-put args :buffer
5548 (if (process-buffer process)
5549 (current-buffer))))
5550 (apply 'make-network-process args))
5551 (apply 'start-process newname
5552 (if (process-buffer process) (current-buffer))
5553 (process-command process)))))
5554 (set-process-query-on-exit-flag
5555 new-process (process-query-on-exit-flag process))
5556 (set-process-inherit-coding-system-flag
5557 new-process (process-inherit-coding-system-flag process))
5558 (set-process-filter new-process (process-filter process))
5559 (set-process-sentinel new-process (process-sentinel process))
5560 (set-process-plist new-process (copy-sequence (process-plist process)))
5561 new-process)))
5563 ;; things to maybe add (currently partly covered by `funcall mode'):
5564 ;; - syntax-table
5565 ;; - overlays
5566 (defun clone-buffer (&optional newname display-flag)
5567 "Create and return a twin copy of the current buffer.
5568 Unlike an indirect buffer, the new buffer can be edited
5569 independently of the old one (if it is not read-only).
5570 NEWNAME is the name of the new buffer. It may be modified by
5571 adding or incrementing <N> at the end as necessary to create a
5572 unique buffer name. If nil, it defaults to the name of the
5573 current buffer, with the proper suffix. If DISPLAY-FLAG is
5574 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5575 clone a file-visiting buffer, or a buffer whose major mode symbol
5576 has a non-nil `no-clone' property, results in an error.
5578 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5579 current buffer with appropriate suffix. However, if a prefix
5580 argument is given, then the command prompts for NEWNAME in the
5581 minibuffer.
5583 This runs the normal hook `clone-buffer-hook' in the new buffer
5584 after it has been set up properly in other respects."
5585 (interactive
5586 (progn
5587 (if buffer-file-name
5588 (error "Cannot clone a file-visiting buffer"))
5589 (if (get major-mode 'no-clone)
5590 (error "Cannot clone a buffer in %s mode" mode-name))
5591 (list (if current-prefix-arg
5592 (read-buffer "Name of new cloned buffer: " (current-buffer)))
5593 t)))
5594 (if buffer-file-name
5595 (error "Cannot clone a file-visiting buffer"))
5596 (if (get major-mode 'no-clone)
5597 (error "Cannot clone a buffer in %s mode" mode-name))
5598 (setq newname (or newname (buffer-name)))
5600 (setq newname (substring newname 0 (match-beginning 0))))
5601 (let ((buf (current-buffer))
5602 (ptmin (point-min))
5603 (ptmax (point-max))
5604 (pt (point))
5605 (mk (if mark-active (mark t)))
5606 (modified (buffer-modified-p))
5607 (mode major-mode)
5608 (lvars (buffer-local-variables))
5609 (process (get-buffer-process (current-buffer)))
5610 (new (generate-new-buffer (or newname (buffer-name)))))
5611 (save-restriction
5612 (widen)
5613 (with-current-buffer new
5614 (insert-buffer-substring buf)))
5615 (with-current-buffer new
5616 (narrow-to-region ptmin ptmax)
5617 (goto-char pt)
5618 (if mk (set-mark mk))
5619 (set-buffer-modified-p modified)
5621 ;; Clone the old buffer's process, if any.
5622 (when process (clone-process process))
5624 ;; Now set up the major mode.
5625 (funcall mode)
5627 ;; Set up other local variables.
5628 (mapc (lambda (v)
5629 (condition-case () ;in case var is read-only
5630 (if (symbolp v)
5631 (makunbound v)
5632 (set (make-local-variable (car v)) (cdr v)))
5633 (error nil)))
5634 lvars)
5636 ;; Run any hooks (typically set up by the major mode
5637 ;; for cloning to work properly).
5638 (run-hooks 'clone-buffer-hook))
5639 (if display-flag
5640 ;; Presumably the current buffer is shown in the selected frame, so
5641 ;; we want to display the clone elsewhere.
5642 (let ((same-window-regexps nil)
5643 (same-window-buffer-names))
5644 (pop-to-buffer new)))
5645 new))
5648 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5649 "Create an indirect buffer that is a twin copy of the current buffer.
5651 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5652 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5653 or if not called with a prefix arg, NEWNAME defaults to the current
5654 buffer's name. The name is modified by adding a `<N>' suffix to it
5655 or by incrementing the N in an existing suffix.
5657 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5658 This is always done when called interactively.
5660 Optional third arg NORECORD non-nil means do not put this buffer at the
5661 front of the list of recently selected ones."
5662 (interactive
5663 (progn
5664 (if (get major-mode 'no-clone-indirect)
5665 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5666 (list (if current-prefix-arg
5667 (read-buffer "Name of indirect buffer: " (current-buffer)))
5668 t)))
5669 (if (get major-mode 'no-clone-indirect)
5670 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5671 (setq newname (or newname (buffer-name)))
5673 (setq newname (substring newname 0 (match-beginning 0))))
5674 (let* ((name (generate-new-buffer-name newname))
5675 (buffer (make-indirect-buffer (current-buffer) name t)))
5676 (when display-flag
5677 (pop-to-buffer buffer norecord))
5678 buffer))
5681 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
5682 "Like `clone-indirect-buffer' but display in another window."
5683 (interactive
5684 (progn
5685 (if (get major-mode 'no-clone-indirect)
5686 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5687 (list (if current-prefix-arg
5688 (read-buffer "Name of indirect buffer: " (current-buffer)))
5689 t)))
5690 (let ((pop-up-windows t))
5691 (clone-indirect-buffer newname display-flag norecord)))
5693 \f
5694 ;;; Handling of Backspace and Delete keys.
5696 (defcustom normal-erase-is-backspace 'maybe
5697 "Set the default behavior of the Delete and Backspace keys.
5699 If set to t, Delete key deletes forward and Backspace key deletes
5700 backward.
5702 If set to nil, both Delete and Backspace keys delete backward.
5704 If set to 'maybe (which is the default), Emacs automatically
5705 selects a behavior. On window systems, the behavior depends on
5706 the keyboard used. If the keyboard has both a Backspace key and
5707 a Delete key, and both are mapped to their usual meanings, the
5708 option's default value is set to t, so that Backspace can be used
5709 to delete backward, and Delete can be used to delete forward.
5711 If not running under a window system, customizing this option
5712 accomplishes a similar effect by mapping C-h, which is usually
5713 generated by the Backspace key, to DEL, and by mapping DEL to C-d
5714 via `keyboard-translate'. The former functionality of C-h is
5715 available on the F1 key. You should probably not use this
5716 setting if you don't have both Backspace, Delete and F1 keys.
5718 Setting this variable with setq doesn't take effect. Programmatically,
5719 call `normal-erase-is-backspace-mode' (which see) instead."
5720 :type '(choice (const :tag "Off" nil)
5721 (const :tag "Maybe" maybe)
5722 (other :tag "On" t))
5723 :group 'editing-basics
5724 :version "21.1"
5725 :set (lambda (symbol value)
5726 ;; The fboundp is because of a problem with :set when
5727 ;; dumping Emacs. It doesn't really matter.
5728 (if (fboundp 'normal-erase-is-backspace-mode)
5729 (normal-erase-is-backspace-mode (or value 0))
5730 (set-default symbol value))))
5732 (defun normal-erase-is-backspace-setup-frame (&optional frame)
5733 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
5734 (unless frame (setq frame (selected-frame)))
5735 (with-selected-frame frame
5736 (unless (terminal-parameter nil 'normal-erase-is-backspace)
5737 (normal-erase-is-backspace-mode
5738 (if (if (eq normal-erase-is-backspace 'maybe)
5739 (and (not noninteractive)
5740 (or (memq system-type '(ms-dos windows-nt))
5741 (eq window-system 'mac)
5742 (and (memq window-system '(x))
5743 (fboundp 'x-backspace-delete-keys-p)
5744 (x-backspace-delete-keys-p))
5745 ;; If the terminal Emacs is running on has erase char
5746 ;; set to ^H, use the Backspace key for deleting
5747 ;; backward, and the Delete key for deleting forward.
5748 (and (null window-system)
5749 (eq tty-erase-char ?\^H))))
5750 normal-erase-is-backspace)
5751 1 0)))))
5753 (defun normal-erase-is-backspace-mode (&optional arg)
5754 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5756 With numeric arg, turn the mode on if and only if ARG is positive.
5758 On window systems, when this mode is on, Delete is mapped to C-d
5759 and Backspace is mapped to DEL; when this mode is off, both
5760 Delete and Backspace are mapped to DEL. (The remapping goes via
5761 `local-function-key-map', so binding Delete or Backspace in the
5762 global or local keymap will override that.)
5764 In addition, on window systems, the bindings of C-Delete, M-Delete,
5765 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5766 the global keymap in accordance with the functionality of Delete and
5767 Backspace. For example, if Delete is remapped to C-d, which deletes
5768 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5769 to DEL, which deletes backward, C-Delete is bound to
5770 `backward-kill-word'.
5772 If not running on a window system, a similar effect is accomplished by
5773 remapping C-h (normally produced by the Backspace key) and DEL via
5774 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5775 to C-d; if it's off, the keys are not remapped.
5777 When not running on a window system, and this mode is turned on, the
5778 former functionality of C-h is available on the F1 key. You should
5779 probably not turn on this mode on a text-only terminal if you don't
5780 have both Backspace, Delete and F1 keys.
5782 See also `normal-erase-is-backspace'."
5783 (interactive "P")
5784 (let ((enabled (or (and arg (> (prefix-numeric-value arg) 0))
5785 (and (not arg)
5786 (not (eq 1 (terminal-parameter
5787 nil 'normal-erase-is-backspace)))))))
5788 (set-terminal-parameter nil 'normal-erase-is-backspace
5789 (if enabled 1 0))
5791 (cond ((or (memq window-system '(x w32 mac pc))
5792 (memq system-type '(ms-dos windows-nt)))
5793 (let* ((bindings
5794 `(([C-delete] [C-backspace])
5795 ([M-delete] [M-backspace])
5796 ([C-M-delete] [C-M-backspace])
5797 (,esc-map
5798 [C-delete] [C-backspace])))
5799 (old-state (lookup-key local-function-key-map [delete])))
5801 (if enabled
5802 (progn
5803 (define-key local-function-key-map [delete] [?\C-d])
5804 (define-key local-function-key-map [kp-delete] [?\C-d])
5805 (define-key local-function-key-map [backspace] [?\C-?]))
5806 (define-key local-function-key-map [delete] [?\C-?])
5807 (define-key local-function-key-map [kp-delete] [?\C-?])
5808 (define-key local-function-key-map [backspace] [?\C-?]))
5810 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5811 (unless (equal old-state (lookup-key local-function-key-map [delete]))
5812 (dolist (binding bindings)
5813 (let ((map global-map))
5814 (when (keymapp (car binding))
5815 (setq map (car binding) binding (cdr binding)))
5816 (let* ((key1 (nth 0 binding))
5817 (key2 (nth 1 binding))
5818 (binding1 (lookup-key map key1))
5819 (binding2 (lookup-key map key2)))
5820 (define-key map key1 binding2)
5821 (define-key map key2 binding1)))))))
5822 (t
5823 (if enabled
5824 (progn
5825 (keyboard-translate ?\C-h ?\C-?)
5826 (keyboard-translate ?\C-? ?\C-d))
5827 (keyboard-translate ?\C-h ?\C-h)
5828 (keyboard-translate ?\C-? ?\C-?))))
5830 (run-hooks 'normal-erase-is-backspace-hook)
5831 (if (interactive-p)
5832 (message "Delete key deletes %s"
5833 (if (terminal-parameter nil 'normal-erase-is-backspace)
5834 "forward" "backward")))))
5835 \f
5836 (defvar vis-mode-saved-buffer-invisibility-spec nil
5837 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5839 (define-minor-mode visible-mode
5840 "Toggle Visible mode.
5841 With argument ARG turn Visible mode on if ARG is positive, otherwise
5842 turn it off.
5844 Enabling Visible mode makes all invisible text temporarily visible.
5845 Disabling Visible mode turns off that effect. Visible mode
5846 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5847 :lighter " Vis"
5848 :group 'editing-basics
5849 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5850 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5851 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5852 (when visible-mode
5853 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5854 buffer-invisibility-spec)
5855 (setq buffer-invisibility-spec nil)))
5856 \f
5857 ;; Minibuffer prompt stuff.
5859 ;(defun minibuffer-prompt-modification (start end)
5860 ; (error "You cannot modify the prompt"))
5861 ;
5862 ;
5863 ;(defun minibuffer-prompt-insertion (start end)
5864 ; (let ((inhibit-modification-hooks t))
5865 ; (delete-region start end)
5866 ; ;; Discard undo information for the text insertion itself
5867 ; ;; and for the text deletion.above.
5868 ; (when (consp buffer-undo-list)
5869 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5870 ; (message "You cannot modify the prompt")))
5871 ;
5872 ;
5873 ;(setq minibuffer-prompt-properties
5874 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5875 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5876 ;
5878 \f
5879 ;;;; Problematic external packages.
5881 ;; rms says this should be done by specifying symbols that define
5882 ;; versions together with bad values. This is therefore not as
5883 ;; flexible as it could be. See the thread:
5884 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
5885 (defconst bad-packages-alist
5886 ;; Not sure exactly which semantic versions have problems.
5887 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
5889 "The version of `semantic' loaded does not work in Emacs 22.
5890 It can cause constant high CPU load.
5891 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
5892 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
5893 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
5894 ;; provided the `CUA-mode' feature. Since this is no longer true,
5895 ;; we can warn the user if the `CUA-mode' feature is ever provided.
5896 (CUA-mode t nil
5897 "CUA-mode is now part of the standard GNU Emacs distribution,
5898 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
5900 You have loaded an older version of CUA-mode which does not work
5901 correctly with this version of Emacs. You should remove the old
5902 version and use the one distributed with Emacs."))
5903 "Alist of packages known to cause problems in this version of Emacs.
5904 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
5905 PACKAGE is either a regular expression to match file names, or a
5906 symbol (a feature name); see the documentation of
5907 `after-load-alist', to which this variable adds functions.
5908 SYMBOL is either the name of a string variable, or `t'. Upon
5909 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
5910 warning using STRING as the message.")
5912 (defun bad-package-check (package)
5913 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
5914 (condition-case nil
5915 (let* ((list (assoc package bad-packages-alist))
5916 (symbol (nth 1 list)))
5917 (and list
5918 (boundp symbol)
5919 (or (eq symbol t)
5920 (and (stringp (setq symbol (eval symbol)))
5921 (string-match (nth 2 list) symbol)))
5922 (display-warning :warning (nth 3 list))))
5923 (error nil)))
5925 (mapc (lambda (elem)
5926 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
5927 bad-packages-alist)
5930 (provide 'simple)
5932 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5933 ;;; simple.el ends here