| blob | 8b9ab8c06222e244a025aa499797b2900610aa7f |
1 ;;; simple.el --- basic editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Maintainer: FSF
8 ;; Keywords: internal
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, 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:
40 "*Idle time delay before updating various things on the screen.
41 Various Emacs features that update auxiliary information when point moves
42 wait this many seconds after Emacs becomes idle before doing an update."
48 "Killing and yanking commands."
52 "Highlight (un)matching of parens and expressions."
56 "Search LIST for a valid buffer to display in FRAME.
57 Return nil when all buffers in LIST are undesirable for display,
58 otherwise return the first suitable buffer in LIST.
60 Buffers not visible in windows are preferred to visible buffers,
61 unless VISIBLE-OK is non-nil.
62 If the optional argument FRAME is nil, it defaults to the selected frame.
63 If BUFFER is non-nil, ignore occurrences of that buffer in LIST."
64 ;; This logic is more or less copied from other-buffer.
67 found buf)
80 "Return the last non-hidden displayable buffer in the buffer list.
81 If BUFFER is non-nil, last-buffer will ignore that buffer.
82 Buffers not visible in windows are preferred to visible buffers,
83 unless optional argument VISIBLE-OK is non-nil.
84 If the optional third argument FRAME is non-nil, use that frame's
85 buffer list instead of the selected frame's buffer list.
86 If no other buffer exists, the buffer `*scratch*' is returned."
89 buffer visible-ok frame)
94 "Switch to the next buffer in cyclic order."
101 "Switch to the previous buffer in cyclic order."
105 \f
106 ;;; next-error support framework
109 "`next-error' support framework."
115 "Face used to highlight next error locus."
120 "*Highlighting of locations in selected source buffers.
121 If a number, highlight the locus in `next-error' face for the given time
122 in seconds, or until the next command is executed.
123 If t, highlight the locus until the next command is executed, or until
124 some other locus replaces it.
125 If nil, don't highlight the locus in the source buffer.
126 If `fringe-arrow', indicate the locus by the fringe arrow."
135 "*Highlighting of locations in `next-error-no-select'.
136 If number, highlight the locus in `next-error' face for given time in seconds.
137 If t, highlight the locus indefinitely until some other locus replaces it.
138 If nil, don't highlight the locus in the source buffer.
139 If `fringe-arrow', indicate the locus by the fringe arrow."
148 "*Display the line in the visited source file recentered as specified.
149 If non-nil, the value is passed directly to `recenter'."
157 "*List of hook functions run by `next-error' after visiting source file."
168 "The most recent `next-error' buffer.
169 A buffer becomes most recent when its compilation, grep, or
174 "Function to use to find the next error in the current buffer.
175 The function is called with 2 parameters:
176 ARG is an integer specifying by how many errors to move.
177 RESET is a boolean which, if non-nil, says to go back to the beginning
178 of the errors before moving.
179 Major modes providing compile-like functionality should set this variable
180 to indicate to `next-error' that this is a candidate buffer and how
186 &optional avoid-current
187 extra-test-inclusive
188 extra-test-exclusive)
189 "Test if BUFFER is a `next-error' capable buffer.
191 If AVOID-CURRENT is non-nil, treat the current buffer
192 as an absolute last resort only.
194 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
195 that normally would not qualify. If it returns t, the buffer
196 in question is treated as usable.
198 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
199 that would normally be considered usable. If it returns nil,
200 that buffer is rejected."
205 ;; Optionally reject some buffers.
208 t)
209 ;; Optionally accept some other buffers.
214 extra-test-inclusive
215 extra-test-exclusive)
216 "Return a `next-error' capable buffer.
218 If AVOID-CURRENT is non-nil, treat the current buffer
219 as an absolute last resort only.
221 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
222 that normally would not qualify. If it returns t, the buffer
223 in question is treated as usable.
225 The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
226 that would normally be considered usable. If it returns nil,
227 that buffer is rejected."
229 ;; 1. If one window on the selected frame displays such buffer, return it.
235 avoid-current
236 extra-test-inclusive extra-test-exclusive)
241 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
244 extra-test-inclusive extra-test-exclusive))
245 next-error-last-buffer)
246 ;; 3. If the current buffer is acceptable, choose it.
248 extra-test-inclusive extra-test-exclusive)
250 ;; 4. Look for any acceptable buffer.
255 extra-test-inclusive extra-test-exclusive)))
258 ;; 5. Use the current buffer as a last resort if it qualifies,
259 ;; even despite AVOID-CURRENT.
262 extra-test-inclusive extra-test-exclusive)
266 ;; 6. Give up.
270 "Visit next `next-error' message and corresponding source code.
272 If all the error messages parsed so far have been processed already,
273 the message buffer is checked for new ones.
275 A prefix ARG specifies how many error messages to move;
276 negative means move back to previous error messages.
278 and start at the first error.
280 The RESET argument specifies that we should restart from the beginning.
283 compilation, grep, or occur buffer. It can also operate on any
285 more generally, on any buffer in Compilation mode or with
286 Compilation Minor mode enabled, or any buffer in which
287 `next-error-function' is bound to an appropriate function.
288 To specify use of a particular buffer for error messages, type
290 in the current frame.
293 runs `next-error-hook' with `run-hooks', and stays with that buffer
294 until you use it in some other buffer which uses Compilation mode
295 or Compilation Minor mode.
297 See variables `compilation-parse-errors-function' and
298 \`compilation-error-regexp-alist' for customization ideas."
302 ;; we know here that next-error-function is a valid symbol we can funcall
310 "Visit the source code corresponding to the `next-error' message at point."
312 ;; we know here that next-error-function is a valid symbol we can funcall
323 "Visit previous `next-error' message and corresponding source code.
325 Prefix arg N says how many error messages to move backwards (or
326 forwards, if negative).
333 "Restart at the first error.
334 Visit corresponding source code.
335 With prefix arg N, visit the source code of the Nth error.
341 "Move point to the next error in the `next-error' buffer and highlight match.
342 Prefix arg N says how many error messages to move forwards (or
343 backwards, if negative).
345 select the source buffer."
352 "Move point to the previous error in the `next-error' buffer and highlight match.
353 Prefix arg N says how many error messages to move backwards (or
354 forwards, if negative).
356 select the source buffer."
360 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
364 "Minor mode for compilation, occur and diff modes.
365 When turned on, cursor motion in the compilation, grep, occur or diff
366 buffer causes automatic display of the corresponding source code
367 location."
374 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
375 ;;; for the *Compilation* *grep* and *Occur* buffers.
385 \f
386 ;;;
389 "Major mode not specialized for anything in particular.
390 Other major modes are defined by comparison with this one."
396 ;; Making and deleting lines.
401 "Insert a newline, and move to left margin of the new line if it's blank.
402 If `use-hard-newlines' is non-nil, the newline is marked with the
403 text-property `hard'.
404 With ARG, insert that many newlines.
405 Call `auto-fill-function' if the current column number is greater
406 than the value of `fill-column' and ARG is nil."
409 ;; Inserting a newline at the end of a line produces better redisplay in
410 ;; try_window_id than inserting at the beginning of a line, and the textual
411 ;; result is the same. So, if we're at beginning of line, pretend to be at
412 ;; the end of the previous line.
415 ;; Make sure no functions want to be told about
416 ;; the range of the changes.
419 ;; Make sure there are no markers here.
422 ;; Make sure no text properties want to know
423 ;; where the change was.
428 ;; Make sure the newline before point isn't intangible.
430 ;; Make sure the newline before point isn't read-only.
432 ;; Make sure the newline before point isn't invisible.
434 ;; Make sure the newline before point has the same
435 ;; properties as the char before it (if any).
442 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
443 ;; Set last-command-char to tell self-insert what to insert.
445 ;; Don't auto-fill if we have a numeric argument.
446 ;; Also not if flag is true (it would fill wrong line);
447 ;; there is no need to since we're at BOL.
451 ;; If we get an error in self-insert-command, put point at right place.
453 ;; Even if we did *not* get an error, keep that forward-char;
454 ;; all further processing should apply to the newline that the user
455 ;; thinks he inserted.
457 ;; Mark the newline(s) `hard'.
461 ;; If the newline leaves the previous line blank,
462 ;; and we have a left margin, delete that from the blank line.
470 ;; Indent the line after the newline, except in one case:
471 ;; when we added the newline at the beginning of a line
472 ;; which starts a page.
475 nil)
480 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
486 "Insert a newline and leave point before it.
487 If there is a fill prefix and/or a `left-margin', insert them
488 on the new line if the line would have been blank.
489 With arg N, insert N newlines."
494 ;; Don't expand an abbrev before point.
508 "Split current line, moving portion beyond point vertically down.
509 If the current line starts with `fill-prefix', insert it on the new
510 line as well. With prefix ARG, don't insert `fill-prefix' on new line.
512 When called from Lisp code, ARG may be a prefix string to copy."
517 ;; What prefix should we check for (nil means don't).
521 ;; Does this line start with it?
532 "Join this line to previous and fix up whitespace at join.
533 If there is a fill prefix, delete it from the beginning of this line.
534 With argument, join this line to following line."
541 ;; If the second line started with the fill prefix,
542 ;; delete the prefix.
554 "On blank line, delete all surrounding blank lines, leaving just one.
555 On isolated blank line, delete that one.
556 On nonblank line, delete any immediately following blank lines."
562 ;; Set singleblank if there is just one blank line here.
569 ;; Delete preceding blank lines, and this one too if it's the only one.
578 ;; Delete following blank lines, unless the current line is blank
579 ;; and there are no following blank lines.
588 ;; Handle the special case where point is followed by newline and eob.
589 ;; Delete the line, leaving point at eob.
594 "Delete all the trailing whitespace across the current buffer.
595 All whitespace after the last non-whitespace character in a line is deleted.
597 A formfeed is not considered whitespace by this function."
604 ;; Don't delete formfeeds, even if they are considered whitespace.
611 "Insert a newline, then indent according to major mode.
612 Indentation is done using the value of `indent-line-function'.
613 In programming language modes, this is the same as TAB.
614 In some text modes, where TAB inserts a tab, this command indents to the
615 column specified by the function `current-left-margin'."
622 "Reindent current line, insert newline, then indent the new line.
623 Indentation of both lines is done according to the current major mode,
624 which means calling the current value of `indent-line-function'.
625 In programming language modes, this is the same as TAB.
626 In some text modes, where TAB inserts a tab, this indents to the
627 column specified by the function `current-left-margin'."
630 ;; Be careful to insert the newline before indenting the line.
631 ;; Otherwise, the indentation might be wrong.
635 ;; We are at EOL before the call to indent-according-to-mode, and
636 ;; after it we usually are as well, but not always. We tried to
637 ;; address it with `save-excursion' but that uses a normal marker
638 ;; whereas we need `move after insertion', so we do the save/restore
639 ;; by hand.
643 ;; Remove the trailing white-space after indentation because
644 ;; indentation may introduce the whitespace.
649 "Read next input character and insert it.
650 This is useful for inserting control characters.
652 If the first character you type after this command is an octal digit,
653 you should type a sequence of octal digits which specify a character code.
654 Any nondigit terminates the sequence. If the terminator is a RET,
655 it is discarded; any other terminator is used itself as input.
656 The variable `read-quoted-char-radix' specifies the radix for this feature;
657 set it to 10 or 16 to use decimal or hex instead of octal.
659 In overwrite mode, this function inserts the character anyway, and
660 does not handle octal digits specially. This means that if you use
661 overwrite as your normal editing mode, you can use this function to
662 insert characters when necessary.
664 In binary overwrite mode, this function does overwrite, and octal
665 digits are interpreted as a character code. This is intended to be
666 useful for editing binary files."
673 ;; Assume character codes 0240 - 0377 stand for characters in some
674 ;; single-byte character set, and convert them to Emacs
675 ;; characters.
688 "Move forward ARG lines and position at first nonblank character."
694 "Move backward ARG lines and position at first nonblank character."
700 "Move point to the first non-whitespace character on this line."
704 ;; Move back over chars that have whitespace syntax but have the p flag.
708 "Fixup white space between objects around point.
709 Leave one space or none, according to the context."
716 nil
720 "Delete all spaces and tabs around point.
721 If BACKWARD-ONLY is non-nil, only delete them before point."
726 orig-pos
735 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
749 \f
751 "Move point to the beginning of the buffer; leave mark at previous position.
753 With numeric arg N, put point N/10 of the way from the beginning.
755 If the buffer is narrowed, this command uses the beginning and size
756 of the accessible part of the buffer.
758 Don't use this command in Lisp programs!
759 \(goto-char (point-min)) is faster and avoids clobbering the mark."
768 ;; Avoid overflow for large buffer sizes!
776 "Move point to the end of the buffer; leave mark at previous position.
778 With numeric arg N, put point N/10 of the way from the end.
780 If the buffer is narrowed, this command uses the beginning and size
781 of the accessible part of the buffer.
783 Don't use this command in Lisp programs!
784 \(goto-char (point-max)) is faster and avoids clobbering the mark."
793 ;; Avoid overflow for large buffer sizes!
798 ;; If we went to a place in the middle of the buffer,
799 ;; adjust it to the beginning of a line.
802 ;; If the end of the buffer is not already on the screen,
803 ;; then scroll specially to put it near, but not at, the bottom.
808 "Put point at beginning and mark at end of buffer.
809 You probably should not use this function in Lisp programs;
810 it is usually a mistake for a Lisp function to use any subroutine
811 that uses or sets the mark."
816 \f
818 ;; Counting lines, one way or another.
821 "Goto line ARG, counting from line 1 at beginning of buffer.
822 Normally, move point in the current buffer, and leave mark at previous
824 in the most recently displayed other buffer, and switch to it.
825 When called from Lisp code, the optional argument BUFFER specifies
826 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 ;; Leave mark at previous position
866 ;; Move to the specified line number in that buffer.
875 "Print number of lines and characters in the region."
881 "Print the current buffer line number and narrowed line number of point."
894 "Return number of lines between START and END.
895 This is usually the number of newlines between them,
896 but can be one more if START is not equal to END
897 and the greater of them is not at the start of a line."
913 done)))
917 "Return (narrowed) buffer line number at position POS.
918 If POS is nil, use current buffer location.
919 Counting starts at (point-min), so the value refers
920 to the contents of the accessible portion of the buffer."
930 "Print info on cursor position (on screen and within buffer).
931 Also describe the character after point, and give its character code
932 in octal, decimal and hex.
934 For a non-ASCII multibyte character, also give its encoding in the
935 buffer's selected coding system if the coding system encodes the
936 character safely. If the character is encoded into one byte, that
937 code is shown in hex. If the character is encoded into more than one
940 In addition, with prefix argument, show details about that character
941 in *Help* buffer. See also the command `describe-char'."
949 ;; Avoid overflow from multiplying by 100!
953 ""
959 pos total percent beg end col hscroll)
961 pos total col hscroll))
963 encoded encoding-msg display-prop under-display)
970 ;; Check if the character is displayed with some `display'
971 ;; text property. In that case, set under-display to the
972 ;; buffer substring covered by that property.
983 under-display)))
989 char char char under-display)
991 char char char under-display display-prop))
994 char char char
996 "..."
1000 ;; We show the detailed information about CHAR.
1007 encoding-msg pos total percent beg end col hscroll)
1014 encoding-msg pos total percent col hscroll))))))
1015 \f
1016 ;; Initialize read-expression-map. It is defined at C level.
1028 "Value for `print-level' while printing value in `eval-expression'.
1029 A value of nil means no limit."
1035 "Value for `print-length' while printing value in `eval-expression'.
1036 A value of nil means no limit."
1042 "If non-nil set `debug-on-error' to t in `eval-expression'.
1043 If nil, don't change the value of `debug-on-error'."
1049 "Format VALUE as a result of evaluated expression.
1050 Return a formatted string which is displayed in the echo area
1051 in addition to the value printed by prin1 in functions which
1052 display the result of expression evaluation."
1065 ;; We define this, rather than making `eval' interactive,
1066 ;; for the sake of completion of names like eval-region, eval-buffer.
1069 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
1070 Value is also consed on to front of the variable `values'.
1071 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
1072 insert the result into the current buffer instead of printing it in
1073 the echo area.
1075 If `eval-expression-debug-on-error' is non-nil, which is the default,
1076 this command arranges for all errors to enter the debugger."
1080 nil read-expression-map t
1082 current-prefix-arg))
1087 ;; Bind debug-on-error to something unique so that we can
1088 ;; detect when evaled code changes it.
1092 ;; If evaled code has changed the value of debug-on-error,
1093 ;; propagate that change to the global binding.
1109 "Prompting with PROMPT, let user edit COMMAND and eval result.
1110 COMMAND is a Lisp expression. Let user edit that expression in
1111 the minibuffer, then read and evaluate the result."
1118 read-expression-map t
1120 ;; If command was added to command-history as a string,
1121 ;; get rid of that. We want only evaluable expressions there.
1125 ;; If command to be redone does not match front of history,
1126 ;; add it to the history.
1132 "Edit and re-evaluate last complex command, or ARGth from last.
1133 A complex command is one which used the minibuffer.
1134 The command is placed in the minibuffer as a Lisp form for editing.
1135 The result is executed, repeating the command as changed.
1136 If the command has been changed or is not the most recent previous command
1137 it is added to the front of the command history.
1138 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1139 to get different commands to edit and resubmit."
1142 newcmd)
1154 ;; If command was added to command-history as a
1155 ;; string, get rid of that. We want only
1156 ;; evaluable expressions there.
1160 ;; If command to be redone does not match front of history,
1161 ;; add it to the history.
1168 \f
1170 "Default minibuffer history list.
1171 This is used for all minibuffer input
1172 except when an alternate history list is specified.
1174 Maximum length of the history list is determined by the value
1177 "Control whether history list elements are expressions or strings.
1178 If the value of this variable equals current minibuffer depth,
1179 they are expressions; otherwise they are strings.
1180 \(That convention is designed to do the right thing for
1187 "Text that was in this minibuffer before any history commands.
1188 This is nil if there have not yet been any history commands
1197 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1201 "*Minibuffer history variables for which matching should ignore case.
1202 If a history variable is a member of this list, then the
1204 commands ignore case when searching it, regardless of `case-fold-search'."
1209 "Find the previous history element that matches REGEXP.
1210 \(Previous history elements refer to earlier actions.)
1211 With prefix argument N, search for Nth previous match.
1212 If N is negative, find the next or Nth next match.
1213 Normally, history elements are matched case-insensitively if
1214 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1215 makes the search case-sensitive.
1216 See also `minibuffer-history-case-insensitive-variables'."
1220 nil
1221 minibuffer-local-map
1222 nil
1223 'minibuffer-history-search-history
1225 ;; Use the last regexp specified, by default, if input is empty.
1230 regexp)
1240 ;; On some systems, ignore case for file names.
1242 minibuffer-history-case-insensitive-variables)
1243 t
1244 ;; Respect the user's setting for case-fold-search:
1245 case-fold-search)
1246 nil))
1247 prevpos
1248 match-string
1249 match-offset
1256 "No later matching history item"
1277 next-matching-history-element))
1281 "Find the next history element that matches REGEXP.
1282 \(The next history element refers to a more recent action.)
1283 With prefix argument N, search for Nth next match.
1284 If N is negative, find the previous or Nth previous match.
1285 Normally, history elements are matched case-insensitively if
1286 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1287 makes the search case-sensitive."
1291 nil
1292 minibuffer-local-map
1293 nil
1294 'minibuffer-history-search-history
1296 ;; Use the last regexp specified, by default, if input is empty.
1301 regexp)
1308 "Puts element of the minibuffer history in the minibuffer.
1309 The argument NABS specifies the absolute history position."
1316 elt minibuffer-returned-to-present)
1328 previous-history-element))
1340 minibuffer-default)))
1352 elt))
1356 "Puts next element of the minibuffer history in the minibuffer.
1357 With argument N, it uses the Nth following element."
1363 "Puts previous element of the minibuffer history in the minibuffer.
1364 With argument N, it uses the Nth previous element."
1370 "Get next history element which completes the minibuffer before the point.
1371 The contents of the minibuffer after the point are deleted, and replaced
1372 by the new completion."
1378 n)
1379 ;; next-matching-history-element always puts us at (point-min).
1380 ;; Move to the position we were at before changing the buffer contents.
1381 ;; This is still sensical, because the text before point has not changed.
1385 "\
1386 Get previous history element which completes the minibuffer before the point.
1387 The contents of the minibuffer after the point are deleted, and replaced
1388 by the new completion."
1392 ;; For compatibility with the old subr of the same name.
1394 "Return the display width of the minibuffer prompt.
1395 Return 0 if current buffer is not a minibuffer."
1396 ;; Return the width of everything before the field at the end of
1397 ;; the buffer; this should be 0 for normal buffers.
1399 \f
1400 ;; isearch minibuffer history
1407 "Set up a minibuffer for using isearch to search the minibuffer history.
1408 Intended to be added to `minibuffer-setup-hook'."
1420 "Clean up the minibuffer after terminating isearch in the minibuffer."
1425 "Return the proper search function, for isearch in minibuffer history."
1432 ;; Use standard functions to search within minibuffer text
1438 found)
1439 ;; Avoid lazy-highlighting matches in the minibuffer prompt when
1440 ;; searching forward. Lazy-highlight calls this lambda with the
1441 ;; bound arg, so skip the minibuffer prompt.
1445 ;; 1. First try searching in the initial minibuffer text
1448 noerror)
1449 ;; 2. If the above search fails, start putting next/prev history
1450 ;; elements in the minibuffer successively, and search the string
1451 ;; in them. Do this only when bound is nil (i.e. not while
1452 ;; lazy-highlighting search strings in the current minibuffer text).
1464 ;; After putting the next/prev history element, search
1465 ;; the string in them again, until next-history-element
1466 ;; or previous-history-element raises an error at the
1467 ;; beginning/end of history.
1470 ;; For backward search, don't search
1471 ;; in the minibuffer prompt
1473 noerror)))
1474 ;; Return point of the new search result
1476 ;; Return nil when next(prev)-history-element fails
1480 "Display the minibuffer history search prompt.
1481 If there are no search errors, this function displays an overlay with
1482 the isearch prompt which replaces the original minibuffer prompt.
1483 Otherwise, it displays the standard isearch message returned from
1484 `isearch-message'."
1486 ;; Use standard function `isearch-message' when not in the minibuffer,
1487 ;; or search fails, or has an error (like incomplete regexp).
1488 ;; This function overwrites minibuffer text with isearch message,
1489 ;; so it's possible to see what is wrong in the search string.
1491 ;; Otherwise, put the overlay with the standard isearch prompt over
1492 ;; the initial minibuffer prompt.
1501 ;; And clear any previous isearch message.
1505 "Wrap the minibuffer history search when search is failed.
1506 Move point to the first history element for a forward search,
1507 or to the last history element for a backward search."
1509 ;; When `minibuffer-history-isearch-search' fails on reaching the
1510 ;; beginning/end of the history, wrap the search to the first/last
1511 ;; minibuffer history element.
1519 "Save a function restoring the state of minibuffer history search.
1520 Save `minibuffer-history-position' to the additional state parameter
1521 in the search status stack."
1526 "Restore the minibuffer history search state.
1527 Go to the history element by the absolute history position `hist-pos'."
1530 \f
1531 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1535 "Table mapping redo records to the corresponding undo one.
1536 A redo record for undo-in-region maps to t.
1546 "Within a run of consecutive undo commands, list remaining to be undone.
1550 "Undo some previous changes.
1551 Repeat this command to undo more changes.
1552 A numeric argument serves as a repeat count.
1554 In Transient Mark mode when the mark is active, only undo changes within
1556 as an argument limits undo to changes within the current region."
1558 ;; Make last-command indicate for the next command that this was an undo.
1559 ;; That way, another undo will undo more.
1560 ;; If we get to the end of the undo history and get an error,
1561 ;; another undo command will find the undo history empty
1562 ;; and will get another error. To begin undoing the undos,
1563 ;; you must type some other command.
1566 message)
1567 ;; If we get an error in undo-start,
1568 ;; the next command should not be a "consecutive undo".
1569 ;; So set `this-command' to something other than `undo'.
1574 ;; If something (a timer or filter?) changed the buffer
1575 ;; since the previous command, don't continue the undo seq.
1579 ;; If the last undo record made was made by undo
1580 ;; it shows nothing else happened in between.
1587 ;; get rid of initial undo boundary
1589 ;; If we got this far, the next command should be a consecutive undo.
1591 ;; Check to see whether we're hitting a redo record, and if
1592 ;; so, ask the user whether she wants to skip the redo/undo pair.
1599 ;; The equiv entry might point to another redo record if we have done
1600 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1608 ;; Record the fact that the just-generated undo records come from an
1609 ;; undo operation--that is, they are redo records.
1610 ;; In the ordinary case (not within a region), map the redo
1611 ;; record to the following undos.
1612 ;; I don't know how to do that in the undo-in-region case.
1615 undo-equiv-table)
1616 ;; Don't specify a position in the undo record for the undo command.
1617 ;; Instead, undoing this should move point to where the change is.
1636 ;; Record what the current undo list says,
1637 ;; so the next command can tell if the buffer was modified in between.
1640 ;; Display a message announcing success.
1645 "Make BUFFER stop keeping undo information.
1646 No argument or nil as argument means do this for the current buffer."
1652 "Undo some previous changes.
1653 Repeat this command to undo more changes.
1654 A numeric argument serves as a repeat count.
1655 Contrary to `undo', this will not redo a previous undo."
1660 "Non-nil while performing an undo.
1664 "Undo back N undo-boundaries beyond what was already undone recently.
1665 Call `undo-start' to get ready to undo recent changes,
1666 then call `undo-more' one or more times to undo them."
1675 ;; Deep copy of a list
1677 "Make a copy of undo list LIST."
1683 elt))
1686 "Set `pending-undo-list' to the front of the undo list.
1687 The next call to `undo-more' will undo the most recently made change.
1688 If BEG and END are specified, then only undo elements
1689 that apply to text between BEG and END are used; other undo elements
1690 are ignored. If BEG and END are nil, all undo elements are used."
1696 buffer-undo-list)))
1701 "Return a list of undo elements for the region START to END.
1702 The elements come from `buffer-undo-list', but we keep only
1703 the elements inside this region, and discard those outside this region.
1704 If we find an element that crosses an edge of this region,
1705 we stop and ignore all further elements."
1708 undo-adjusted-markers
1709 some-rejected
1710 undo-elt undo-elt temp-undo-list delta)
1715 ;; This is a "was unmodified" element.
1716 ;; Keep it if we have kept everything thus far.
1723 ;; Don't put two nils together in the list
1737 ;; Loop down the earlier events adjusting their buffer
1738 ;; positions to reflect the fact that a change to the buffer
1739 ;; isn't being undone. We only need to process those element
1740 ;; types which undo-elt-in-region will return as being in
1741 ;; the region since only those types can ever get into the
1742 ;; output
1751 ;; (TEXT . POSITION)
1758 ;; (BEGIN . END)
1763 ;; (nil PROPERTY VALUE BEG . END)
1773 "Determine whether UNDO-ELT falls inside the region START ... END.
1774 If it crosses the edge, we return nil."
1779 t)
1781 nil)
1783 ;; (TEXT . POSITION)
1787 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1788 ;; See if MARKER is inside the region.
1799 ;; (nil PROPERTY VALUE BEG . END)
1804 ;; (BEGIN . END)
1809 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1810 This assumes we have already decided that UNDO-ELT
1811 is not *inside* the region START...END."
1814 ;; (nil PROPERTY VALUE BEG . END)
1819 ;; (BEGIN . END)
1823 ;; Return the first affected buffer position and the delta for an undo element
1824 ;; delta is defined as the change in subsequent buffer positions if we *did*
1825 ;; the undo.
1829 ;; (TEXT . POSITION)
1832 ;; (BEGIN . END)
1839 "If non-nil ask about discarding undo info for the current command.
1840 Normally, Emacs discards the undo info for the current command if
1841 it exceeds `undo-outer-limit'. But if you set this option
1842 non-nil, it asks in the echo area whether to discard the info.
1843 If you answer no, there is a slight risk that Emacs might crash, so
1844 only do it if you really want to undo the command.
1846 This option is mainly intended for debugging. You have to be
1847 careful if you use it for other purposes. Garbage collection is
1848 inhibited while the question is asked, meaning that Emacs might
1849 leak memory. So you should make sure that you do not wait
1850 excessively long before answering the question."
1856 "If non-nil, an extra level of size that's ok in an undo item.
1857 We don't ask the user about truncating the undo list until the
1858 current item gets bigger than this amount.
1863 ;; When the first undo batch in an undo list is longer than
1864 ;; undo-outer-limit, this function gets called to warn the user that
1865 ;; the undo info for the current command was discarded. Garbage
1866 ;; collection is inhibited around the call, so it had better not do a
1867 ;; lot of consing.
1873 ;; Don't ask the question again unless it gets even bigger.
1874 ;; This applies, in particular, if the user quits from the question.
1875 ;; Such a quit quits out of GC, but something else will call GC
1876 ;; again momentarily. It will call this function again,
1877 ;; but we don't want to ask the question again.
1884 t)
1885 nil))
1890 "The undo info was discarded because it exceeded \
1891 `undo-outer-limit'.
1893 This is normal if you executed a command that made a huge change
1894 to the buffer. In that case, to prevent similar problems in the
1895 future, set `undo-outer-limit' to a value that is large enough to
1896 cover the maximum size of normal changes you expect a single
1897 command to make, but not so large that it might exceed the
1898 maximum memory allotted to Emacs.
1900 If you did not execute any such command, the situation is
1901 probably due to a bug and you should report it.
1903 You can disable the popping up of this buffer by adding the entry
1907 t))
1908 \f
1910 "History list for some commands that read shell commands.
1912 Maximum length of the history list is determined by the value
1919 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1920 This buffer is used when `shell-command' or `shell-command-on-region'
1921 is run interactively. A value of nil means that output to stderr and
1925 "Dynamically complete shell command at point."
1934 map)
1938 "Read a shell command from the minibuffer.
1939 The arguments are the same as the ones of `read-from-minibuffer',
1940 except READ and KEYMAP are missing and HIST defaults
1941 to `shell-command-history'."
1943 minibuffer-local-shell-command-map
1944 nil
1946 args))
1949 "Execute string COMMAND in inferior shell; display output, if any.
1950 With prefix argument, insert the COMMAND's output at point.
1952 If COMMAND ends in ampersand, execute it asynchronously.
1953 The output appears in the buffer `*Async Shell Command*'.
1954 That buffer is in shell mode.
1956 Otherwise, COMMAND is executed synchronously. The output appears in
1957 the buffer `*Shell Command Output*'. If the output is short enough to
1958 display in the echo area (which is determined by the variables
1959 `resize-mini-windows' and `max-mini-window-height'), it is shown
1960 there, but it is nonetheless available in buffer `*Shell Command
1961 Output*' even though that buffer is not automatically displayed.
1963 To specify a coding system for converting non-ASCII characters
1965 before this command.
1967 Noninteractive callers can specify coding systems by binding
1968 `coding-system-for-read' and `coding-system-for-write'.
1970 The optional second argument OUTPUT-BUFFER, if non-nil,
1971 says to put the output in some other buffer.
1972 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1973 If OUTPUT-BUFFER is not a buffer and not nil,
1974 insert output in current buffer. (This cannot be done asynchronously.)
1975 In either case, the output is inserted after point (leaving mark after it).
1977 If the command terminates without error, but generates output,
1979 the output can be displayed in the echo area or in its buffer.
1980 If the output is short enough to display in the echo area
1981 \(determined by the variable `max-mini-window-height' if
1982 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1983 the buffer containing the output is displayed.
1987 of the output.
1989 If there is no output, or if output is inserted in the current buffer,
1990 then `*Shell Command Output*' is deleted.
1992 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1993 or buffer name to which to direct the command's standard error output.
1994 If it is nil, error output is mingled with regular output.
1995 In an interactive call, the variable `shell-command-default-error-buffer'
1996 specifies the value of ERROR-BUFFER."
1999 current-prefix-arg
2000 shell-command-default-error-buffer))
2001 ;; Look for a handler in case default-directory is a remote file name.
2009 ;; Output goes in current buffer.
2015 temporary-file-directory)))
2016 nil)))
2019 ;; We do not use -f for csh; we will not support broken use of
2020 ;; .cshrcs. Even the BSD csh manual says to use
2021 ;; "if ($?prompt) exit" before things which are not useful
2022 ;; non-interactively. Besides, if someone wants their other
2023 ;; aliases for shell commands then they can still have them.
2027 t)
2028 nil shell-command-switch command)
2035 ;; Do no formatting while reading error file,
2036 ;; because that can run a shell command, and we
2037 ;; don't want that to cause an infinite recursion.
2039 ;; Put point after the inserted errors.
2043 ;; This is like exchange-point-and-mark, but doesn't
2044 ;; activate the mark. It is cleaner to avoid activation,
2045 ;; even though the command loop would deactivate the mark
2046 ;; because we inserted text.
2050 ;; Output goes in a separate buffer.
2051 ;; Preserve the match data in case called from a program.
2054 ;; Command ending with ampersand means asynchronous.
2058 proc)
2059 ;; Remove the ampersand.
2061 ;; If will kill a process, query first.
2073 shell-command-switch command))
2077 ))
2079 output-buffer nil error-buffer)))))))
2083 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
2084 MESSAGE may be either a string or a buffer.
2086 A buffer is displayed using `display-buffer' if MESSAGE is too long for
2087 the maximum height of the echo area, as defined by `max-mini-window-height'
2088 if `resize-mini-windows' is non-nil.
2090 Returns either the string shown in the echo area, or when a pop-up
2091 buffer is used, the window used to display it.
2093 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
2094 name of the buffer used to display it in the case where a pop-up buffer
2095 is used, defaulting to `*Message*'. In the case where MESSAGE is a
2096 string and it is displayed in the echo area, it is not specified whether
2097 the contents are inserted into the buffer anyway.
2099 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
2100 and only used if a buffer is displayed."
2102 ;; Trivial case where we can use the echo area
2106 ;; Trivial case where we can just remove single trailing newline
2109 ;; General case
2112 message
2121 0
2125 (<= lines
2129 max-mini-window-height))
2131 max-mini-window-height)
2135 ;; Don't use the echo area if the output buffer is
2136 ;; already dispayed in the selected frame.
2138 ;; Echo area
2144 ;; Buffer
2147 not-this-window frame))))))))
2150 ;; We have a sentinel to prevent insertion of a termination message
2151 ;; in the buffer itself.
2159 &optional output-buffer replace
2160 error-buffer display-error-buffer)
2161 "Execute string COMMAND in inferior shell with region as input.
2162 Normally display output (if any) in temp buffer `*Shell Command Output*';
2163 Prefix arg means replace the region with it. Return the exit code of
2164 COMMAND.
2166 To specify a coding system for converting non-ASCII characters
2168 before this command. By default, the input (from the current buffer)
2169 is encoded in the same coding system that will be used to save the file,
2170 `buffer-file-coding-system'. If the output is going to replace the region,
2171 then it is decoded from that same coding system.
2173 The noninteractive arguments are START, END, COMMAND,
2174 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
2175 Noninteractive callers can specify coding systems by binding
2176 `coding-system-for-read' and `coding-system-for-write'.
2178 If the command generates output, the output may be displayed
2179 in the echo area or in a buffer.
2180 If the output is short enough to display in the echo area
2181 \(determined by the variable `max-mini-window-height' if
2182 `resize-mini-windows' is non-nil), it is shown there. Otherwise
2183 it is displayed in the buffer `*Shell Command Output*'. The output
2184 is available in that buffer in both cases.
2186 If there is output and an error, a message about the error
2187 appears at the end of the output.
2189 If there is no output, or if output is inserted in the current buffer,
2190 then `*Shell Command Output*' is deleted.
2192 If the optional fourth argument OUTPUT-BUFFER is non-nil,
2193 that says to put the output in some other buffer.
2194 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
2195 If OUTPUT-BUFFER is not a buffer and not nil,
2196 insert output in the current buffer.
2197 In either case, the output is inserted after point (leaving mark after it).
2199 If REPLACE, the optional fifth argument, is non-nil, that means insert
2200 the output in place of text from START to END, putting point and mark
2201 around it.
2203 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
2204 or buffer name to which to direct the command's standard error output.
2205 If it is nil, error output is mingled with regular output.
2206 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
2207 were any errors. (This is always t, interactively.)
2208 In an interactive call, the variable `shell-command-default-error-buffer'
2209 specifies the value of ERROR-BUFFER."
2213 ;; Do this before calling region-beginning
2214 ;; and region-end, in case subprocess output
2215 ;; relocates them while we are in the minibuffer.
2217 ;; call-interactively recognizes region-beginning and
2218 ;; region-end specially, leaving them in the history.
2220 string
2221 current-prefix-arg
2222 current-prefix-arg
2223 shell-command-default-error-buffer
2224 t)))
2230 temporary-file-directory)))
2231 nil))
2232 exit-status)
2236 ;; Replace specified region with output from command.
2238 ;; Don't muck with mark unless REPLACE says we should.
2245 t)
2246 nil shell-command-switch command))
2247 ;; It is rude to delete a buffer which the command is not using.
2248 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
2249 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
2250 ;; (kill-buffer shell-buffer)))
2251 ;; Don't muck with mark unless REPLACE says we should.
2253 ;; No prefix argument: put the output in a temp buffer,
2254 ;; replacing its entire contents.
2259 ;; If the input is the same buffer as the output,
2260 ;; delete everything but the specified region,
2261 ;; then replace that region with the output.
2267 shell-file-name t
2270 t)
2271 nil shell-command-switch
2272 command)))
2273 ;; Clear the output buffer, then run the command with
2274 ;; output there.
2286 buffer)
2287 nil shell-command-switch command)))
2288 ;; Report the output.
2298 ;; There's some output, display it
2300 ;; No output; error?
2304 "some error output"
2310 output))
2313 exit-status))
2316 exit-status output))))
2317 ;; Don't kill: there might be useful info in the undo-log.
2318 ;; (kill-buffer buffer)
2319 ))))
2327 ;; Do no formatting while reading error file,
2328 ;; because that can run a shell command, and we
2329 ;; don't want that to cause an infinite recursion.
2331 ;; Put point after the inserted errors.
2336 exit-status))
2339 "Execute shell command COMMAND and return its output as a string."
2342 standard-output
2346 "Process files synchronously in a separate process.
2347 Similar to `call-process', but may invoke a file handler based on
2348 `default-directory'. The current working directory of the
2349 subprocess is `default-directory'.
2351 File names in INFILE and BUFFER are handled normally, but file
2352 names in ARGS should be relative to `default-directory', as they
2353 are passed to the process verbatim. \(This is a difference to
2354 `call-process' which does not support file handlers for INFILE
2355 and BUFFER.\)
2357 Some file handlers might not support all variants, for example
2358 they might behave as if DISPLAY was nil, regardless of the actual
2359 value passed."
2361 lc stderr-file)
2371 display args)
2377 "Start a program in a subprocess. Return the process object for it.
2378 Similar to `start-process', but may invoke a file handler based on
2379 `default-directory'. The current working directory of the
2380 subprocess is `default-directory'.
2382 PROGRAM and PROGRAM-ARGS might be file names. They are not
2383 objects of file handler invocation."
2389 \f
2393 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2394 (define-key map [switch-frame] nil)
2395 (define-key map [?\C-u] 'universal-argument-more)
2396 (define-key map [?-] 'universal-argument-minus)
2397 (define-key map [?0] 'digit-argument)
2398 (define-key map [?1] 'digit-argument)
2399 (define-key map [?2] 'digit-argument)
2400 (define-key map [?3] 'digit-argument)
2401 (define-key map [?4] 'digit-argument)
2402 (define-key map [?5] 'digit-argument)
2403 (define-key map [?6] 'digit-argument)
2404 (define-key map [?7] 'digit-argument)
2405 (define-key map [?8] 'digit-argument)
2406 (define-key map [?9] 'digit-argument)
2407 (define-key map [kp-0] 'digit-argument)
2408 (define-key map [kp-1] 'digit-argument)
2409 (define-key map [kp-2] 'digit-argument)
2410 (define-key map [kp-3] 'digit-argument)
2411 (define-key map [kp-4] 'digit-argument)
2412 (define-key map [kp-5] 'digit-argument)
2413 (define-key map [kp-6] 'digit-argument)
2414 (define-key map [kp-7] 'digit-argument)
2415 (define-key map [kp-8] 'digit-argument)
2416 (define-key map [kp-9] 'digit-argument)
2417 (define-key map [kp-subtract] 'universal-argument-minus)
2418 map)
2421 (defvar universal-argument-num-events nil
2422 "Number of argument-specifying events read by `universal-argument'.
2423 `universal-argument-other-key' uses this to discard those events
2424 from (this-command-keys), and reread only the final command.")
2426 (defvar overriding-map-is-bound nil
2427 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2429 (defvar saved-overriding-map nil
2430 "The saved value of `overriding-terminal-local-map'.
2434 (defun ensure-overriding-map-is-bound ()
2435 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2436 (unless overriding-map-is-bound
2437 (setq saved-overriding-map overriding-terminal-local-map)
2438 (setq overriding-terminal-local-map universal-argument-map)
2439 (setq overriding-map-is-bound t)))
2441 (defun restore-overriding-map ()
2442 "Restore `overriding-terminal-local-map' to its saved value."
2443 (setq overriding-terminal-local-map saved-overriding-map)
2444 (setq overriding-map-is-bound nil))
2446 (defun universal-argument ()
2447 "Begin a numeric argument for the following command.
2452 multiplies the argument by 4 each time.
2454 which is different in effect from any particular numeric argument.
2456 (interactive)
2457 (setq prefix-arg (list 4))
2458 (setq universal-argument-num-events (length (this-command-keys)))
2459 (ensure-overriding-map-is-bound))
2461 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2462 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2463 (defun universal-argument-more (arg)
2464 (interactive "P")
2465 (if (consp arg)
2466 (setq prefix-arg (list (* 4 (car arg))))
2467 (if (eq arg '-)
2468 (setq prefix-arg (list -4))
2469 (setq prefix-arg arg)
2470 (restore-overriding-map)))
2471 (setq universal-argument-num-events (length (this-command-keys))))
2473 (defun negative-argument (arg)
2474 "Begin a negative numeric argument for the next command.
2476 (interactive "P")
2477 (cond ((integerp arg)
2478 (setq prefix-arg (- arg)))
2479 ((eq arg '-)
2480 (setq prefix-arg nil))
2481 (t
2482 (setq prefix-arg '-)))
2483 (setq universal-argument-num-events (length (this-command-keys)))
2484 (ensure-overriding-map-is-bound))
2486 (defun digit-argument (arg)
2487 "Part of the numeric argument for the next command.
2489 (interactive "P")
2490 (let* ((char (if (integerp last-command-char)
2491 last-command-char
2492 (get last-command-char 'ascii-character)))
2494 (cond ((integerp arg)
2495 (setq prefix-arg (+ (* arg 10)
2496 (if (< arg 0) (- digit) digit))))
2497 ((eq arg '-)
2498 ;; Treat -0 as just -, so that -01 will work.
2499 (setq prefix-arg (if (zerop digit) '- (- digit))))
2500 (t
2501 (setq prefix-arg digit))))
2502 (setq universal-argument-num-events (length (this-command-keys)))
2503 (ensure-overriding-map-is-bound))
2505 ;; For backward compatibility, minus with no modifiers is an ordinary
2506 ;; command if digits have already been entered.
2507 (defun universal-argument-minus (arg)
2508 (interactive "P")
2509 (if (integerp arg)
2510 (universal-argument-other-key arg)
2511 (negative-argument arg)))
2513 ;; Anything else terminates the argument and is left in the queue to be
2514 ;; executed as a command.
2515 (defun universal-argument-other-key (arg)
2516 (interactive "P")
2517 (setq prefix-arg arg)
2518 (let* ((key (this-command-keys))
2519 (keylist (listify-key-sequence key)))
2520 (setq unread-command-events
2521 (append (nthcdr universal-argument-num-events keylist)
2522 unread-command-events)))
2523 (reset-this-command-lengths)
2524 (restore-overriding-map))
2525 \f
2526 (defvar buffer-substring-filters nil
2527 "List of filter functions for `filter-buffer-substring'.
2528 Each function must accept a single argument, a string, and return
2529 a string. The buffer substring is passed to the first function
2530 in the list, and the return value of each function is passed to
2531 the next. The return value of the last function is used as the
2532 return value of `filter-buffer-substring'.
2534 If this variable is nil, no filtering is performed.")
2536 (defun filter-buffer-substring (beg end &optional delete noprops)
2537 "Return the buffer substring between BEG and END, after filtering.
2538 The buffer substring is passed through each of the filter
2539 functions in `buffer-substring-filters', and the value from the
2540 last filter function is returned. If `buffer-substring-filters'
2541 is nil, the buffer substring is returned unaltered.
2543 If DELETE is non-nil, the text between BEG and END is deleted
2544 from the buffer.
2546 If NOPROPS is non-nil, final string returned does not include
2547 text properties, while the string passed to the filters still
2548 includes text properties from the buffer text.
2550 Point is temporarily set to BEG before calling
2551 `buffer-substring-filters', in case the functions need to know
2552 where the text came from.
2554 This function should be used instead of `buffer-substring',
2555 `buffer-substring-no-properties', or `delete-and-extract-region'
2556 when you want to allow filtering to take place. For example,
2557 major or minor modes can use `buffer-substring-filters' to
2558 extract characters that are special to a buffer, and should not
2559 be copied into other buffers."
2560 (cond
2561 ((or delete buffer-substring-filters)
2562 (save-excursion
2563 (goto-char beg)
2564 (let ((string (if delete (delete-and-extract-region beg end)
2565 (buffer-substring beg end))))
2566 (dolist (filter buffer-substring-filters)
2567 (setq string (funcall filter string)))
2568 (if noprops
2569 (set-text-properties 0 (length string) nil string))
2570 string)))
2571 (noprops
2572 (buffer-substring-no-properties beg end))
2573 (t
2574 (buffer-substring beg end))))
2577 ;;;; Window system cut and paste hooks.
2579 (defvar interprogram-cut-function nil
2580 "Function to call to make a killed region available to other programs.
2582 Most window systems provide some sort of facility for cutting and
2583 pasting text between the windows of different programs.
2584 This variable holds a function that Emacs calls whenever text
2585 is put in the kill ring, to make the new kill available to other
2586 programs.
2588 The function takes one or two arguments.
2589 The first argument, TEXT, is a string containing
2590 the text which should be made available.
2591 The second, optional, argument PUSH, has the same meaning as the
2592 similar argument to `x-set-cut-buffer', which see.")
2594 (defvar interprogram-paste-function nil
2595 "Function to call to get text cut from other programs.
2597 Most window systems provide some sort of facility for cutting and
2598 pasting text between the windows of different programs.
2599 This variable holds a function that Emacs calls to obtain
2600 text that other programs have provided for pasting.
2602 The function should be called with no arguments. If the function
2603 returns nil, then no other program has provided such text, and the top
2604 of the Emacs kill ring should be used. If the function returns a
2605 string, then the caller of the function \(usually `current-kill')
2606 should put this string in the kill ring as the latest kill.
2608 This function may also return a list of strings if the window
2609 system supports multiple selections. The first string will be
2610 used as the pasted text, but the other will be placed in the
2611 kill ring for easy access via `yank-pop'.
2613 Note that the function should return a string only if a program other
2614 than Emacs has provided a string for pasting; if Emacs provided the
2615 most recent string, the function should return nil. If it is
2616 difficult to tell whether Emacs or some other program provided the
2617 current string, it is probably good enough to return nil if the string
2618 is equal (according to `string=') to the last text Emacs provided.")
2619 \f
2622 ;;;; The kill ring data structure.
2624 (defvar kill-ring nil
2625 "List of killed text sequences.
2626 Since the kill ring is supposed to interact nicely with cut-and-paste
2627 facilities offered by window systems, use of this variable should
2628 interact nicely with `interprogram-cut-function' and
2629 `interprogram-paste-function'. The functions `kill-new',
2630 `kill-append', and `current-kill' are supposed to implement this
2631 interaction; you may want to use them instead of manipulating the kill
2632 ring directly.")
2634 (defcustom kill-ring-max 60
2635 "*Maximum length of kill ring before oldest elements are thrown away."
2636 :type 'integer
2637 :group 'killing)
2639 (defvar kill-ring-yank-pointer nil
2640 "The tail of the kill ring whose car is the last thing yanked.")
2642 (defun kill-new (string &optional replace yank-handler)
2643 "Make STRING the latest kill in the kill ring.
2644 Set `kill-ring-yank-pointer' to point to it.
2645 If `interprogram-cut-function' is non-nil, apply it to STRING.
2646 Optional second argument REPLACE non-nil means that STRING will replace
2647 the front of the kill ring, rather than being added to the list.
2649 Optional third arguments YANK-HANDLER controls how the STRING is later
2650 inserted into a buffer; see `insert-for-yank' for details.
2651 When a yank handler is specified, STRING must be non-empty (the yank
2652 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2654 When the yank handler has a non-nil PARAM element, the original STRING
2655 argument is not used by `insert-for-yank'. However, since Lisp code
2656 may access and use elements from the kill ring directly, the STRING
2658 (if (> (length string) 0)
2659 (if yank-handler
2660 (put-text-property 0 (length string)
2661 'yank-handler yank-handler string))
2662 (if yank-handler
2663 (signal 'args-out-of-range
2664 (list string "yank-handler specified for empty string"))))
2665 (if (fboundp 'menu-bar-update-yank-menu)
2666 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2667 (if (and replace kill-ring)
2668 (setcar kill-ring string)
2669 (push string kill-ring)
2670 (if (> (length kill-ring) kill-ring-max)
2671 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2672 (setq kill-ring-yank-pointer kill-ring)
2673 (if interprogram-cut-function
2674 (funcall interprogram-cut-function string (not replace))))
2676 (defun kill-append (string before-p &optional yank-handler)
2677 "Append STRING to the end of the latest kill in the kill ring.
2678 If BEFORE-P is non-nil, prepend STRING to the kill.
2679 Optional third argument YANK-HANDLER, if non-nil, specifies the
2680 yank-handler text property to be set on the combined kill ring
2681 string. If the specified yank-handler arg differs from the
2682 yank-handler property of the latest kill string, this function
2683 adds the combined string to the kill ring as a new element,
2684 instead of replacing the last kill with it.
2685 If `interprogram-cut-function' is set, pass the resulting kill to it."
2686 (let* ((cur (car kill-ring)))
2687 (kill-new (if before-p (concat string cur) (concat cur string))
2688 (or (= (length cur) 0)
2689 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2690 yank-handler)))
2692 (defcustom yank-pop-change-selection nil
2693 "If non-nil, rotating the kill ring changes the window system selection."
2694 :type 'boolean
2695 :group 'killing
2696 :version "23.1")
2698 (defun current-kill (n &optional do-not-move)
2699 "Rotate the yanking point by N places, and then return that kill.
2700 If N is zero, `interprogram-paste-function' is set, and calling it returns a
2701 string or list of strings, then that string (or list) is added to the front
2702 of the kill ring and the string (or first string in the list) is returned as
2703 the latest kill.
2705 If N is not zero, and if `yank-pop-change-selection' is
2706 non-nil, use `interprogram-cut-function' to transfer the
2707 kill at the new yank point into the window system selection.
2709 If optional arg DO-NOT-MOVE is non-nil, then don't actually
2710 move the yanking point; just return the Nth kill forward."
2712 (let ((interprogram-paste (and (= n 0)
2713 interprogram-paste-function
2714 (funcall interprogram-paste-function))))
2715 (if interprogram-paste
2716 (progn
2717 ;; Disable the interprogram cut function when we add the new
2718 ;; text to the kill ring, so Emacs doesn't try to own the
2719 ;; selection, with identical text.
2720 (let ((interprogram-cut-function nil))
2721 (if (listp interprogram-paste)
2722 (mapc 'kill-new (nreverse interprogram-paste))
2723 (kill-new interprogram-paste)))
2724 (car kill-ring))
2725 (or kill-ring (error "Kill ring is empty"))
2726 (let ((ARGth-kill-element
2727 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2728 (length kill-ring))
2729 kill-ring)))
2730 (unless do-not-move
2731 (setq kill-ring-yank-pointer ARGth-kill-element)
2732 (when (and yank-pop-change-selection
2733 (> n 0)
2734 interprogram-cut-function)
2735 (funcall interprogram-cut-function (car ARGth-kill-element))))
2736 (car ARGth-kill-element)))))
2740 ;;;; Commands for manipulating the kill ring.
2742 (defcustom kill-read-only-ok nil
2743 "*Non-nil means don't signal an error for killing read-only text."
2744 :type 'boolean
2745 :group 'killing)
2747 (put 'text-read-only 'error-conditions
2748 '(text-read-only buffer-read-only error))
2749 (put 'text-read-only 'error-message "Text is read-only")
2751 (defun kill-region (beg end &optional yank-handler)
2753 This deletes the text from the buffer and saves it in the kill ring.
2757 If you want to append the killed region to the last killed text,
2760 If the buffer is read-only, Emacs will beep and refrain from deleting
2761 the text, but put the text in the kill ring anyway. This means that
2762 you can use the killing commands to copy text from a read-only buffer.
2764 This is the primitive for programs to kill text (as opposed to deleting it).
2765 Supply two arguments, character positions indicating the stretch of text
2766 to be killed.
2768 If the previous command was also a kill command,
2769 the text killed this time appends to the text killed last time
2770 to make one entry in the kill ring.
2772 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2773 specifies the yank-handler text property to be set on the killed
2774 text. See `insert-for-yank'."
2775 ;; Pass point first, then mark, because the order matters
2776 ;; when calling kill-append.
2777 (interactive (list (point) (mark)))
2778 (unless (and beg end)
2779 (error "The mark is not set now, so there is no region"))
2780 (condition-case nil
2781 (let ((string (filter-buffer-substring beg end t)))
2782 (when string ;STRING is nil if BEG = END
2783 ;; Add that string to the kill ring, one way or another.
2784 (if (eq last-command 'kill-region)
2785 (kill-append string (< end beg) yank-handler)
2786 (kill-new string nil yank-handler)))
2787 (when (or string (eq last-command 'kill-region))
2788 (setq this-command 'kill-region))
2789 nil)
2790 ((buffer-read-only text-read-only)
2791 ;; The code above failed because the buffer, or some of the characters
2792 ;; in the region, are read-only.
2793 ;; We should beep, in case the user just isn't aware of this.
2794 ;; However, there's no harm in putting
2795 ;; the region's text in the kill ring, anyway.
2796 (copy-region-as-kill beg end)
2797 ;; Set this-command now, so it will be set even if we get an error.
2798 (setq this-command 'kill-region)
2799 ;; This should barf, if appropriate, and give us the correct error.
2800 (if kill-read-only-ok
2801 (progn (message "Read only text copied to kill ring") nil)
2802 ;; Signal an error if the buffer is read-only.
2803 (barf-if-buffer-read-only)
2804 ;; If the buffer isn't read-only, the text is.
2805 (signal 'text-read-only (list (current-buffer)))))))
2807 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2808 ;; to get two copies of the text when the user accidentally types M-w and
2809 ;; then corrects it with the intended C-w.
2810 (defun copy-region-as-kill (beg end)
2811 "Save the region as if killed, but don't kill it.
2812 In Transient Mark mode, deactivate the mark.
2813 If `interprogram-cut-function' is non-nil, also save the text for a window
2814 system cut and paste.
2816 This command's old key binding has been given to `kill-ring-save'."
2817 (interactive "r")
2818 (if (eq last-command 'kill-region)
2819 (kill-append (filter-buffer-substring beg end) (< end beg))
2820 (kill-new (filter-buffer-substring beg end)))
2821 (if transient-mark-mode
2822 (setq deactivate-mark t))
2823 nil)
2825 (defun kill-ring-save (beg end)
2826 "Save the region as if killed, but don't kill it.
2827 In Transient Mark mode, deactivate the mark.
2828 If `interprogram-cut-function' is non-nil, also save the text for a window
2829 system cut and paste.
2831 If you want to append the killed line to the last killed text,
2834 This command is similar to `copy-region-as-kill', except that it gives
2835 visual feedback indicating the extent of the region being copied."
2836 (interactive "r")
2837 (copy-region-as-kill beg end)
2838 ;; This use of interactive-p is correct
2839 ;; because the code it controls just gives the user visual feedback.
2840 (if (interactive-p)
2841 (let ((other-end (if (= (point) beg) end beg))
2842 (opoint (point))
2843 ;; Inhibit quitting so we can make a quit here
2844 ;; look like a C-g typed as a command.
2845 (inhibit-quit t))
2846 (if (pos-visible-in-window-p other-end (selected-window))
2847 (unless (and transient-mark-mode
2848 (face-background 'region))
2849 ;; Swap point and mark.
2850 (set-marker (mark-marker) (point) (current-buffer))
2851 (goto-char other-end)
2852 (sit-for blink-matching-delay)
2853 ;; Swap back.
2854 (set-marker (mark-marker) other-end (current-buffer))
2855 (goto-char opoint)
2856 ;; If user quit, deactivate the mark
2857 ;; as C-g would as a command.
2858 (and quit-flag mark-active
2859 (deactivate-mark)))
2860 (let* ((killed-text (current-kill 0))
2861 (message-len (min (length killed-text) 40)))
2862 (if (= (point) beg)
2863 ;; Don't say "killed"; that is misleading.
2865 (substring killed-text (- message-len)))
2867 (substring killed-text 0 message-len))))))))
2869 (defun append-next-kill (&optional interactive)
2870 "Cause following command, if it kills, to append to previous kill.
2871 The argument is used for internal purposes; do not supply one."
2872 (interactive "p")
2873 ;; We don't use (interactive-p), since that breaks kbd macros.
2874 (if interactive
2875 (progn
2876 (setq this-command 'kill-region)
2877 (message "If the next command is a kill, it will append"))
2878 (setq last-command 'kill-region)))
2879 \f
2880 ;; Yanking.
2882 ;; This is actually used in subr.el but defcustom does not work there.
2883 (defcustom yank-excluded-properties
2884 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2885 yank-handler follow-link fontified)
2886 "Text properties to discard when yanking.
2887 The value should be a list of text properties to discard or t,
2888 which means to discard all text properties."
2889 :type '(choice (const :tag "All" t) (repeat symbol))
2890 :group 'killing
2891 :version "22.1")
2893 (defvar yank-window-start nil)
2894 (defvar yank-undo-function nil
2895 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2896 Function is called with two parameters, START and END corresponding to
2897 the value of the mark and point; it is guaranteed that START <= END.
2898 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2900 (defun yank-pop (&optional arg)
2901 "Replace just-yanked stretch of killed text with a different stretch.
2902 This command is allowed only immediately after a `yank' or a `yank-pop'.
2903 At such a time, the region contains a stretch of reinserted
2904 previously-killed text. `yank-pop' deletes that text and inserts in its
2905 place a different stretch of killed text.
2907 With no argument, the previous kill is inserted.
2908 With argument N, insert the Nth previous kill.
2909 If N is negative, this is a more recent kill.
2911 The sequence of kills wraps around, so that after the oldest one
2912 comes the newest one.
2914 When this command inserts killed text into the buffer, it honors
2915 `yank-excluded-properties' and `yank-handler' as described in the
2916 doc string for `insert-for-yank-1', which see."
2917 (interactive "*p")
2918 (if (not (eq last-command 'yank))
2919 (error "Previous command was not a yank"))
2920 (setq this-command 'yank)
2921 (unless arg (setq arg 1))
2922 (let ((inhibit-read-only t)
2923 (before (< (point) (mark t))))
2924 (if before
2925 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2926 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2927 (setq yank-undo-function nil)
2928 (set-marker (mark-marker) (point) (current-buffer))
2929 (insert-for-yank (current-kill arg))
2930 ;; Set the window start back where it was in the yank command,
2931 ;; if possible.
2932 (set-window-start (selected-window) yank-window-start t)
2933 (if before
2934 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2935 ;; It is cleaner to avoid activation, even though the command
2936 ;; loop would deactivate the mark because we inserted text.
2937 (goto-char (prog1 (mark t)
2938 (set-marker (mark-marker) (point) (current-buffer))))))
2939 nil)
2941 (defun yank (&optional arg)
2943 More precisely, reinsert the stretch of killed text most recently
2944 killed OR yanked. Put point at end, and set mark at beginning.
2945 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2946 With argument N, reinsert the Nth most recently killed stretch of killed
2947 text.
2949 When this command inserts killed text into the buffer, it honors
2950 `yank-excluded-properties' and `yank-handler' as described in the
2951 doc string for `insert-for-yank-1', which see.
2954 (interactive "*P")
2955 (setq yank-window-start (window-start))
2956 ;; If we don't get all the way thru, make last-command indicate that
2957 ;; for the following command.
2958 (setq this-command t)
2959 (push-mark (point))
2960 (insert-for-yank (current-kill (cond
2961 ((listp arg) 0)
2962 ((eq arg '-) -2)
2963 (t (1- arg)))))
2964 (if (consp arg)
2965 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2966 ;; It is cleaner to avoid activation, even though the command
2967 ;; loop would deactivate the mark because we inserted text.
2968 (goto-char (prog1 (mark t)
2969 (set-marker (mark-marker) (point) (current-buffer)))))
2970 ;; If we do get all the way thru, make this-command indicate that.
2971 (if (eq this-command t)
2972 (setq this-command 'yank))
2973 nil)
2975 (defun rotate-yank-pointer (arg)
2976 "Rotate the yanking point in the kill ring.
2977 With argument, rotate that many kills forward (or backward, if negative)."
2978 (interactive "p")
2979 (current-kill arg))
2980 \f
2981 ;; Some kill commands.
2983 ;; Internal subroutine of delete-char
2984 (defun kill-forward-chars (arg)
2985 (if (listp arg) (setq arg (car arg)))
2986 (if (eq arg '-) (setq arg -1))
2987 (kill-region (point) (forward-point arg)))
2989 ;; Internal subroutine of backward-delete-char
2990 (defun kill-backward-chars (arg)
2991 (if (listp arg) (setq arg (car arg)))
2992 (if (eq arg '-) (setq arg -1))
2993 (kill-region (point) (forward-point (- arg))))
2995 (defcustom backward-delete-char-untabify-method 'untabify
2996 "*The method for untabifying when deleting backward.
2997 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2998 `hungry' -- delete all whitespace, both tabs and spaces;
2999 `all' -- delete all whitespace, including tabs, spaces and newlines;
3000 nil -- just delete one character."
3001 :type '(choice (const untabify) (const hungry) (const all) (const nil))
3002 :version "20.3"
3003 :group 'killing)
3005 (defun backward-delete-char-untabify (arg &optional killp)
3006 "Delete characters backward, changing tabs into spaces.
3007 The exact behavior depends on `backward-delete-char-untabify-method'.
3008 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
3009 Interactively, ARG is the prefix arg (default 1)
3010 and KILLP is t if a prefix arg was specified."
3012 (when (eq backward-delete-char-untabify-method 'untabify)
3013 (let ((count arg))
3014 (save-excursion
3015 (while (and (> count 0) (not (bobp)))
3017 (let ((col (current-column)))
3018 (forward-char -1)
3019 (setq col (- col (current-column)))
3020 (insert-char ?\s col)
3021 (delete-char 1)))
3022 (forward-char -1)
3023 (setq count (1- count))))))
3024 (delete-backward-char
3026 ((eq backward-delete-char-untabify-method 'all)
3028 (if skip
3029 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
3030 (point)))))
3031 (+ arg (if (zerop wh) 0 (1- wh))))
3032 arg))
3033 killp))
3035 (defun zap-to-char (arg char)
3036 "Kill up to and including ARG'th occurrence of CHAR.
3037 Case is ignored if `case-fold-search' is non-nil in the current buffer.
3038 Goes backward if ARG is negative; error if CHAR not found."
3040 (if (char-table-p translation-table-for-input)
3041 (setq char (or (aref translation-table-for-input char) char)))
3042 (kill-region (point) (progn
3043 (search-forward (char-to-string char) nil nil arg)
3044 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
3045 (point))))
3047 ;; kill-line and its subroutines.
3049 (defcustom kill-whole-line nil
3050 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
3051 :type 'boolean
3052 :group 'killing)
3054 (defun kill-line (&optional arg)
3055 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
3056 With prefix argument, kill that many lines from point.
3057 Negative arguments kill lines backward.
3058 With zero argument, kills the text before point on the current line.
3061 a number counts as a prefix arg.
3063 To kill a whole line, when point is not at the beginning, type \
3066 If `kill-whole-line' is non-nil, then this command kills the whole line
3067 including its terminating newline, when used at the beginning of a line
3068 with no argument. As a consequence, you can always kill a whole line
3071 If you want to append the killed line to the last killed text,
3074 If the buffer is read-only, Emacs will beep and refrain from deleting
3075 the line, but put the line in the kill ring anyway. This means that
3076 you can use this command to copy text from a read-only buffer.
3077 \(If the variable `kill-read-only-ok' is non-nil, then this won't
3078 even beep.)"
3079 (interactive "P")
3080 (kill-region (point)
3081 ;; It is better to move point to the other end of the kill
3082 ;; before killing. That way, in a read-only buffer, point
3083 ;; moves across the text that is copied to the kill ring.
3084 ;; The choice has no effect on undo now that undo records
3085 ;; the value of point from before the command was run.
3086 (progn
3087 (if arg
3088 (forward-visible-line (prefix-numeric-value arg))
3089 (if (eobp)
3090 (signal 'end-of-buffer nil))
3091 (let ((end
3092 (save-excursion
3093 (end-of-visible-line) (point))))
3094 (if (or (save-excursion
3095 ;; If trailing whitespace is visible,
3096 ;; don't treat it as nothing.
3097 (unless show-trailing-whitespace
3099 (= (point) end))
3100 (and kill-whole-line (bolp)))
3101 (forward-visible-line 1)
3102 (goto-char end))))
3103 (point))))
3105 (defun kill-whole-line (&optional arg)
3106 "Kill current line.
3107 With prefix arg, kill that many lines starting from the current line.
3108 If arg is negative, kill backward. Also kill the preceding newline.
3110 If arg is zero, kill current line but exclude the trailing newline."
3111 (interactive "p")
3112 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
3113 (signal 'end-of-buffer nil))
3114 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
3115 (signal 'beginning-of-buffer nil))
3116 (unless (eq last-command 'kill-region)
3117 (kill-new "")
3118 (setq last-command 'kill-region))
3119 (cond ((zerop arg)
3120 ;; We need to kill in two steps, because the previous command
3121 ;; could have been a kill command, in which case the text
3122 ;; before point needs to be prepended to the current kill
3123 ;; ring entry and the text after point appended. Also, we
3124 ;; need to use save-excursion to avoid copying the same text
3125 ;; twice to the kill ring in read-only buffers.
3126 (save-excursion
3127 (kill-region (point) (progn (forward-visible-line 0) (point))))
3128 (kill-region (point) (progn (end-of-visible-line) (point))))
3129 ((< arg 0)
3130 (save-excursion
3131 (kill-region (point) (progn (end-of-visible-line) (point))))
3132 (kill-region (point)
3133 (progn (forward-visible-line (1+ arg))
3134 (unless (bobp) (backward-char))
3135 (point))))
3136 (t
3137 (save-excursion
3138 (kill-region (point) (progn (forward-visible-line 0) (point))))
3139 (kill-region (point)
3140 (progn (forward-visible-line arg) (point))))))
3142 (defun forward-visible-line (arg)
3143 "Move forward by ARG lines, ignoring currently invisible newlines only.
3144 If ARG is negative, move backward -ARG lines.
3145 If ARG is zero, move to the beginning of the current line."
3146 (condition-case nil
3147 (if (> arg 0)
3148 (progn
3149 (while (> arg 0)
3150 (or (zerop (forward-line 1))
3151 (signal 'end-of-buffer nil))
3152 ;; If the newline we just skipped is invisible,
3153 ;; don't count it.
3154 (let ((prop
3155 (get-char-property (1- (point)) 'invisible)))
3156 (if (if (eq buffer-invisibility-spec t)
3157 prop
3158 (or (memq prop buffer-invisibility-spec)
3159 (assq prop buffer-invisibility-spec)))
3160 (setq arg (1+ arg))))
3161 (setq arg (1- arg)))
3162 ;; If invisible text follows, and it is a number of complete lines,
3163 ;; skip it.
3164 (let ((opoint (point)))
3165 (while (and (not (eobp))
3166 (let ((prop
3167 (get-char-property (point) 'invisible)))
3168 (if (eq buffer-invisibility-spec t)
3169 prop
3170 (or (memq prop buffer-invisibility-spec)
3171 (assq prop buffer-invisibility-spec)))))
3172 (goto-char
3173 (if (get-text-property (point) 'invisible)
3174 (or (next-single-property-change (point) 'invisible)
3175 (point-max))
3176 (next-overlay-change (point)))))
3177 (unless (bolp)
3178 (goto-char opoint))))
3179 (let ((first t))
3180 (while (or first (<= arg 0))
3181 (if first
3182 (beginning-of-line)
3183 (or (zerop (forward-line -1))
3184 (signal 'beginning-of-buffer nil)))
3185 ;; If the newline we just moved to is invisible,
3186 ;; don't count it.
3187 (unless (bobp)
3188 (let ((prop
3189 (get-char-property (1- (point)) 'invisible)))
3190 (unless (if (eq buffer-invisibility-spec t)
3191 prop
3192 (or (memq prop buffer-invisibility-spec)
3193 (assq prop buffer-invisibility-spec)))
3194 (setq arg (1+ arg)))))
3195 (setq first nil))
3196 ;; If invisible text follows, and it is a number of complete lines,
3197 ;; skip it.
3198 (let ((opoint (point)))
3199 (while (and (not (bobp))
3200 (let ((prop
3201 (get-char-property (1- (point)) 'invisible)))
3202 (if (eq buffer-invisibility-spec t)
3203 prop
3204 (or (memq prop buffer-invisibility-spec)
3205 (assq prop buffer-invisibility-spec)))))
3206 (goto-char
3207 (if (get-text-property (1- (point)) 'invisible)
3208 (or (previous-single-property-change (point) 'invisible)
3209 (point-min))
3210 (previous-overlay-change (point)))))
3211 (unless (bolp)
3212 (goto-char opoint)))))
3213 ((beginning-of-buffer end-of-buffer)
3214 nil)))
3216 (defun end-of-visible-line ()
3217 "Move to end of current visible line."
3218 (end-of-line)
3219 ;; If the following character is currently invisible,
3220 ;; skip all characters with that same `invisible' property value,
3221 ;; then find the next newline.
3222 (while (and (not (eobp))
3223 (save-excursion
3225 (let ((prop
3226 (get-char-property (point) 'invisible)))
3227 (if (eq buffer-invisibility-spec t)
3228 prop
3229 (or (memq prop buffer-invisibility-spec)
3230 (assq prop buffer-invisibility-spec))))))
3232 (if (get-text-property (point) 'invisible)
3233 (goto-char (next-single-property-change (point) 'invisible))
3234 (goto-char (next-overlay-change (point))))
3235 (end-of-line)))
3236 \f
3237 (defun insert-buffer (buffer)
3238 "Insert after point the contents of BUFFER.
3239 Puts mark after the inserted text.
3240 BUFFER may be a buffer or a buffer name.
3242 This function is meant for the user to run interactively.
3243 Don't call it from programs: use `insert-buffer-substring' instead!"
3244 (interactive
3245 (list
3246 (progn
3247 (barf-if-buffer-read-only)
3248 (read-buffer "Insert buffer: "
3249 (if (eq (selected-window) (next-window (selected-window)))
3250 (other-buffer (current-buffer))
3251 (window-buffer (next-window (selected-window))))
3252 t))))
3253 (push-mark
3254 (save-excursion
3255 (insert-buffer-substring (get-buffer buffer))
3256 (point)))
3257 nil)
3259 (defun append-to-buffer (buffer start end)
3260 "Append to specified buffer the text of the region.
3261 It is inserted into that buffer before its point.
3263 When calling from a program, give three arguments:
3264 BUFFER (or buffer name), START and END.
3265 START and END specify the portion of the current buffer to be copied."
3266 (interactive
3267 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
3268 (region-beginning) (region-end)))
3269 (let ((oldbuf (current-buffer)))
3270 (save-excursion
3271 (let* ((append-to (get-buffer-create buffer))
3272 (windows (get-buffer-window-list append-to t t))
3273 point)
3274 (set-buffer append-to)
3275 (setq point (point))
3276 (barf-if-buffer-read-only)
3277 (insert-buffer-substring oldbuf start end)
3278 (dolist (window windows)
3279 (when (= (window-point window) point)
3280 (set-window-point window (point))))))))
3282 (defun prepend-to-buffer (buffer start end)
3283 "Prepend to specified buffer the text of the region.
3284 It is inserted into that buffer after its point.
3286 When calling from a program, give three arguments:
3287 BUFFER (or buffer name), START and END.
3288 START and END specify the portion of the current buffer to be copied."
3290 (let ((oldbuf (current-buffer)))
3291 (save-excursion
3292 (set-buffer (get-buffer-create buffer))
3293 (barf-if-buffer-read-only)
3294 (save-excursion
3295 (insert-buffer-substring oldbuf start end)))))
3297 (defun copy-to-buffer (buffer start end)
3298 "Copy to specified buffer the text of the region.
3299 It is inserted into that buffer, replacing existing text there.
3301 When calling from a program, give three arguments:
3302 BUFFER (or buffer name), START and END.
3303 START and END specify the portion of the current buffer to be copied."
3305 (let ((oldbuf (current-buffer)))
3306 (with-current-buffer (get-buffer-create buffer)
3307 (barf-if-buffer-read-only)
3308 (erase-buffer)
3309 (save-excursion
3310 (insert-buffer-substring oldbuf start end)))))
3311 \f
3312 (put 'mark-inactive 'error-conditions '(mark-inactive error))
3313 (put 'mark-inactive 'error-message "The mark is not active now")
3315 (defvar activate-mark-hook nil
3316 "Hook run when the mark becomes active.
3317 It is also run at the end of a command, if the mark is active and
3318 it is possible that the region may have changed.")
3320 (defvar deactivate-mark-hook nil
3321 "Hook run when the mark becomes inactive.")
3323 (defun mark (&optional force)
3324 "Return this buffer's mark value as integer, or nil if never set.
3326 In Transient Mark mode, this function signals an error if
3327 the mark is not active. However, if `mark-even-if-inactive' is non-nil,
3328 or the argument FORCE is non-nil, it disregards whether the mark
3329 is active, and returns an integer or nil in the usual way.
3331 If you are using this in an editing command, you are most likely making
3332 a mistake; see the documentation of `set-mark'."
3333 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
3334 (marker-position (mark-marker))
3335 (signal 'mark-inactive nil)))
3337 ;; Many places set mark-active directly, and several of them failed to also
3338 ;; run deactivate-mark-hook. This shorthand should simplify.
3339 (defsubst deactivate-mark ()
3340 "Deactivate the mark by setting `mark-active' to nil.
3341 \(That makes a difference only in Transient Mark mode.)
3342 Also runs the hook `deactivate-mark-hook'."
3343 (cond
3344 ((eq transient-mark-mode 'lambda)
3345 (setq transient-mark-mode nil))
3346 (transient-mark-mode
3347 (setq mark-active nil)
3348 (run-hooks 'deactivate-mark-hook))))
3350 (defun activate-mark ()
3351 "Activate the mark."
3352 (when (mark t)
3353 (setq mark-active t)
3354 (unless transient-mark-mode
3355 (setq transient-mark-mode 'lambda))))
3357 (defcustom select-active-regions nil
3358 "If non-nil, an active region automatically becomes the window selection."
3359 :type 'boolean
3360 :group 'killing
3361 :version "23.1")
3363 (defun set-mark (pos)
3364 "Set this buffer's mark to POS. Don't use this function!
3365 That is to say, don't use this function unless you want
3366 the user to see that the mark has moved, and you want the previous
3367 mark position to be lost.
3369 Normally, when a new mark is set, the old one should go on the stack.
3370 This is why most applications should use `push-mark', not `set-mark'.
3372 Novice Emacs Lisp programmers often try to use the mark for the wrong
3373 purposes. The mark saves a location for the user's convenience.
3374 Most editing commands should not alter the mark.
3375 To remember a location for internal use in the Lisp program,
3376 store it in a Lisp variable. Example:
3378 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3380 (if pos
3381 (progn
3382 (setq mark-active t)
3383 (run-hooks 'activate-mark-hook)
3384 (and select-active-regions
3385 (x-set-selection
3386 nil (buffer-substring (region-beginning) (region-end))))
3387 (set-marker (mark-marker) pos (current-buffer)))
3388 ;; Normally we never clear mark-active except in Transient Mark mode.
3389 ;; But when we actually clear out the mark value too,
3390 ;; we must clear mark-active in any mode.
3391 (setq mark-active nil)
3392 (run-hooks 'deactivate-mark-hook)
3393 (set-marker (mark-marker) nil)))
3395 (defcustom use-empty-active-region nil
3396 "If non-nil, an active region takes control even if empty.
3397 This applies to certain commands which, in Transient Mark mode,
3398 apply to the active region if there is one. If the setting is t,
3399 these commands apply to an empty active region if there is one.
3400 If the setting is nil, these commands treat an empty active
3401 region as if it were not active."
3402 :type 'boolean
3403 :version "23.1"
3404 :group 'editing-basics)
3406 (defun use-region-p ()
3407 "Return t if certain commands should apply to the region.
3408 Certain commands normally apply to text near point,
3409 but in Transient Mark mode when the mark is active they apply
3410 to the region instead. Such commands should use this subroutine to
3411 test whether to do that.
3413 This function also obeys `use-empty-active-region'."
3414 (and transient-mark-mode mark-active
3415 (or use-empty-active-region (> (region-end) (region-beginning)))))
3417 (defun region-active-p ()
3418 "Return t if Transient Mark mode is enabled and the mark is active.
3419 This is NOT the best function to use to test whether a command should
3420 operate on the region instead of the usual behavior -- for that,
3421 use `use-region-p'."
3422 (and transient-mark-mode mark-active))
3424 (defvar mark-ring nil
3425 "The list of former marks of the current buffer, most recent first.")
3426 (make-variable-buffer-local 'mark-ring)
3427 (put 'mark-ring 'permanent-local t)
3429 (defcustom mark-ring-max 16
3430 "*Maximum size of mark ring. Start discarding off end if gets this big."
3431 :type 'integer
3432 :group 'editing-basics)
3434 (defvar global-mark-ring nil
3435 "The list of saved global marks, most recent first.")
3437 (defcustom global-mark-ring-max 16
3438 "*Maximum size of global mark ring. \
3439 Start discarding off end if gets this big."
3440 :type 'integer
3441 :group 'editing-basics)
3443 (defun pop-to-mark-command ()
3444 "Jump to mark, and pop a new position for mark off the ring
3445 \(does not affect global mark ring\)."
3446 (interactive)
3447 (if (null (mark t))
3448 (error "No mark set in this buffer")
3449 (if (= (point) (mark t))
3450 (message "Mark popped"))
3451 (goto-char (mark t))
3452 (pop-mark)))
3454 (defun push-mark-command (arg &optional nomsg)
3455 "Set mark at where point is.
3456 If no prefix arg and mark is already set there, just activate it.
3457 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3458 (interactive "P")
3459 (let ((mark (marker-position (mark-marker))))
3460 (if (or arg (null mark) (/= mark (point)))
3461 (push-mark nil nomsg t)
3462 (setq mark-active t)
3463 (run-hooks 'activate-mark-hook)
3464 (unless nomsg
3465 (message "Mark activated")))))
3467 (defcustom set-mark-command-repeat-pop nil
3470 will pop the mark twice, and
3472 will pop the mark three times.
3476 :type 'boolean
3477 :group 'editing-basics)
3479 (defun set-mark-command (arg)
3480 "Set the mark where point is, or jump to the mark.
3481 Setting the mark also alters the region, which is the text
3482 between point and mark; this is the closest equivalent in
3485 With no prefix argument, set the mark at point, and push the
3486 old mark position on local mark ring. Also push the old mark on
3487 global mark ring, if the previous mark was set in another buffer.
3489 When Transient Mark Mode is off, immediately repeating this
3490 command activates `transient-mark-mode' temporarily.
3493 jump to the mark, and set the mark from
3494 position popped off the local mark ring \(this does not affect the global
3496 mark ring \(see `pop-global-mark'\).
3498 If `set-mark-command-repeat-pop' is non-nil, repeating
3500 off the local (or global) mark ring and jumps there.
3503 argument, unconditionally set mark where point is, even if
3504 `set-mark-command-repeat-pop' is non-nil.
3506 Novice Emacs Lisp programmers often try to use the mark for the wrong
3507 purposes. See the documentation of `set-mark' for more information."
3508 (interactive "P")
3509 (if (eq transient-mark-mode 'lambda)
3510 (setq transient-mark-mode nil))
3511 (cond
3512 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3513 (push-mark-command nil))
3514 ((not (eq this-command 'set-mark-command))
3515 (if arg
3516 (pop-to-mark-command)
3517 (push-mark-command t)))
3518 ((and set-mark-command-repeat-pop
3519 (eq last-command 'pop-to-mark-command))
3520 (setq this-command 'pop-to-mark-command)
3521 (pop-to-mark-command))
3522 ((and set-mark-command-repeat-pop
3523 (eq last-command 'pop-global-mark)
3524 (not arg))
3525 (setq this-command 'pop-global-mark)
3526 (pop-global-mark))
3527 (arg
3528 (setq this-command 'pop-to-mark-command)
3529 (pop-to-mark-command))
3530 ((eq last-command 'set-mark-command)
3531 (if (region-active-p)
3532 (progn
3533 (deactivate-mark)
3534 (message "Mark deactivated"))
3535 (activate-mark)
3536 (message "Mark activated")))
3537 (t
3538 (push-mark-command nil))))
3540 (defun push-mark (&optional location nomsg activate)
3541 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3542 If the last global mark pushed was not in the current buffer,
3543 also push LOCATION on the global mark ring.
3544 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3546 Novice Emacs Lisp programmers often try to use the mark for the wrong
3547 purposes. See the documentation of `set-mark' for more information.
3549 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil."
3550 (unless (null (mark t))
3551 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3552 (when (> (length mark-ring) mark-ring-max)
3553 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3554 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3555 (set-marker (mark-marker) (or location (point)) (current-buffer))
3556 ;; Now push the mark on the global mark ring.
3557 (if (and global-mark-ring
3558 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3559 ;; The last global mark pushed was in this same buffer.
3560 ;; Don't push another one.
3561 nil
3562 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3563 (when (> (length global-mark-ring) global-mark-ring-max)
3564 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3565 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3566 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3567 (message "Mark set"))
3568 (if (or activate (not transient-mark-mode))
3569 (set-mark (mark t)))
3570 nil)
3572 (defun pop-mark ()
3573 "Pop off mark ring into the buffer's actual mark.
3574 Does not set point. Does nothing if mark ring is empty."
3575 (when mark-ring
3576 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3577 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3578 (move-marker (car mark-ring) nil)
3579 (if (null (mark t)) (ding))
3580 (setq mark-ring (cdr mark-ring)))
3581 (deactivate-mark))
3583 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3584 (defun exchange-point-and-mark (&optional arg)
3585 "Put the mark where point is now, and point where the mark is now.
3586 This command works even when the mark is not active,
3587 and it reactivates the mark.
3588 With prefix arg, `transient-mark-mode' is enabled temporarily."
3589 (interactive "P")
3590 (deactivate-mark)
3591 (let ((omark (mark t)))
3592 (if (null omark)
3593 (error "No mark set in this buffer"))
3594 (set-mark (point))
3595 (goto-char omark)
3596 (if (or (and arg (region-active-p)) ; (xor arg (not (region-active-p)))
3597 (not (or arg (region-active-p))))
3598 (deactivate-mark)
3599 (activate-mark))
3600 nil))
3602 (define-minor-mode transient-mark-mode
3603 "Toggle Transient Mark mode.
3604 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3606 In Transient Mark mode, when the mark is active, the region is highlighted.
3608 So do certain other operations that set the mark
3609 but whose main purpose is something else--for example,
3615 Many commands change their behavior when Transient Mark mode is in effect
3616 and the mark is active, by acting on the region instead of their usual
3617 default part of the buffer's text. Examples of such commands include
3622 commands which are sensitive to the Transient Mark mode."
3623 :global t
3624 :init-value (not noninteractive)
3625 :group 'editing-basics)
3627 (defvar widen-automatically t
3628 "Non-nil means it is ok for commands to call `widen' when they want to.
3629 Some commands will do this in order to go to positions outside
3630 the current accessible part of the buffer.
3632 If `widen-automatically' is nil, these commands will do something else
3633 as a fallback, and won't change the buffer bounds.")
3635 (defun pop-global-mark ()
3636 "Pop off global mark ring and jump to the top location."
3637 (interactive)
3638 ;; Pop entries which refer to non-existent buffers.
3639 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3640 (setq global-mark-ring (cdr global-mark-ring)))
3641 (or global-mark-ring
3642 (error "No global mark set"))
3643 (let* ((marker (car global-mark-ring))
3644 (buffer (marker-buffer marker))
3645 (position (marker-position marker)))
3646 (setq global-mark-ring (nconc (cdr global-mark-ring)
3647 (list (car global-mark-ring))))
3648 (set-buffer buffer)
3649 (or (and (>= position (point-min))
3650 (<= position (point-max)))
3651 (if widen-automatically
3652 (widen)
3653 (error "Global mark position is outside accessible part of buffer")))
3654 (goto-char position)
3655 (switch-to-buffer buffer)))
3656 \f
3657 (defcustom next-line-add-newlines nil
3658 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3659 :type 'boolean
3660 :version "21.1"
3661 :group 'editing-basics)
3663 (defun next-line (&optional arg try-vscroll)
3664 "Move cursor vertically down ARG lines.
3665 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3666 If there is no character in the target line exactly under the current column,
3667 the cursor is positioned after the character in that line which spans this
3668 column, or at the end of the line if it is not long enough.
3669 If there is no line in the buffer after this one, behavior depends on the
3670 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3671 to create a line, and moves the cursor to that line. Otherwise it moves the
3672 cursor to the end of the buffer.
3675 a semipermanent goal column for this command.
3676 Then instead of trying to move exactly vertically (or as close as possible),
3677 this command moves to the specified goal column (or as close as possible).
3678 The goal column is stored in the variable `goal-column', which is nil
3679 when there is no goal column.
3681 If you are thinking of using this in a Lisp program, consider
3682 using `forward-line' instead. It is usually easier to use
3683 and more reliable (no dependence on goal column, etc.)."
3685 (or arg (setq arg 1))
3686 (if (and next-line-add-newlines (= arg 1))
3687 (if (save-excursion (end-of-line) (eobp))
3688 ;; When adding a newline, don't expand an abbrev.
3689 (let ((abbrev-mode nil))
3690 (end-of-line)
3692 (line-move arg nil nil try-vscroll))
3693 (if (interactive-p)
3694 (condition-case nil
3695 (line-move arg nil nil try-vscroll)
3696 ((beginning-of-buffer end-of-buffer) (ding)))
3697 (line-move arg nil nil try-vscroll)))
3698 nil)
3700 (defun previous-line (&optional arg try-vscroll)
3701 "Move cursor vertically up ARG lines.
3702 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3703 If there is no character in the target line exactly over the current column,
3704 the cursor is positioned after the character in that line which spans this
3705 column, or at the end of the line if it is not long enough.
3708 a semipermanent goal column for this command.
3709 Then instead of trying to move exactly vertically (or as close as possible),
3710 this command moves to the specified goal column (or as close as possible).
3711 The goal column is stored in the variable `goal-column', which is nil
3712 when there is no goal column.
3714 If you are thinking of using this in a Lisp program, consider using
3715 `forward-line' with a negative argument instead. It is usually easier
3716 to use and more reliable (no dependence on goal column, etc.)."
3718 (or arg (setq arg 1))
3719 (if (interactive-p)
3720 (condition-case nil
3721 (line-move (- arg) nil nil try-vscroll)
3722 ((beginning-of-buffer end-of-buffer) (ding)))
3723 (line-move (- arg) nil nil try-vscroll))
3724 nil)
3726 (defcustom track-eol nil
3727 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3728 This means moving to the end of each line moved onto.
3729 The beginning of a blank line does not count as the end of a line."
3730 :type 'boolean
3731 :group 'editing-basics)
3733 (defcustom goal-column nil
3735 :type '(choice integer
3736 (const :tag "None" nil))
3737 :group 'editing-basics)
3738 (make-variable-buffer-local 'goal-column)
3740 (defvar temporary-goal-column 0
3741 "Current goal column for vertical motion.
3742 It is the column where point was
3743 at the start of current run of vertical motion commands.
3744 When the `track-eol' feature is doing its job, the value is `most-positive-fixnum'.")
3746 (defcustom line-move-ignore-invisible t
3748 Outline mode sets this."
3749 :type 'boolean
3750 :group 'editing-basics)
3752 ;; Returns non-nil if partial move was done.
3753 (defun line-move-partial (arg noerror to-end)
3754 (if (< arg 0)
3755 ;; Move backward (up).
3756 ;; If already vscrolled, reduce vscroll
3757 (let ((vs (window-vscroll nil t)))
3758 (when (> vs (frame-char-height))
3759 (set-window-vscroll nil (- vs (frame-char-height)) t)))
3761 ;; Move forward (down).
3762 (let* ((lh (window-line-height -1))
3763 (vpos (nth 1 lh))
3764 (ypos (nth 2 lh))
3765 (rbot (nth 3 lh))
3766 py vs)
3767 (when (or (null lh)
3768 (>= rbot (frame-char-height))
3769 (<= ypos (- (frame-char-height))))
3770 (unless lh
3771 (let ((wend (pos-visible-in-window-p t nil t)))
3772 (setq rbot (nth 3 wend)
3773 vpos (nth 5 wend))))
3774 (cond
3775 ;; If last line of window is fully visible, move forward.
3776 ((or (null rbot) (= rbot 0))
3777 nil)
3778 ;; If cursor is not in the bottom scroll margin, move forward.
3779 ((and (> vpos 0)
3780 (< (setq py
3781 (or (nth 1 (window-line-height))
3782 (let ((ppos (posn-at-point)))
3783 (cdr (or (posn-actual-col-row ppos)
3784 (posn-col-row ppos))))))
3785 (min (- (window-text-height) scroll-margin 1) (1- vpos))))
3786 nil)
3787 ;; When already vscrolled, we vscroll some more if we can,
3788 ;; or clear vscroll and move forward at end of tall image.
3789 ((> (setq vs (window-vscroll nil t)) 0)
3790 (when (> rbot 0)
3791 (set-window-vscroll nil (+ vs (min rbot (frame-char-height))) t)))
3792 ;; If cursor just entered the bottom scroll margin, move forward,
3793 ;; but also vscroll one line so redisplay wont recenter.
3794 ((and (> vpos 0)
3795 (= py (min (- (window-text-height) scroll-margin 1)
3796 (1- vpos))))
3797 (set-window-vscroll nil (frame-char-height) t)
3798 (line-move-1 arg noerror to-end)
3799 t)
3800 ;; If there are lines above the last line, scroll-up one line.
3801 ((> vpos 0)
3802 (scroll-up 1)
3803 t)
3804 ;; Finally, start vscroll.
3805 (t
3806 (set-window-vscroll nil (frame-char-height) t)))))))
3809 ;; This is like line-move-1 except that it also performs
3810 ;; vertical scrolling of tall images if appropriate.
3811 ;; That is not really a clean thing to do, since it mixes
3812 ;; scrolling with cursor motion. But so far we don't have
3813 ;; a cleaner solution to the problem of making C-n do something
3814 ;; useful given a tall image.
3815 (defun line-move (arg &optional noerror to-end try-vscroll)
3816 (unless (and auto-window-vscroll try-vscroll
3817 ;; Only vscroll for single line moves
3818 (= (abs arg) 1)
3819 ;; But don't vscroll in a keyboard macro.
3820 (not defining-kbd-macro)
3821 (not executing-kbd-macro)
3822 (line-move-partial arg noerror to-end))
3823 (set-window-vscroll nil 0 t)
3824 (line-move-1 arg noerror to-end)))
3826 ;; This is the guts of next-line and previous-line.
3827 ;; Arg says how many lines to move.
3828 ;; The value is t if we can move the specified number of lines.
3829 (defun line-move-1 (arg &optional noerror to-end)
3830 ;; Don't run any point-motion hooks, and disregard intangibility,
3831 ;; for intermediate positions.
3832 (let ((inhibit-point-motion-hooks t)
3833 (opoint (point))
3834 (orig-arg arg))
3835 (unwind-protect
3836 (progn
3837 (if (not (memq last-command '(next-line previous-line)))
3838 (setq temporary-goal-column
3839 (if (and track-eol (eolp)
3840 ;; Don't count beg of empty line as end of line
3841 ;; unless we just did explicit end-of-line.
3842 (or (not (bolp)) (eq last-command 'move-end-of-line)))
3843 most-positive-fixnum
3844 (current-column))))
3846 (if (not (or (integerp selective-display)
3847 line-move-ignore-invisible))
3848 ;; Use just newline characters.
3849 ;; Set ARG to 0 if we move as many lines as requested.
3850 (or (if (> arg 0)
3851 (progn (if (> arg 1) (forward-line (1- arg)))
3852 ;; This way of moving forward ARG lines
3853 ;; verifies that we have a newline after the last one.
3854 ;; It doesn't get confused by intangible text.
3855 (end-of-line)
3856 (if (zerop (forward-line 1))
3857 (setq arg 0)))
3858 (and (zerop (forward-line arg))
3859 (bolp)
3860 (setq arg 0)))
3861 (unless noerror
3862 (signal (if (< arg 0)
3863 'beginning-of-buffer
3864 'end-of-buffer)
3865 nil)))
3866 ;; Move by arg lines, but ignore invisible ones.
3867 (let (done)
3868 (while (and (> arg 0) (not done))
3869 ;; If the following character is currently invisible,
3870 ;; skip all characters with that same `invisible' property value.
3871 (while (and (not (eobp)) (invisible-p (point)))
3872 (goto-char (next-char-property-change (point))))
3873 ;; Move a line.
3874 ;; We don't use `end-of-line', since we want to escape
3875 ;; from field boundaries ocurring exactly at point.
3876 (goto-char (constrain-to-field
3877 (let ((inhibit-field-text-motion t))
3878 (line-end-position))
3879 (point) t t
3880 'inhibit-line-move-field-capture))
3881 ;; If there's no invisibility here, move over the newline.
3882 (cond
3883 ((eobp)
3884 (if (not noerror)
3885 (signal 'end-of-buffer nil)
3886 (setq done t)))
3887 ((and (> arg 1) ;; Use vertical-motion for last move
3888 (not (integerp selective-display))
3889 (not (invisible-p (point))))
3890 ;; We avoid vertical-motion when possible
3891 ;; because that has to fontify.
3892 (forward-line 1))
3893 ;; Otherwise move a more sophisticated way.
3894 ((zerop (vertical-motion 1))
3895 (if (not noerror)
3896 (signal 'end-of-buffer nil)
3897 (setq done t))))
3898 (unless done
3899 (setq arg (1- arg))))
3900 ;; The logic of this is the same as the loop above,
3901 ;; it just goes in the other direction.
3902 (while (and (< arg 0) (not done))
3903 ;; For completely consistency with the forward-motion
3904 ;; case, we should call beginning-of-line here.
3905 ;; However, if point is inside a field and on a
3906 ;; continued line, the call to (vertical-motion -1)
3907 ;; below won't move us back far enough; then we return
3908 ;; to the same column in line-move-finish, and point
3909 ;; gets stuck -- cyd
3910 (forward-line 0)
3911 (cond
3912 ((bobp)
3913 (if (not noerror)
3914 (signal 'beginning-of-buffer nil)
3915 (setq done t)))
3916 ((and (< arg -1) ;; Use vertical-motion for last move
3917 (not (integerp selective-display))
3918 (not (invisible-p (1- (point)))))
3919 (forward-line -1))
3920 ((zerop (vertical-motion -1))
3921 (if (not noerror)
3922 (signal 'beginning-of-buffer nil)
3923 (setq done t))))
3924 (unless done
3925 (setq arg (1+ arg))
3926 (while (and ;; Don't move over previous invis lines
3927 ;; if our target is the middle of this line.
3928 (or (zerop (or goal-column temporary-goal-column))
3929 (< arg 0))
3930 (not (bobp)) (invisible-p (1- (point))))
3931 (goto-char (previous-char-property-change (point))))))))
3932 ;; This is the value the function returns.
3933 (= arg 0))
3935 (cond ((> arg 0)
3936 ;; If we did not move down as far as desired,
3937 ;; at least go to end of line.
3938 (end-of-line))
3939 ((< arg 0)
3940 ;; If we did not move up as far as desired,
3941 ;; at least go to beginning of line.
3942 (beginning-of-line))
3943 (t
3944 (line-move-finish (or goal-column temporary-goal-column)
3945 opoint (> orig-arg 0)))))))
3947 (defun line-move-finish (column opoint forward)
3948 (let ((repeat t))
3949 (while repeat
3950 ;; Set REPEAT to t to repeat the whole thing.
3951 (setq repeat nil)
3953 (let (new
3954 (old (point))
3955 (line-beg (save-excursion (beginning-of-line) (point)))
3956 (line-end
3957 ;; Compute the end of the line
3958 ;; ignoring effectively invisible newlines.
3959 (save-excursion
3960 ;; Like end-of-line but ignores fields.
3962 (while (and (not (eobp)) (invisible-p (point)))
3963 (goto-char (next-char-property-change (point)))
3965 (point))))
3967 ;; Move to the desired column.
3968 (line-move-to-column column)
3970 ;; Corner case: suppose we start out in a field boundary in
3971 ;; the middle of a continued line. When we get to
3972 ;; line-move-finish, point is at the start of a new *screen*
3973 ;; line but the same text line; then line-move-to-column would
3974 ;; move us backwards. Test using C-n with point on the "x" in
3975 ;; (insert "a" (propertize "x" 'field t) (make-string 89 ?y))
3976 (and forward
3977 (< (point) old)
3978 (goto-char old))
3980 (setq new (point))
3982 ;; Process intangibility within a line.
3983 ;; With inhibit-point-motion-hooks bound to nil, a call to
3984 ;; goto-char moves point past intangible text.
3986 ;; However, inhibit-point-motion-hooks controls both the
3987 ;; intangibility and the point-entered/point-left hooks. The
3988 ;; following hack avoids calling the point-* hooks
3989 ;; unnecessarily. Note that we move *forward* past intangible
3990 ;; text when the initial and final points are the same.
3991 (goto-char new)
3992 (let ((inhibit-point-motion-hooks nil))
3993 (goto-char new)
3995 ;; If intangibility moves us to a different (later) place
3996 ;; in the same line, use that as the destination.
3997 (if (<= (point) line-end)
3998 (setq new (point))
3999 ;; If that position is "too late",
4000 ;; try the previous allowable position.
4001 ;; See if it is ok.
4002 (backward-char)
4003 (if (if forward
4004 ;; If going forward, don't accept the previous
4005 ;; allowable position if it is before the target line.
4006 (< line-beg (point))
4007 ;; If going backward, don't accept the previous
4008 ;; allowable position if it is still after the target line.
4009 (<= (point) line-end))
4010 (setq new (point))
4011 ;; As a last resort, use the end of the line.
4012 (setq new line-end))))
4014 ;; Now move to the updated destination, processing fields
4015 ;; as well as intangibility.
4016 (goto-char opoint)
4017 (let ((inhibit-point-motion-hooks nil))
4018 (goto-char
4019 ;; Ignore field boundaries if the initial and final
4020 ;; positions have the same `field' property, even if the
4021 ;; fields are non-contiguous. This seems to be "nicer"
4022 ;; behavior in many situations.
4023 (if (eq (get-char-property new 'field)
4024 (get-char-property opoint 'field))
4025 new
4026 (constrain-to-field new opoint t t
4027 'inhibit-line-move-field-capture))))
4029 ;; If all this moved us to a different line,
4030 ;; retry everything within that new line.
4031 (when (or (< (point) line-beg) (> (point) line-end))
4032 ;; Repeat the intangibility and field processing.
4033 (setq repeat t))))))
4035 (defun line-move-to-column (col)
4036 "Try to find column COL, considering invisibility.
4037 This function works only in certain cases,
4038 because what we really need is for `move-to-column'
4039 and `current-column' to be able to ignore invisible text."
4040 (if (zerop col)
4041 (beginning-of-line)
4042 (move-to-column col))
4044 (when (and line-move-ignore-invisible
4045 (not (bolp)) (invisible-p (1- (point))))
4046 (let ((normal-location (point))
4047 (normal-column (current-column)))
4048 ;; If the following character is currently invisible,
4049 ;; skip all characters with that same `invisible' property value.
4050 (while (and (not (eobp))
4051 (invisible-p (point)))
4052 (goto-char (next-char-property-change (point))))
4053 ;; Have we advanced to a larger column position?
4054 (if (> (current-column) normal-column)
4055 ;; We have made some progress towards the desired column.
4056 ;; See if we can make any further progress.
4057 (line-move-to-column (+ (current-column) (- col normal-column)))
4058 ;; Otherwise, go to the place we originally found
4059 ;; and move back over invisible text.
4060 ;; that will get us to the same place on the screen
4061 ;; but with a more reasonable buffer position.
4062 (goto-char normal-location)
4063 (let ((line-beg (save-excursion (beginning-of-line) (point))))
4064 (while (and (not (bolp)) (invisible-p (1- (point))))
4065 (goto-char (previous-char-property-change (point) line-beg))))))))
4067 (defun move-end-of-line (arg)
4068 "Move point to end of current line as displayed.
4069 \(If there's an image in the line, this disregards newlines
4070 which are part of the text that the image rests on.)
4072 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4073 If point reaches the beginning or end of buffer, it stops there.
4074 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4075 (interactive "p")
4076 (or arg (setq arg 1))
4077 (let (done)
4078 (while (not done)
4079 (let ((newpos
4080 (save-excursion
4081 (let ((goal-column 0))
4082 (and (line-move arg t)
4083 (not (bobp))
4084 (progn
4085 (while (and (not (bobp)) (invisible-p (1- (point))))
4086 (goto-char (previous-single-char-property-change
4087 (point) 'invisible)))
4088 (backward-char 1)))
4089 (point)))))
4090 (goto-char newpos)
4091 (if (and (> (point) newpos)
4093 (backward-char 1)
4094 (if (and (> (point) newpos) (not (eobp))
4096 ;; If we skipped something intangible
4097 ;; and now we're not really at eol,
4098 ;; keep going.
4099 (setq arg 1)
4100 (setq done t)))))))
4102 (defun move-beginning-of-line (arg)
4103 "Move point to beginning of current line as displayed.
4104 \(If there's an image in the line, this disregards newlines
4105 which are part of the text that the image rests on.)
4107 With argument ARG not nil or 1, move forward ARG - 1 lines first.
4108 If point reaches the beginning or end of buffer, it stops there.
4109 To ignore intangibility, bind `inhibit-point-motion-hooks' to t."
4110 (interactive "p")
4111 (or arg (setq arg 1))
4113 (let ((orig (point))
4114 first-vis first-vis-field-value)
4116 ;; Move by lines, if ARG is not 1 (the default).
4117 (if (/= arg 1)
4118 (line-move (1- arg) t))
4120 ;; Move to beginning-of-line, ignoring fields and invisibles.
4122 (while (and (not (bobp)) (invisible-p (1- (point))))
4123 (goto-char (previous-char-property-change (point)))
4126 ;; Now find first visible char in the line
4127 (while (and (not (eobp)) (invisible-p (point)))
4128 (goto-char (next-char-property-change (point))))
4129 (setq first-vis (point))
4131 ;; See if fields would stop us from reaching FIRST-VIS.
4132 (setq first-vis-field-value
4133 (constrain-to-field first-vis orig (/= arg 1) t nil))
4135 (goto-char (if (/= first-vis-field-value first-vis)
4136 ;; If yes, obey them.
4137 first-vis-field-value
4138 ;; Otherwise, move to START with attention to fields.
4139 ;; (It is possible that fields never matter in this case.)
4140 (constrain-to-field (point) orig
4141 (/= arg 1) t nil)))))
4144 ;;; Many people have said they rarely use this feature, and often type
4145 ;;; it by accident. Maybe it shouldn't even be on a key.
4146 (put 'set-goal-column 'disabled t)
4148 (defun set-goal-column (arg)
4150 Those commands will move to this position in the line moved to
4151 rather than trying to keep the same horizontal position.
4152 With a non-nil argument, clears out the goal column
4154 The goal column is stored in the variable `goal-column'."
4155 (interactive "P")
4156 (if arg
4157 (progn
4158 (setq goal-column nil)
4159 (message "No goal column"))
4160 (setq goal-column (current-column))
4161 ;; The older method below can be erroneous if `set-goal-column' is bound
4162 ;; to a sequence containing %
4163 ;;(message (substitute-command-keys
4165 ;;goal-column)
4166 (message "%s"
4167 (concat
4168 (format "Goal column %d " goal-column)
4169 (substitute-command-keys
4172 )
4173 nil)
4174 \f
4176 (defun scroll-other-window-down (lines)
4178 For more details, see the documentation for `scroll-other-window'."
4179 (interactive "P")
4180 (scroll-other-window
4181 ;; Just invert the argument's meaning.
4182 ;; We can do that without knowing which window it will be.
4183 (if (eq lines '-) nil
4184 (if (null lines) '-
4185 (- (prefix-numeric-value lines))))))
4187 (defun beginning-of-buffer-other-window (arg)
4188 "Move point to the beginning of the buffer in the other window.
4189 Leave mark at previous position.
4190 With arg N, put point N/10 of the way from the true beginning."
4191 (interactive "P")
4192 (let ((orig-window (selected-window))
4193 (window (other-window-for-scrolling)))
4194 ;; We use unwind-protect rather than save-window-excursion
4195 ;; because the latter would preserve the things we want to change.
4196 (unwind-protect
4197 (progn
4198 (select-window window)
4199 ;; Set point and mark in that window's buffer.
4200 (with-no-warnings
4201 (beginning-of-buffer arg))
4202 ;; Set point accordingly.
4203 (recenter '(t)))
4204 (select-window orig-window))))
4206 (defun end-of-buffer-other-window (arg)
4207 "Move point to the end of the buffer in the other window.
4208 Leave mark at previous position.
4209 With arg N, put point N/10 of the way from the true end."
4210 (interactive "P")
4211 ;; See beginning-of-buffer-other-window for comments.
4212 (let ((orig-window (selected-window))
4213 (window (other-window-for-scrolling)))
4214 (unwind-protect
4215 (progn
4216 (select-window window)
4217 (with-no-warnings
4218 (end-of-buffer arg))
4219 (recenter '(t)))
4220 (select-window orig-window))))
4221 \f
4222 (defun transpose-chars (arg)
4223 "Interchange characters around point, moving forward one character.
4224 With prefix arg ARG, effect is to take character before point
4225 and drag it forward past ARG other characters (backward if ARG negative).
4226 If no argument and at end of line, the previous two chars are exchanged."
4227 (interactive "*P")
4228 (and (null arg) (eolp) (forward-char -1))
4229 (transpose-subr 'forward-char (prefix-numeric-value arg)))
4231 (defun transpose-words (arg)
4232 "Interchange words around point, leaving point at end of them.
4233 With prefix arg ARG, effect is to take word before or around point
4234 and drag it forward past ARG other words (backward if ARG negative).
4235 If ARG is zero, the words around or after point and around or after mark
4236 are interchanged."
4237 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
4238 (interactive "*p")
4239 (transpose-subr 'forward-word arg))
4241 (defun transpose-sexps (arg)
4243 Does not work on a sexp that point is in the middle of
4244 if it is a list or string."
4245 (interactive "*p")
4246 (transpose-subr
4247 (lambda (arg)
4248 ;; Here we should try to simulate the behavior of
4249 ;; (cons (progn (forward-sexp x) (point))
4250 ;; (progn (forward-sexp (- x)) (point)))
4251 ;; Except that we don't want to rely on the second forward-sexp
4252 ;; putting us back to where we want to be, since forward-sexp-function
4253 ;; might do funny things like infix-precedence.
4254 (if (if (> arg 0)
4256 (and (not (bobp))
4258 ;; Jumping over a symbol. We might be inside it, mind you.
4259 (progn (funcall (if (> arg 0)
4260 'skip-syntax-backward 'skip-syntax-forward)
4261 "w_")
4262 (cons (save-excursion (forward-sexp arg) (point)) (point)))
4263 ;; Otherwise, we're between sexps. Take a step back before jumping
4264 ;; to make sure we'll obey the same precedence no matter which direction
4265 ;; we're going.
4266 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
4267 (cons (save-excursion (forward-sexp arg) (point))
4268 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
4269 (not (zerop (funcall (if (> arg 0)
4270 'skip-syntax-forward
4271 'skip-syntax-backward)
4272 ".")))))
4273 (point)))))
4274 arg 'special))
4276 (defun transpose-lines (arg)
4277 "Exchange current line and previous line, leaving point after both.
4278 With argument ARG, takes previous line and moves it past ARG lines.
4279 With argument 0, interchanges line point is in with line mark is in."
4280 (interactive "*p")
4281 (transpose-subr (function
4282 (lambda (arg)
4283 (if (> arg 0)
4284 (progn
4285 ;; Move forward over ARG lines,
4286 ;; but create newlines if necessary.
4287 (setq arg (forward-line arg))
4289 (setq arg (1+ arg)))
4290 (if (> arg 0)
4291 (newline arg)))
4292 (forward-line arg))))
4293 arg))
4295 (defun transpose-subr (mover arg &optional special)
4296 (let ((aux (if special mover
4297 (lambda (x)
4298 (cons (progn (funcall mover x) (point))
4299 (progn (funcall mover (- x)) (point))))))
4300 pos1 pos2)
4301 (cond
4302 ((= arg 0)
4303 (save-excursion
4304 (setq pos1 (funcall aux 1))
4305 (goto-char (mark))
4306 (setq pos2 (funcall aux 1))
4307 (transpose-subr-1 pos1 pos2))
4308 (exchange-point-and-mark))
4309 ((> arg 0)
4310 (setq pos1 (funcall aux -1))
4311 (setq pos2 (funcall aux arg))
4312 (transpose-subr-1 pos1 pos2)
4313 (goto-char (car pos2)))
4314 (t
4315 (setq pos1 (funcall aux -1))
4316 (goto-char (car pos1))
4317 (setq pos2 (funcall aux arg))
4318 (transpose-subr-1 pos1 pos2)))))
4320 (defun transpose-subr-1 (pos1 pos2)
4321 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
4322 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
4323 (when (> (car pos1) (car pos2))
4324 (let ((swap pos1))
4325 (setq pos1 pos2 pos2 swap)))
4326 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
4327 (atomic-change-group
4328 (let (word2)
4329 ;; FIXME: We first delete the two pieces of text, so markers that
4330 ;; used to point to after the text end up pointing to before it :-(
4331 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
4332 (goto-char (car pos2))
4333 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
4334 (goto-char (car pos1))
4335 (insert word2))))
4336 \f
4337 (defun backward-word (&optional arg)
4338 "Move backward until encountering the beginning of a word.
4339 With argument, do this that many times."
4340 (interactive "p")
4341 (forward-word (- (or arg 1))))
4343 (defun mark-word (&optional arg allow-extend)
4344 "Set mark ARG words away from point.
4346 move to with the same argument.
4347 Interactively, if this command is repeated
4348 or (in Transient Mark mode) if the mark is active,
4349 it marks the next ARG words after the ones already marked."
4351 (cond ((and allow-extend
4352 (or (and (eq last-command this-command) (mark t))
4353 (and transient-mark-mode mark-active)))
4354 (setq arg (if arg (prefix-numeric-value arg)
4355 (if (< (mark) (point)) -1 1)))
4356 (set-mark
4357 (save-excursion
4358 (goto-char (mark))
4359 (forward-word arg)
4360 (point))))
4361 (t
4362 (push-mark
4363 (save-excursion
4364 (forward-word (prefix-numeric-value arg))
4365 (point))
4366 nil t))))
4368 (defun kill-word (arg)
4369 "Kill characters forward until encountering the end of a word.
4370 With argument, do this that many times."
4371 (interactive "p")
4372 (kill-region (point) (progn (forward-word arg) (point))))
4374 (defun backward-kill-word (arg)
4375 "Kill characters backward until encountering the beginning of a word.
4376 With argument, do this that many times."
4377 (interactive "p")
4378 (kill-word (- arg)))
4380 (defun current-word (&optional strict really-word)
4381 "Return the symbol or word that point is on (or a nearby one) as a string.
4382 The return value includes no text properties.
4383 If optional arg STRICT is non-nil, return nil unless point is within
4384 or adjacent to a symbol or word. In all cases the value can be nil
4385 if there is no word nearby.
4386 The function, belying its name, normally finds a symbol.
4387 If optional arg REALLY-WORD is non-nil, it finds just a word."
4388 (save-excursion
4389 (let* ((oldpoint (point)) (start (point)) (end (point))
4390 (syntaxes (if really-word "w" "w_"))
4391 (not-syntaxes (concat "^" syntaxes)))
4392 (skip-syntax-backward syntaxes) (setq start (point))
4393 (goto-char oldpoint)
4394 (skip-syntax-forward syntaxes) (setq end (point))
4395 (when (and (eq start oldpoint) (eq end oldpoint)
4396 ;; Point is neither within nor adjacent to a word.
4397 (not strict))
4398 ;; Look for preceding word in same line.
4399 (skip-syntax-backward not-syntaxes
4400 (save-excursion (beginning-of-line)
4401 (point)))
4402 (if (bolp)
4403 ;; No preceding word in same line.
4404 ;; Look for following word in same line.
4405 (progn
4406 (skip-syntax-forward not-syntaxes
4407 (save-excursion (end-of-line)
4408 (point)))
4409 (setq start (point))
4410 (skip-syntax-forward syntaxes)
4411 (setq end (point)))
4412 (setq end (point))
4413 (skip-syntax-backward syntaxes)
4414 (setq start (point))))
4415 ;; If we found something nonempty, return it as a string.
4416 (unless (= start end)
4417 (buffer-substring-no-properties start end)))))
4418 \f
4419 (defcustom fill-prefix nil
4420 "*String for filling to insert at front of new line, or nil for none."
4421 :type '(choice (const :tag "None" nil)
4422 string)
4423 :group 'fill)
4424 (make-variable-buffer-local 'fill-prefix)
4425 (put 'fill-prefix 'safe-local-variable 'string-or-null-p)
4427 (defcustom auto-fill-inhibit-regexp nil
4428 "*Regexp to match lines which should not be auto-filled."
4429 :type '(choice (const :tag "None" nil)
4430 regexp)
4431 :group 'fill)
4433 ;; This function is used as the auto-fill-function of a buffer
4434 ;; when Auto-Fill mode is enabled.
4435 ;; It returns t if it really did any work.
4436 ;; (Actually some major modes use a different auto-fill function,
4437 ;; but this one is the default one.)
4438 (defun do-auto-fill ()
4439 (let (fc justify give-up
4440 (fill-prefix fill-prefix))
4441 (if (or (not (setq justify (current-justification)))
4442 (null (setq fc (current-fill-column)))
4443 (and (eq justify 'left)
4444 (<= (current-column) fc))
4445 (and auto-fill-inhibit-regexp
4446 (save-excursion (beginning-of-line)
4447 (looking-at auto-fill-inhibit-regexp))))
4448 nil ;; Auto-filling not required
4449 (if (memq justify '(full center right))
4450 (save-excursion (unjustify-current-line)))
4452 ;; Choose a fill-prefix automatically.
4453 (when (and adaptive-fill-mode
4454 (or (null fill-prefix) (string= fill-prefix "")))
4455 (let ((prefix
4456 (fill-context-prefix
4457 (save-excursion (backward-paragraph 1) (point))
4458 (save-excursion (forward-paragraph 1) (point)))))
4459 (and prefix (not (equal prefix ""))
4460 ;; Use auto-indentation rather than a guessed empty prefix.
4461 (not (and fill-indent-according-to-mode
4463 (setq fill-prefix prefix))))
4465 (while (and (not give-up) (> (current-column) fc))
4466 ;; Determine where to split the line.
4467 (let* (after-prefix
4468 (fill-point
4469 (save-excursion
4470 (beginning-of-line)
4471 (setq after-prefix (point))
4472 (and fill-prefix
4473 (looking-at (regexp-quote fill-prefix))
4474 (setq after-prefix (match-end 0)))
4475 (move-to-column (1+ fc))
4476 (fill-move-to-break-point after-prefix)
4477 (point))))
4479 ;; See whether the place we found is any good.
4480 (if (save-excursion
4481 (goto-char fill-point)
4482 (or (bolp)
4483 ;; There is no use breaking at end of line.
4484 (save-excursion (skip-chars-forward " ") (eolp))
4485 ;; It is futile to split at the end of the prefix
4486 ;; since we would just insert the prefix again.
4487 (and after-prefix (<= (point) after-prefix))
4488 ;; Don't split right after a comment starter
4489 ;; since we would just make another comment starter.
4490 (and comment-start-skip
4491 (let ((limit (point)))
4492 (beginning-of-line)
4493 (and (re-search-forward comment-start-skip
4494 limit t)
4495 (eq (point) limit))))))
4496 ;; No good place to break => stop trying.
4497 (setq give-up t)
4498 ;; Ok, we have a useful place to break the line. Do it.
4499 (let ((prev-column (current-column)))
4500 ;; If point is at the fill-point, do not `save-excursion'.
4501 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
4502 ;; point will end up before it rather than after it.
4503 (if (save-excursion
4505 (= (point) fill-point))
4506 (default-indent-new-line t)
4507 (save-excursion
4508 (goto-char fill-point)
4509 (default-indent-new-line t)))
4510 ;; Now do justification, if required
4511 (if (not (eq justify 'left))
4512 (save-excursion
4513 (end-of-line 0)
4514 (justify-current-line justify nil t)))
4515 ;; If making the new line didn't reduce the hpos of
4516 ;; the end of the line, then give up now;
4517 ;; trying again will not help.
4518 (if (>= (current-column) prev-column)
4519 (setq give-up t))))))
4520 ;; Justify last line.
4521 (justify-current-line justify t t)
4522 t)))
4524 (defvar comment-line-break-function 'comment-indent-new-line
4525 "*Mode-specific function which line breaks and continues a comment.
4526 This function is called during auto-filling when a comment syntax
4527 is defined.
4528 The function should take a single optional argument, which is a flag
4529 indicating whether it should use soft newlines.")
4531 (defun default-indent-new-line (&optional soft)
4532 "Break line at point and indent.
4533 If a comment syntax is defined, call `comment-indent-new-line'.
4535 The inserted newline is marked hard if variable `use-hard-newlines' is true,
4536 unless optional argument SOFT is non-nil."
4537 (interactive)
4538 (if comment-start
4539 (funcall comment-line-break-function soft)
4540 ;; Insert the newline before removing empty space so that markers
4541 ;; get preserved better.
4543 (save-excursion (forward-char -1) (delete-horizontal-space))
4544 (delete-horizontal-space)
4546 (if (and fill-prefix (not adaptive-fill-mode))
4547 ;; Blindly trust a non-adaptive fill-prefix.
4548 (progn
4549 (indent-to-left-margin)
4550 (insert-before-markers-and-inherit fill-prefix))
4552 (cond
4553 ;; If there's an adaptive prefix, use it unless we're inside
4554 ;; a comment and the prefix is not a comment starter.
4555 (fill-prefix
4556 (indent-to-left-margin)
4557 (insert-and-inherit fill-prefix))
4558 ;; If we're not inside a comment, just try to indent.
4559 (t (indent-according-to-mode))))))
4561 (defvar normal-auto-fill-function 'do-auto-fill
4562 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4563 Some major modes set this.")
4565 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4566 ;; FIXME: turn into a proper minor mode.
4567 ;; Add a global minor mode version of it.
4568 (defun auto-fill-mode (&optional arg)
4569 "Toggle Auto Fill mode.
4570 With arg, turn Auto Fill mode on if and only if arg is positive.
4571 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4572 automatically breaks the line at a previous space.
4574 The value of `normal-auto-fill-function' specifies the function to use
4575 for `auto-fill-function' when turning Auto Fill mode on."
4576 (interactive "P")
4577 (prog1 (setq auto-fill-function
4578 (if (if (null arg)
4579 (not auto-fill-function)
4580 (> (prefix-numeric-value arg) 0))
4581 normal-auto-fill-function
4582 nil))
4583 (force-mode-line-update)))
4585 ;; This holds a document string used to document auto-fill-mode.
4586 (defun auto-fill-function ()
4587 "Automatically break line at a previous space, in insertion of text."
4588 nil)
4590 (defun turn-on-auto-fill ()
4591 "Unconditionally turn on Auto Fill mode."
4592 (auto-fill-mode 1))
4594 (defun turn-off-auto-fill ()
4595 "Unconditionally turn off Auto Fill mode."
4596 (auto-fill-mode -1))
4598 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4600 (defun set-fill-column (arg)
4601 "Set `fill-column' to specified argument.
4604 (interactive "P")
4605 (if (consp arg)
4606 (setq arg (current-column)))
4607 (if (not (integerp arg))
4608 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4609 (error "set-fill-column requires an explicit argument")
4610 (message "Fill column set to %d (was %d)" arg fill-column)
4611 (setq fill-column arg)))
4612 \f
4613 (defun set-selective-display (arg)
4614 "Set `selective-display' to ARG; clear it if no arg.
4615 When the value of `selective-display' is a number > 0,
4616 lines whose indentation is >= that value are not displayed.
4617 The variable `selective-display' has a separate value for each buffer."
4618 (interactive "P")
4619 (if (eq selective-display t)
4620 (error "selective-display already in use for marked lines"))
4621 (let ((current-vpos
4622 (save-restriction
4623 (narrow-to-region (point-min) (point))
4624 (goto-char (window-start))
4625 (vertical-motion (window-height)))))
4626 (setq selective-display
4627 (and arg (prefix-numeric-value arg)))
4628 (recenter current-vpos))
4629 (set-window-start (selected-window) (window-start (selected-window)))
4630 (princ "selective-display set to " t)
4631 (prin1 selective-display t)
4632 (princ "." t))
4634 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4636 (defun toggle-truncate-lines (&optional arg)
4637 "Toggle whether to fold or truncate long lines for the current buffer.
4638 With prefix argument ARG, truncate long lines if ARG is positive,
4639 otherwise don't truncate them. Note that in side-by-side
4640 windows, truncation is always enabled."
4641 (interactive "P")
4642 (setq truncate-lines
4643 (if (null arg)
4644 (not truncate-lines)
4645 (> (prefix-numeric-value arg) 0)))
4646 (force-mode-line-update)
4647 (unless truncate-lines
4648 (let ((buffer (current-buffer)))
4649 (walk-windows (lambda (window)
4650 (if (eq buffer (window-buffer window))
4651 (set-window-hscroll window 0)))
4652 nil t)))
4653 (message "Truncate long lines %s"
4654 (if truncate-lines "enabled" "disabled")))
4656 (defvar overwrite-mode-textual " Ovwrt"
4657 "The string displayed in the mode line when in overwrite mode.")
4658 (defvar overwrite-mode-binary " Bin Ovwrt"
4659 "The string displayed in the mode line when in binary overwrite mode.")
4661 (defun overwrite-mode (arg)
4662 "Toggle overwrite mode.
4663 With prefix argument ARG, turn overwrite mode on if ARG is positive,
4664 otherwise turn it off. In overwrite mode, printing characters typed
4665 in replace existing text on a one-for-one basis, rather than pushing
4666 it to the right. At the end of a line, such characters extend the line.
4667 Before a tab, such characters insert until the tab is filled in.
4669 is supposed to make it easier to insert characters when necessary."
4670 (interactive "P")
4671 (setq overwrite-mode
4672 (if (if (null arg) (not overwrite-mode)
4673 (> (prefix-numeric-value arg) 0))
4674 'overwrite-mode-textual))
4675 (force-mode-line-update))
4677 (defun binary-overwrite-mode (arg)
4678 "Toggle binary overwrite mode.
4679 With prefix argument ARG, turn binary overwrite mode on if ARG is
4680 positive, otherwise turn it off. In binary overwrite mode, printing
4681 characters typed in replace existing text. Newlines are not treated
4682 specially, so typing at the end of a line joins the line to the next,
4683 with the typed character between them. Typing before a tab character
4685 replaces the text at the cursor, just as ordinary typing characters do.
4687 Note that binary overwrite mode is not its own minor mode; it is a
4688 specialization of overwrite mode, entered by setting the
4689 `overwrite-mode' variable to `overwrite-mode-binary'."
4690 (interactive "P")
4691 (setq overwrite-mode
4692 (if (if (null arg)
4693 (not (eq overwrite-mode 'overwrite-mode-binary))
4694 (> (prefix-numeric-value arg) 0))
4695 'overwrite-mode-binary))
4696 (force-mode-line-update))
4698 (define-minor-mode line-number-mode
4699 "Toggle Line Number mode.
4700 With arg, turn Line Number mode on if arg is positive, otherwise
4701 turn it off. When Line Number mode is enabled, the line number
4702 appears in the mode line.
4704 Line numbers do not appear for very large buffers and buffers
4705 with very long lines; see variables `line-number-display-limit'
4706 and `line-number-display-limit-width'."
4707 :init-value t :global t :group 'mode-line)
4709 (define-minor-mode column-number-mode
4710 "Toggle Column Number mode.
4711 With arg, turn Column Number mode on if arg is positive,
4712 otherwise turn it off. When Column Number mode is enabled, the
4713 column number appears in the mode line."
4714 :global t :group 'mode-line)
4716 (define-minor-mode size-indication-mode
4717 "Toggle Size Indication mode.
4718 With arg, turn Size Indication mode on if arg is positive,
4719 otherwise turn it off. When Size Indication mode is enabled, the
4720 size of the accessible part of the buffer appears in the mode line."
4721 :global t :group 'mode-line)
4722 \f
4723 (defgroup paren-blinking nil
4724 "Blinking matching of parens and expressions."
4725 :prefix "blink-matching-"
4726 :group 'paren-matching)
4728 (defcustom blink-matching-paren t
4729 "*Non-nil means show matching open-paren when close-paren is inserted."
4730 :type 'boolean
4731 :group 'paren-blinking)
4733 (defcustom blink-matching-paren-on-screen t
4734 "*Non-nil means show matching open-paren when it is on screen.
4735 If nil, don't show it (but the open-paren can still be shown
4736 when it is off screen).
4738 This variable has no effect if `blink-matching-paren' is nil.
4739 \(In that case, the open-paren is never shown.)
4740 It is also ignored if `show-paren-mode' is enabled."
4741 :type 'boolean
4742 :group 'paren-blinking)
4744 (defcustom blink-matching-paren-distance (* 25 1024)
4745 "*If non-nil, maximum distance to search backwards for matching open-paren.
4746 If nil, search stops at the beginning of the accessible portion of the buffer."
4747 :type '(choice (const nil) integer)
4748 :group 'paren-blinking)
4750 (defcustom blink-matching-delay 1
4751 "*Time in seconds to delay after showing a matching paren."
4752 :type 'number
4753 :group 'paren-blinking)
4755 (defcustom blink-matching-paren-dont-ignore-comments nil
4756 "*If nil, `blink-matching-paren' ignores comments.
4757 More precisely, when looking for the matching parenthesis,
4758 it skips the contents of comments that end before point."
4759 :type 'boolean
4760 :group 'paren-blinking)
4762 (defun blink-matching-open ()
4763 "Move cursor momentarily to the beginning of the sexp before point."
4764 (interactive)
4765 (when (and (> (point) (point-min))
4766 blink-matching-paren
4767 ;; Verify an even number of quoting characters precede the close.
4768 (= 1 (logand 1 (- (point)
4769 (save-excursion
4770 (forward-char -1)
4772 (point))))))
4773 (let* ((oldpos (point))
4774 (message-log-max nil) ; Don't log messages about paren matching.
4775 (atdollar (eq (syntax-class (syntax-after (1- oldpos))) 8))
4776 (isdollar)
4777 (blinkpos
4778 (save-excursion
4779 (save-restriction
4780 (if blink-matching-paren-distance
4781 (narrow-to-region
4782 (max (minibuffer-prompt-end) ;(point-min) unless minibuf.
4783 (- (point) blink-matching-paren-distance))
4784 oldpos))
4785 (let ((parse-sexp-ignore-comments
4786 (and parse-sexp-ignore-comments
4787 (not blink-matching-paren-dont-ignore-comments))))
4788 (condition-case ()
4789 (scan-sexps oldpos -1)
4790 (error nil))))))
4791 (matching-paren
4792 (and blinkpos
4793 ;; Not syntax '$'.
4794 (not (setq isdollar
4795 (eq (syntax-class (syntax-after blinkpos)) 8)))
4796 (let ((syntax (syntax-after blinkpos)))
4797 (and (consp syntax)
4798 (eq (syntax-class syntax) 4)
4799 (cdr syntax))))))
4800 (cond
4801 ;; isdollar is for:
4802 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-10/msg00871.html
4803 ((not (or (and isdollar blinkpos)
4804 (and atdollar (not blinkpos)) ; see below
4805 (eq matching-paren (char-before oldpos))
4806 ;; The cdr might hold a new paren-class info rather than
4807 ;; a matching-char info, in which case the two CDRs
4808 ;; should match.
4809 (eq matching-paren (cdr (syntax-after (1- oldpos))))))
4810 (message "Mismatched parentheses"))
4811 ((not blinkpos)
4812 (or blink-matching-paren-distance
4813 ;; Don't complain when `$' with no blinkpos, because it
4814 ;; could just be the first one typed in the buffer.
4815 atdollar
4816 (message "Unmatched parenthesis")))
4817 ((pos-visible-in-window-p blinkpos)
4818 ;; Matching open within window, temporarily move to blinkpos but only
4819 ;; if `blink-matching-paren-on-screen' is non-nil.
4820 (and blink-matching-paren-on-screen
4821 (not show-paren-mode)
4822 (save-excursion
4823 (goto-char blinkpos)
4824 (sit-for blink-matching-delay))))
4825 (t
4826 (save-excursion
4827 (goto-char blinkpos)
4828 (let ((open-paren-line-string
4829 ;; Show what precedes the open in its line, if anything.
4830 (cond
4832 (buffer-substring (line-beginning-position)
4833 (1+ blinkpos)))
4834 ;; Show what follows the open in its line, if anything.
4835 ((save-excursion
4836 (forward-char 1)
4838 (not (eolp)))
4839 (buffer-substring blinkpos
4840 (line-end-position)))
4841 ;; Otherwise show the previous nonblank line,
4842 ;; if there is one.
4844 (concat
4845 (buffer-substring (progn
4847 (line-beginning-position))
4848 (progn (end-of-line)
4850 (point)))
4851 ;; Replace the newline and other whitespace with `...'.
4852 "..."
4853 (buffer-substring blinkpos (1+ blinkpos))))
4854 ;; There is nothing to show except the char itself.
4855 (t (buffer-substring blinkpos (1+ blinkpos))))))
4856 (message "Matches %s"
4857 (substring-no-properties open-paren-line-string)))))))))
4859 ;; Turned off because it makes dbx bomb out.
4860 (setq blink-paren-function 'blink-matching-open)
4861 \f
4862 ;; This executes C-g typed while Emacs is waiting for a command.
4863 ;; Quitting out of a program does not go through here;
4864 ;; that happens in the QUIT macro at the C code level.
4865 (defun keyboard-quit ()
4866 "Signal a `quit' condition.
4867 During execution of Lisp code, this character causes a quit directly.
4868 At top-level, as an editor command, this simply beeps."
4869 (interactive)
4870 (deactivate-mark)
4871 (if (fboundp 'kmacro-keyboard-quit)
4872 (kmacro-keyboard-quit))
4873 (setq defining-kbd-macro nil)
4874 (signal 'quit nil))
4876 (defvar buffer-quit-function nil
4879 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4881 (defun keyboard-escape-quit ()
4883 This command can exit an interactive command such as `query-replace',
4884 can clear out a prefix argument or a region,
4885 can get out of the minibuffer or other recursive edit,
4886 cancel the use of the current buffer (for special-purpose buffers),
4887 or go back to just one window (by deleting all but the selected window)."
4888 (interactive)
4889 (cond ((eq last-command 'mode-exited) nil)
4890 ((> (minibuffer-depth) 0)
4891 (abort-recursive-edit))
4892 (current-prefix-arg
4893 nil)
4894 ((and transient-mark-mode mark-active)
4895 (deactivate-mark))
4896 ((> (recursion-depth) 0)
4897 (exit-recursive-edit))
4898 (buffer-quit-function
4899 (funcall buffer-quit-function))
4900 ((not (one-window-p t))
4901 (delete-other-windows))
4903 (bury-buffer))))
4905 (defun play-sound-file (file &optional volume device)
4906 "Play sound stored in FILE.
4907 VOLUME and DEVICE correspond to the keywords of the sound
4908 specification for `play-sound'."
4909 (interactive "fPlay sound file: ")
4910 (let ((sound (list :file file)))
4911 (if volume
4912 (plist-put sound :volume volume))
4913 (if device
4914 (plist-put sound :device device))
4915 (push 'sound sound)
4916 (play-sound sound)))
4918 \f
4919 (defcustom read-mail-command 'rmail
4920 "*Your preference for a mail reading package.
4921 This is used by some keybindings which support reading mail.
4922 See also `mail-user-agent' concerning sending mail."
4923 :type '(choice (function-item rmail)
4924 (function-item gnus)
4925 (function-item mh-rmail)
4926 (function :tag "Other"))
4927 :version "21.1"
4928 :group 'mail)
4930 (defcustom mail-user-agent 'sendmail-user-agent
4931 "*Your preference for a mail composition package.
4932 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4933 outgoing email message. This variable lets you specify which
4934 mail-sending package you prefer.
4936 Valid values include:
4938 `sendmail-user-agent' -- use the default Emacs Mail package.
4939 See Info node `(emacs)Sending Mail'.
4940 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4941 See Info node `(mh-e)'.
4942 `message-user-agent' -- use the Gnus Message package.
4943 See Info node `(message)'.
4944 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4945 paraphernalia, particularly the Gcc: header for
4946 archiving.
4948 Additional valid symbols may be available; check with the author of
4949 your package for details. The function should return non-nil if it
4950 succeeds.
4952 See also `read-mail-command' concerning reading mail."
4953 :type '(radio (function-item :tag "Default Emacs mail"
4955 sendmail-user-agent)
4956 (function-item :tag "Emacs interface to MH"
4958 mh-e-user-agent)
4959 (function-item :tag "Gnus Message package"
4961 message-user-agent)
4962 (function-item :tag "Gnus Message with full Gnus features"
4964 gnus-user-agent)
4965 (function :tag "Other"))
4966 :group 'mail)
4968 (define-mail-user-agent 'sendmail-user-agent
4969 'sendmail-user-agent-compose
4970 'mail-send-and-exit)
4972 (defun rfc822-goto-eoh ()
4973 ;; Go to header delimiter line in a mail message, following RFC822 rules
4974 (goto-char (point-min))
4975 (when (re-search-forward
4977 (goto-char (match-beginning 0))))
4979 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4980 switch-function yank-action
4981 send-actions)
4982 (if switch-function
4983 (let ((special-display-buffer-names nil)
4984 (special-display-regexps nil)
4985 (same-window-buffer-names nil)
4986 (same-window-regexps nil))
4987 (funcall switch-function "*mail*")))
4988 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4989 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4990 (body (cdr (assoc-string "body" other-headers t))))
4991 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4992 continue
4993 (error "Message aborted"))
4994 (save-excursion
4995 (rfc822-goto-eoh)
4996 (while other-headers
4997 (unless (member-ignore-case (car (car other-headers))
4998 '("in-reply-to" "cc" "body"))
4999 (insert (car (car other-headers)) ": "
5000 (cdr (car other-headers))
5002 (setq other-headers (cdr other-headers)))
5003 (when body
5004 (forward-line 1)
5005 (insert body))
5006 t)))
5008 (defun compose-mail (&optional to subject other-headers continue
5009 switch-function yank-action send-actions)
5010 "Start composing a mail message to send.
5011 This uses the user's chosen mail composition package
5012 as selected with the variable `mail-user-agent'.
5013 The optional arguments TO and SUBJECT specify recipients
5014 and the initial Subject field, respectively.
5016 OTHER-HEADERS is an alist specifying additional
5017 header fields. Elements look like (HEADER . VALUE) where both
5018 HEADER and VALUE are strings.
5020 CONTINUE, if non-nil, says to continue editing a message already
5021 being composed.
5023 SWITCH-FUNCTION, if non-nil, is a function to use to
5024 switch to and display the buffer used for mail composition.
5026 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
5027 to insert the raw text of the message being replied to.
5028 It has the form (FUNCTION . ARGS). The user agent will apply
5029 FUNCTION to ARGS, to insert the raw text of the original message.
5030 \(The user agent will also run `mail-citation-hook', *after* the
5031 original text has been inserted in this way.)
5033 SEND-ACTIONS is a list of actions to call when the message is sent.
5034 Each action has the form (FUNCTION . ARGS)."
5035 (interactive
5036 (list nil nil nil current-prefix-arg))
5037 (let ((function (get mail-user-agent 'composefunc)))
5038 (funcall function to subject other-headers continue
5039 switch-function yank-action send-actions)))
5041 (defun compose-mail-other-window (&optional to subject other-headers continue
5042 yank-action send-actions)
5044 (interactive
5045 (list nil nil nil current-prefix-arg))
5046 (compose-mail to subject other-headers continue
5047 'switch-to-buffer-other-window yank-action send-actions))
5050 (defun compose-mail-other-frame (&optional to subject other-headers continue
5051 yank-action send-actions)
5053 (interactive
5054 (list nil nil nil current-prefix-arg))
5055 (compose-mail to subject other-headers continue
5056 'switch-to-buffer-other-frame yank-action send-actions))
5057 \f
5058 (defvar set-variable-value-history nil
5059 "History of values entered with `set-variable'.
5061 Maximum length of the history list is determined by the value
5062 of `history-length', which see.")
5064 (defun set-variable (variable value &optional make-local)
5065 "Set VARIABLE to VALUE. VALUE is a Lisp object.
5066 VARIABLE should be a user option variable name, a Lisp variable
5067 meant to be customized by users. You should enter VALUE in Lisp syntax,
5068 so if you want VALUE to be a string, you must surround it with doublequotes.
5069 VALUE is used literally, not evaluated.
5071 If VARIABLE has a `variable-interactive' property, that is used as if
5072 it were the arg to `interactive' (which see) to interactively read VALUE.
5074 If VARIABLE has been defined with `defcustom', then the type information
5075 in the definition is used to check that VALUE is valid.
5077 With a prefix argument, set VARIABLE to VALUE buffer-locally."
5078 (interactive
5079 (let* ((default-var (variable-at-point))
5080 (var (if (user-variable-p default-var)
5081 (read-variable (format "Set variable (default %s): " default-var)
5082 default-var)
5083 (read-variable "Set variable: ")))
5084 (minibuffer-help-form '(describe-variable var))
5085 (prop (get var 'variable-interactive))
5086 (obsolete (car (get var 'byte-obsolete-variable)))
5087 (prompt (format "Set %s %s to value: " var
5088 (cond ((local-variable-p var)
5089 "(buffer-local)")
5090 ((or current-prefix-arg
5091 (local-variable-if-set-p var))
5092 "buffer-locally")
5093 (t "globally"))))
5094 (val (progn
5095 (when obsolete
5096 (message (concat "`%S' is obsolete; "
5097 (if (symbolp obsolete) "use `%S' instead" "%s"))
5098 var obsolete)
5099 (sit-for 3))
5100 (if prop
5101 ;; Use VAR's `variable-interactive' property
5102 ;; as an interactive spec for prompting.
5103 (call-interactively `(lambda (arg)
5104 (interactive ,prop)
5105 arg))
5106 (read
5107 (read-string prompt nil
5108 'set-variable-value-history
5109 (format "%S" (symbol-value var))))))))
5110 (list var val current-prefix-arg)))
5112 (and (custom-variable-p variable)
5113 (not (get variable 'custom-type))
5114 (custom-load-symbol variable))
5115 (let ((type (get variable 'custom-type)))
5116 (when type
5117 ;; Match with custom type.
5118 (require 'cus-edit)
5119 (setq type (widget-convert type))
5120 (unless (widget-apply type :match value)
5121 (error "Value `%S' does not match type %S of %S"
5122 value (car type) variable))))
5124 (if make-local
5125 (make-local-variable variable))
5127 (set variable value)
5129 ;; Force a thorough redisplay for the case that the variable
5130 ;; has an effect on the display, like `tab-width' has.
5131 (force-mode-line-update))
5132 \f
5133 ;; Define the major mode for lists of completions.
5135 (defvar completion-list-mode-map nil
5136 "Local map for completion list buffers.")
5137 (or completion-list-mode-map
5138 (let ((map (make-sparse-keymap)))
5139 (define-key map [mouse-2] 'mouse-choose-completion)
5140 (define-key map [follow-link] 'mouse-face)
5141 (define-key map [down-mouse-2] nil)
5142 (define-key map "\C-m" 'choose-completion)
5143 (define-key map "\e\e\e" 'delete-completion-window)
5144 (define-key map [left] 'previous-completion)
5145 (define-key map [right] 'next-completion)
5146 (setq completion-list-mode-map map)))
5148 ;; Completion mode is suitable only for specially formatted data.
5149 (put 'completion-list-mode 'mode-class 'special)
5151 (defvar completion-reference-buffer nil
5152 "Record the buffer that was current when the completion list was requested.
5153 This is a local variable in the completion list buffer.
5154 Initial value is nil to avoid some compiler warnings.")
5156 (defvar completion-no-auto-exit nil
5157 "Non-nil means `choose-completion-string' should never exit the minibuffer.
5158 This also applies to other functions such as `choose-completion'
5159 and `mouse-choose-completion'.")
5161 (defvar completion-base-size nil
5162 "Number of chars at beginning of minibuffer not involved in completion.
5163 This is a local variable in the completion list buffer
5164 but it talks about the buffer in `completion-reference-buffer'.
5165 If this is nil, it means to compare text to determine which part
5166 of the tail end of the buffer's text is involved in completion.")
5168 (defun delete-completion-window ()
5169 "Delete the completion list window.
5170 Go to the window from which completion was requested."
5171 (interactive)
5172 (let ((buf completion-reference-buffer))
5173 (if (one-window-p t)
5174 (if (window-dedicated-p (selected-window))
5175 (delete-frame (selected-frame)))
5176 (delete-window (selected-window))
5177 (if (get-buffer-window buf)
5178 (select-window (get-buffer-window buf))))))
5180 (defun previous-completion (n)
5181 "Move to the previous item in the completion list."
5182 (interactive "p")
5183 (next-completion (- n)))
5185 (defun next-completion (n)
5186 "Move to the next item in the completion list.
5187 With prefix argument N, move N items (negative N means move backward)."
5188 (interactive "p")
5189 (let ((beg (point-min)) (end (point-max)))
5190 (while (and (> n 0) (not (eobp)))
5191 ;; If in a completion, move to the end of it.
5192 (when (get-text-property (point) 'mouse-face)
5193 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5194 ;; Move to start of next one.
5195 (unless (get-text-property (point) 'mouse-face)
5196 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
5197 (setq n (1- n)))
5198 (while (and (< n 0) (not (bobp)))
5199 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
5200 ;; If in a completion, move to the start of it.
5201 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
5202 (goto-char (previous-single-property-change
5203 (point) 'mouse-face nil beg)))
5204 ;; Move to end of the previous completion.
5205 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
5206 (goto-char (previous-single-property-change
5207 (point) 'mouse-face nil beg)))
5208 ;; Move to the start of that one.
5209 (goto-char (previous-single-property-change
5210 (point) 'mouse-face nil beg))
5211 (setq n (1+ n))))))
5213 (defun choose-completion ()
5214 "Choose the completion that point is in or next to."
5215 (interactive)
5216 (let (beg end completion (buffer completion-reference-buffer)
5217 (base-size completion-base-size))
5218 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
5219 (setq end (point) beg (1+ (point))))
5220 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
5221 (setq end (1- (point)) beg (point)))
5222 (if (null beg)
5223 (error "No completion here"))
5224 (setq beg (previous-single-property-change beg 'mouse-face))
5225 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
5226 (setq completion (buffer-substring-no-properties beg end))
5227 (let ((owindow (selected-window)))
5228 (if (and (one-window-p t 'selected-frame)
5229 (window-dedicated-p (selected-window)))
5230 ;; This is a special buffer's frame
5231 (iconify-frame (selected-frame))
5232 (or (window-dedicated-p (selected-window))
5233 (bury-buffer)))
5234 (select-window owindow))
5235 (choose-completion-string completion buffer base-size)))
5237 ;; Delete the longest partial match for STRING
5238 ;; that can be found before POINT.
5239 (defun choose-completion-delete-max-match (string)
5240 (let ((opoint (point))
5241 len)
5242 ;; Try moving back by the length of the string.
5243 (goto-char (max (- (point) (length string))
5244 (minibuffer-prompt-end)))
5245 ;; See how far back we were actually able to move. That is the
5246 ;; upper bound on how much we can match and delete.
5247 (setq len (- opoint (point)))
5248 (if completion-ignore-case
5249 (setq string (downcase string)))
5250 (while (and (> len 0)
5251 (let ((tail (buffer-substring (point) opoint)))
5252 (if completion-ignore-case
5253 (setq tail (downcase tail)))
5254 (not (string= tail (substring string 0 len)))))
5255 (setq len (1- len))
5256 (forward-char 1))
5257 (delete-char len)))
5259 (defvar choose-completion-string-functions nil
5260 "Functions that may override the normal insertion of a completion choice.
5261 These functions are called in order with four arguments:
5262 CHOICE - the string to insert in the buffer,
5263 BUFFER - the buffer in which the choice should be inserted,
5264 MINI-P - non-nil if BUFFER is a minibuffer, and
5265 BASE-SIZE - the number of characters in BUFFER before
5266 the string being completed.
5268 If a function in the list returns non-nil, that function is supposed
5269 to have inserted the CHOICE in the BUFFER, and possibly exited
5270 the minibuffer; no further functions will be called.
5272 If all functions in the list return nil, that means to use
5273 the default method of inserting the completion in BUFFER.")
5275 (defun choose-completion-string (choice &optional buffer base-size)
5276 "Switch to BUFFER and insert the completion choice CHOICE.
5277 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
5278 to keep. If it is nil, we call `choose-completion-delete-max-match'
5279 to decide what to delete."
5281 ;; If BUFFER is the minibuffer, exit the minibuffer
5282 ;; unless it is reading a file name and CHOICE is a directory,
5283 ;; or completion-no-auto-exit is non-nil.
5285 (let* ((buffer (or buffer completion-reference-buffer))
5286 (mini-p (minibufferp buffer)))
5287 ;; If BUFFER is a minibuffer, barf unless it's the currently
5288 ;; active minibuffer.
5289 (if (and mini-p
5290 (or (not (active-minibuffer-window))
5291 (not (equal buffer
5292 (window-buffer (active-minibuffer-window))))))
5293 (error "Minibuffer is not active for completion")
5294 ;; Set buffer so buffer-local choose-completion-string-functions works.
5295 (set-buffer buffer)
5296 (unless (run-hook-with-args-until-success
5297 'choose-completion-string-functions
5298 choice buffer mini-p base-size)
5299 ;; Insert the completion into the buffer where it was requested.
5300 (if base-size
5301 (delete-region (+ base-size (if mini-p
5302 (minibuffer-prompt-end)
5303 (point-min)))
5304 (point))
5305 (choose-completion-delete-max-match choice))
5306 (insert choice)
5307 (remove-text-properties (- (point) (length choice)) (point)
5308 '(mouse-face nil))
5309 ;; Update point in the window that BUFFER is showing in.
5310 (let ((window (get-buffer-window buffer t)))
5311 (set-window-point window (point)))
5312 ;; If completing for the minibuffer, exit it with this choice.
5313 (and (not completion-no-auto-exit)
5314 (equal buffer (window-buffer (minibuffer-window)))
5315 minibuffer-completion-table
5316 ;; If this is reading a file name, and the file name chosen
5317 ;; is a directory, don't exit the minibuffer.
5318 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
5319 (file-directory-p (field-string (point-max))))
5320 (let ((mini (active-minibuffer-window)))
5321 (select-window mini)
5322 (when minibuffer-auto-raise
5323 (raise-frame (window-frame mini))))
5324 (exit-minibuffer)))))))
5326 (defun completion-list-mode ()
5327 "Major mode for buffers showing lists of possible completions.
5329 to select the completion near point.
5331 with the mouse.
5335 (interactive)
5336 (kill-all-local-variables)
5337 (use-local-map completion-list-mode-map)
5338 (setq mode-name "Completion List")
5339 (setq major-mode 'completion-list-mode)
5340 (make-local-variable 'completion-base-size)
5341 (setq completion-base-size nil)
5342 (run-mode-hooks 'completion-list-mode-hook))
5344 (defun completion-list-mode-finish ()
5345 "Finish setup of the completions buffer.
5346 Called from `temp-buffer-show-hook'."
5347 (when (eq major-mode 'completion-list-mode)
5348 (toggle-read-only 1)))
5350 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
5352 (defvar completion-setup-hook nil
5353 "Normal hook run at the end of setting up a completion list buffer.
5354 When this hook is run, the current buffer is the one in which the
5355 command to display the completion list buffer was run.
5356 The completion list buffer is available as the value of `standard-output'.
5357 The common prefix substring for completion may be available as the
5358 value of `completion-common-substring'. See also `display-completion-list'.")
5361 ;; Variables and faces used in `completion-setup-function'.
5363 (defcustom completion-show-help t
5364 "Non-nil means show help message in *Completions* buffer."
5365 :type 'boolean
5366 :version "22.1"
5367 :group 'completion)
5369 (defface completions-first-difference
5370 '((t (:inherit bold)))
5371 "Face put on the first uncommon character in completions in *Completions* buffer."
5372 :group 'completion)
5374 (defface completions-common-part
5375 '((t (:inherit default)))
5376 "Face put on the common prefix substring in completions in *Completions* buffer.
5377 The idea of `completions-common-part' is that you can use it to
5378 make the common parts less visible than normal, so that the rest
5379 of the differing parts is, by contrast, slightly highlighted."
5380 :group 'completion)
5382 ;; This is for packages that need to bind it to a non-default regexp
5383 ;; in order to make the first-differing character highlight work
5384 ;; to their liking
5385 (defvar completion-root-regexp "^/"
5386 "Regexp to use in `completion-setup-function' to find the root directory.")
5388 (defvar completion-common-substring nil
5389 "Common prefix substring to use in `completion-setup-function' to put faces.
5390 The value is set by `display-completion-list' during running `completion-setup-hook'.
5392 To put faces `completions-first-difference' and `completions-common-part'
5393 in the `*Completions*' buffer, the common prefix substring in completions
5394 is needed as a hint. (The minibuffer is a special case. The content
5395 of the minibuffer before point is always the common substring.)")
5397 ;; This function goes in completion-setup-hook, so that it is called
5398 ;; after the text of the completion list buffer is written.
5399 (defun completion-setup-function ()
5400 (let* ((mainbuf (current-buffer))
5401 (mbuf-contents (minibuffer-completion-contents))
5402 common-string-length)
5403 ;; When reading a file name in the minibuffer,
5404 ;; set default-directory in the minibuffer
5405 ;; so it will get copied into the completion list buffer.
5406 (if minibuffer-completing-file-name
5407 (with-current-buffer mainbuf
5408 (setq default-directory
5409 (file-name-directory (expand-file-name mbuf-contents)))))
5410 (with-current-buffer standard-output
5411 (completion-list-mode)
5412 (set (make-local-variable 'completion-reference-buffer) mainbuf)
5413 (setq completion-base-size
5414 (cond
5415 ((and (symbolp minibuffer-completion-table)
5416 (get minibuffer-completion-table 'completion-base-size-function))
5417 ;; To compute base size, a function can use the global value of
5418 ;; completion-common-substring or minibuffer-completion-contents.
5419 (with-current-buffer mainbuf
5420 (funcall (get minibuffer-completion-table
5421 'completion-base-size-function))))
5422 (minibuffer-completing-file-name
5423 ;; For file name completion, use the number of chars before
5424 ;; the start of the file name component at point.
5425 (with-current-buffer mainbuf
5426 (save-excursion
5427 (skip-chars-backward completion-root-regexp)
5428 (- (point) (minibuffer-prompt-end)))))
5429 (minibuffer-completing-symbol nil)
5430 ;; Otherwise, in minibuffer, the base size is 0.
5431 ((minibufferp mainbuf) 0)))
5432 (setq common-string-length
5433 (cond
5434 (completion-common-substring
5435 (length completion-common-substring))
5436 (completion-base-size
5437 (- (length mbuf-contents) completion-base-size))))
5438 ;; Put faces on first uncommon characters and common parts.
5439 (when (and (integerp common-string-length) (>= common-string-length 0))
5440 (let ((element-start (point-min))
5441 (maxp (point-max))
5442 element-common-end)
5443 (while (and (setq element-start
5444 (next-single-property-change
5445 element-start 'mouse-face))
5446 (< (setq element-common-end
5447 (+ element-start common-string-length))
5448 maxp))
5449 (when (get-char-property element-start 'mouse-face)
5450 (if (and (> common-string-length 0)
5451 (get-char-property (1- element-common-end) 'mouse-face))
5452 (put-text-property element-start element-common-end
5453 'font-lock-face 'completions-common-part))
5454 (if (get-char-property element-common-end 'mouse-face)
5455 (put-text-property element-common-end (1+ element-common-end)
5456 'font-lock-face 'completions-first-difference))))))
5457 ;; Maybe insert help string.
5458 (when completion-show-help
5459 (goto-char (point-min))
5460 (if (display-mouse-p)
5461 (insert (substitute-command-keys
5463 (insert (substitute-command-keys
5467 (add-hook 'completion-setup-hook 'completion-setup-function)
5469 (define-key minibuffer-local-completion-map [prior] 'switch-to-completions)
5470 (define-key minibuffer-local-completion-map "\M-v" 'switch-to-completions)
5472 (defun switch-to-completions ()
5473 "Select the completion list window."
5474 (interactive)
5475 ;; Make sure we have a completions window.
5476 (or (get-buffer-window "*Completions*")
5477 (minibuffer-completion-help))
5478 (let ((window (get-buffer-window "*Completions*")))
5479 (when window
5480 (select-window window)
5481 (goto-char (point-min))
5483 (forward-line 1))))
5484 \f
5485 ;;; Support keyboard commands to turn on various modifiers.
5487 ;; These functions -- which are not commands -- each add one modifier
5488 ;; to the following event.
5490 (defun event-apply-alt-modifier (ignore-prompt)
5493 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
5494 (defun event-apply-super-modifier (ignore-prompt)
5497 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
5498 (defun event-apply-hyper-modifier (ignore-prompt)
5501 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
5502 (defun event-apply-shift-modifier (ignore-prompt)
5505 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
5506 (defun event-apply-control-modifier (ignore-prompt)
5509 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
5510 (defun event-apply-meta-modifier (ignore-prompt)
5513 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
5515 (defun event-apply-modifier (event symbol lshiftby prefix)
5516 "Apply a modifier flag to event EVENT.
5517 SYMBOL is the name of this modifier, as a symbol.
5518 LSHIFTBY is the numeric value of this modifier, in keyboard events.
5519 PREFIX is the string that represents this modifier in an event type symbol."
5520 (if (numberp event)
5521 (cond ((eq symbol 'control)
5522 (if (and (<= (downcase event) ?z)
5523 (>= (downcase event) ?a))
5524 (- (downcase event) ?a -1)
5525 (if (and (<= (downcase event) ?Z)
5526 (>= (downcase event) ?A))
5527 (- (downcase event) ?A -1)
5528 (logior (lsh 1 lshiftby) event))))
5529 ((eq symbol 'shift)
5530 (if (and (<= (downcase event) ?z)
5531 (>= (downcase event) ?a))
5532 (upcase event)
5533 (logior (lsh 1 lshiftby) event)))
5534 (t
5535 (logior (lsh 1 lshiftby) event)))
5536 (if (memq symbol (event-modifiers event))
5537 event
5538 (let ((event-type (if (symbolp event) event (car event))))
5539 (setq event-type (intern (concat prefix (symbol-name event-type))))
5540 (if (symbolp event)
5541 event-type
5542 (cons event-type (cdr event)))))))
5544 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
5545 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
5546 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
5547 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
5548 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
5549 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
5550 \f
5551 ;;;; Keypad support.
5553 ;; Make the keypad keys act like ordinary typing keys. If people add
5554 ;; bindings for the function key symbols, then those bindings will
5555 ;; override these, so this shouldn't interfere with any existing
5556 ;; bindings.
5558 ;; Also tell read-char how to handle these keys.
5559 (mapc
5560 (lambda (keypad-normal)
5561 (let ((keypad (nth 0 keypad-normal))
5562 (normal (nth 1 keypad-normal)))
5563 (put keypad 'ascii-character normal)
5564 (define-key function-key-map (vector keypad) (vector normal))))
5565 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
5566 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
5567 (kp-space ?\s)
5570 (kp-multiply ?*)
5571 (kp-add ?+)
5572 (kp-separator ?,)
5573 (kp-subtract ?-)
5574 (kp-decimal ?.)
5575 (kp-divide ?/)
5576 (kp-equal ?=)))
5577 \f
5578 ;;;;
5579 ;;;; forking a twin copy of a buffer.
5580 ;;;;
5582 (defvar clone-buffer-hook nil
5583 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
5585 (defvar clone-indirect-buffer-hook nil
5586 "Normal hook to run in the new buffer at the end of `clone-indirect-buffer'.")
5588 (defun clone-process (process &optional newname)
5589 "Create a twin copy of PROCESS.
5590 If NEWNAME is nil, it defaults to PROCESS' name;
5591 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
5592 If PROCESS is associated with a buffer, the new process will be associated
5593 with the current buffer instead.
5594 Returns nil if PROCESS has already terminated."
5595 (setq newname (or newname (process-name process)))
5597 (setq newname (substring newname 0 (match-beginning 0))))
5598 (when (memq (process-status process) '(run stop open))
5599 (let* ((process-connection-type (process-tty-name process))
5600 (new-process
5601 (if (memq (process-status process) '(open))
5602 (let ((args (process-contact process t)))
5603 (setq args (plist-put args :name newname))
5604 (setq args (plist-put args :buffer
5605 (if (process-buffer process)
5606 (current-buffer))))
5607 (apply 'make-network-process args))
5608 (apply 'start-process newname
5609 (if (process-buffer process) (current-buffer))
5610 (process-command process)))))
5611 (set-process-query-on-exit-flag
5612 new-process (process-query-on-exit-flag process))
5613 (set-process-inherit-coding-system-flag
5614 new-process (process-inherit-coding-system-flag process))
5615 (set-process-filter new-process (process-filter process))
5616 (set-process-sentinel new-process (process-sentinel process))
5617 (set-process-plist new-process (copy-sequence (process-plist process)))
5618 new-process)))
5620 ;; things to maybe add (currently partly covered by `funcall mode'):
5621 ;; - syntax-table
5622 ;; - overlays
5623 (defun clone-buffer (&optional newname display-flag)
5624 "Create and return a twin copy of the current buffer.
5625 Unlike an indirect buffer, the new buffer can be edited
5626 independently of the old one (if it is not read-only).
5627 NEWNAME is the name of the new buffer. It may be modified by
5628 adding or incrementing <N> at the end as necessary to create a
5629 unique buffer name. If nil, it defaults to the name of the
5630 current buffer, with the proper suffix. If DISPLAY-FLAG is
5631 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5632 clone a file-visiting buffer, or a buffer whose major mode symbol
5633 has a non-nil `no-clone' property, results in an error.
5635 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5636 current buffer with appropriate suffix. However, if a prefix
5637 argument is given, then the command prompts for NEWNAME in the
5638 minibuffer.
5640 This runs the normal hook `clone-buffer-hook' in the new buffer
5641 after it has been set up properly in other respects."
5642 (interactive
5643 (progn
5644 (if buffer-file-name
5645 (error "Cannot clone a file-visiting buffer"))
5646 (if (get major-mode 'no-clone)
5647 (error "Cannot clone a buffer in %s mode" mode-name))
5648 (list (if current-prefix-arg
5649 (read-buffer "Name of new cloned buffer: " (current-buffer)))
5650 t)))
5651 (if buffer-file-name
5652 (error "Cannot clone a file-visiting buffer"))
5653 (if (get major-mode 'no-clone)
5654 (error "Cannot clone a buffer in %s mode" mode-name))
5655 (setq newname (or newname (buffer-name)))
5657 (setq newname (substring newname 0 (match-beginning 0))))
5658 (let ((buf (current-buffer))
5659 (ptmin (point-min))
5660 (ptmax (point-max))
5661 (pt (point))
5662 (mk (if mark-active (mark t)))
5663 (modified (buffer-modified-p))
5664 (mode major-mode)
5665 (lvars (buffer-local-variables))
5666 (process (get-buffer-process (current-buffer)))
5667 (new (generate-new-buffer (or newname (buffer-name)))))
5668 (save-restriction
5669 (widen)
5670 (with-current-buffer new
5671 (insert-buffer-substring buf)))
5672 (with-current-buffer new
5673 (narrow-to-region ptmin ptmax)
5674 (goto-char pt)
5675 (if mk (set-mark mk))
5676 (set-buffer-modified-p modified)
5678 ;; Clone the old buffer's process, if any.
5679 (when process (clone-process process))
5681 ;; Now set up the major mode.
5682 (funcall mode)
5684 ;; Set up other local variables.
5685 (mapc (lambda (v)
5686 (condition-case () ;in case var is read-only
5687 (if (symbolp v)
5688 (makunbound v)
5689 (set (make-local-variable (car v)) (cdr v)))
5690 (error nil)))
5691 lvars)
5693 ;; Run any hooks (typically set up by the major mode
5694 ;; for cloning to work properly).
5695 (run-hooks 'clone-buffer-hook))
5696 (if display-flag
5697 ;; Presumably the current buffer is shown in the selected frame, so
5698 ;; we want to display the clone elsewhere.
5699 (let ((same-window-regexps nil)
5700 (same-window-buffer-names))
5701 (pop-to-buffer new)))
5702 new))
5705 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5706 "Create an indirect buffer that is a twin copy of the current buffer.
5708 Give the indirect buffer name NEWNAME. Interactively, read NEWNAME
5709 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5710 or if not called with a prefix arg, NEWNAME defaults to the current
5711 buffer's name. The name is modified by adding a `<N>' suffix to it
5712 or by incrementing the N in an existing suffix.
5714 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5715 This is always done when called interactively.
5717 Optional third arg NORECORD non-nil means do not put this buffer at the
5718 front of the list of recently selected ones."
5719 (interactive
5720 (progn
5721 (if (get major-mode 'no-clone-indirect)
5722 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5723 (list (if current-prefix-arg
5724 (read-buffer "Name of indirect buffer: " (current-buffer)))
5725 t)))
5726 (if (get major-mode 'no-clone-indirect)
5727 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5728 (setq newname (or newname (buffer-name)))
5730 (setq newname (substring newname 0 (match-beginning 0))))
5731 (let* ((name (generate-new-buffer-name newname))
5732 (buffer (make-indirect-buffer (current-buffer) name t)))
5733 (with-current-buffer buffer
5734 (run-hooks 'clone-indirect-buffer-hook))
5735 (when display-flag
5736 (pop-to-buffer buffer norecord))
5737 buffer))
5740 (defun clone-indirect-buffer-other-window (newname display-flag &optional norecord)
5741 "Like `clone-indirect-buffer' but display in another window."
5742 (interactive
5743 (progn
5744 (if (get major-mode 'no-clone-indirect)
5745 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5746 (list (if current-prefix-arg
5747 (read-buffer "Name of indirect buffer: " (current-buffer)))
5748 t)))
5749 (let ((pop-up-windows t))
5750 (clone-indirect-buffer newname display-flag norecord)))
5752 \f
5753 ;;; Handling of Backspace and Delete keys.
5755 (defcustom normal-erase-is-backspace 'maybe
5756 "Set the default behavior of the Delete and Backspace keys.
5758 If set to t, Delete key deletes forward and Backspace key deletes
5759 backward.
5761 If set to nil, both Delete and Backspace keys delete backward.
5763 If set to 'maybe (which is the default), Emacs automatically
5764 selects a behavior. On window systems, the behavior depends on
5765 the keyboard used. If the keyboard has both a Backspace key and
5766 a Delete key, and both are mapped to their usual meanings, the
5767 option's default value is set to t, so that Backspace can be used
5768 to delete backward, and Delete can be used to delete forward.
5770 If not running under a window system, customizing this option
5771 accomplishes a similar effect by mapping C-h, which is usually
5772 generated by the Backspace key, to DEL, and by mapping DEL to C-d
5773 via `keyboard-translate'. The former functionality of C-h is
5774 available on the F1 key. You should probably not use this
5775 setting if you don't have both Backspace, Delete and F1 keys.
5777 Setting this variable with setq doesn't take effect. Programmatically,
5778 call `normal-erase-is-backspace-mode' (which see) instead."
5779 :type '(choice (const :tag "Off" nil)
5780 (const :tag "Maybe" maybe)
5781 (other :tag "On" t))
5782 :group 'editing-basics
5783 :version "21.1"
5784 :set (lambda (symbol value)
5785 ;; The fboundp is because of a problem with :set when
5786 ;; dumping Emacs. It doesn't really matter.
5787 (if (fboundp 'normal-erase-is-backspace-mode)
5788 (normal-erase-is-backspace-mode (or value 0))
5789 (set-default symbol value))))
5791 (defun normal-erase-is-backspace-setup-frame (&optional frame)
5792 "Set up `normal-erase-is-backspace-mode' on FRAME, if necessary."
5793 (unless frame (setq frame (selected-frame)))
5794 (with-selected-frame frame
5795 (unless (terminal-parameter nil 'normal-erase-is-backspace)
5796 (normal-erase-is-backspace-mode
5797 (if (if (eq normal-erase-is-backspace 'maybe)
5798 (and (not noninteractive)
5799 (or (memq system-type '(ms-dos windows-nt))
5800 (eq window-system 'mac)
5801 (and (memq window-system '(x))
5802 (fboundp 'x-backspace-delete-keys-p)
5803 (x-backspace-delete-keys-p))
5804 ;; If the terminal Emacs is running on has erase char
5805 ;; set to ^H, use the Backspace key for deleting
5806 ;; backward, and the Delete key for deleting forward.
5807 (and (null window-system)
5808 (eq tty-erase-char ?\^H))))
5809 normal-erase-is-backspace)
5810 1 0)))))
5812 (defun normal-erase-is-backspace-mode (&optional arg)
5813 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5815 With numeric arg, turn the mode on if and only if ARG is positive.
5817 On window systems, when this mode is on, Delete is mapped to C-d
5818 and Backspace is mapped to DEL; when this mode is off, both
5819 Delete and Backspace are mapped to DEL. (The remapping goes via
5820 `local-function-key-map', so binding Delete or Backspace in the
5821 global or local keymap will override that.)
5823 In addition, on window systems, the bindings of C-Delete, M-Delete,
5824 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5825 the global keymap in accordance with the functionality of Delete and
5826 Backspace. For example, if Delete is remapped to C-d, which deletes
5827 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5828 to DEL, which deletes backward, C-Delete is bound to
5829 `backward-kill-word'.
5831 If not running on a window system, a similar effect is accomplished by
5832 remapping C-h (normally produced by the Backspace key) and DEL via
5833 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5834 to C-d; if it's off, the keys are not remapped.
5836 When not running on a window system, and this mode is turned on, the
5837 former functionality of C-h is available on the F1 key. You should
5838 probably not turn on this mode on a text-only terminal if you don't
5839 have both Backspace, Delete and F1 keys.
5841 See also `normal-erase-is-backspace'."
5842 (interactive "P")
5843 (let ((enabled (or (and arg (> (prefix-numeric-value arg) 0))
5844 (and (not arg)
5845 (not (eq 1 (terminal-parameter
5846 nil 'normal-erase-is-backspace)))))))
5847 (set-terminal-parameter nil 'normal-erase-is-backspace
5848 (if enabled 1 0))
5850 (cond ((or (memq window-system '(x w32 mac pc))
5851 (memq system-type '(ms-dos windows-nt)))
5852 (let* ((bindings
5853 `(([C-delete] [C-backspace])
5854 ([M-delete] [M-backspace])
5855 ([C-M-delete] [C-M-backspace])
5856 (,esc-map
5857 [C-delete] [C-backspace])))
5858 (old-state (lookup-key local-function-key-map [delete])))
5860 (if enabled
5861 (progn
5862 (define-key local-function-key-map [delete] [?\C-d])
5863 (define-key local-function-key-map [kp-delete] [?\C-d])
5864 (define-key local-function-key-map [backspace] [?\C-?]))
5865 (define-key local-function-key-map [delete] [?\C-?])
5866 (define-key local-function-key-map [kp-delete] [?\C-?])
5867 (define-key local-function-key-map [backspace] [?\C-?]))
5869 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5870 (unless (equal old-state (lookup-key local-function-key-map [delete]))
5871 (dolist (binding bindings)
5872 (let ((map global-map))
5873 (when (keymapp (car binding))
5874 (setq map (car binding) binding (cdr binding)))
5875 (let* ((key1 (nth 0 binding))
5876 (key2 (nth 1 binding))
5877 (binding1 (lookup-key map key1))
5878 (binding2 (lookup-key map key2)))
5879 (define-key map key1 binding2)
5880 (define-key map key2 binding1)))))))
5881 (t
5882 (if enabled
5883 (progn
5884 (keyboard-translate ?\C-h ?\C-?)
5885 (keyboard-translate ?\C-? ?\C-d))
5886 (keyboard-translate ?\C-h ?\C-h)
5887 (keyboard-translate ?\C-? ?\C-?))))
5889 (run-hooks 'normal-erase-is-backspace-hook)
5890 (if (interactive-p)
5891 (message "Delete key deletes %s"
5892 (if (terminal-parameter nil 'normal-erase-is-backspace)
5893 "forward" "backward")))))
5894 \f
5895 (defvar vis-mode-saved-buffer-invisibility-spec nil
5896 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5898 (define-minor-mode visible-mode
5899 "Toggle Visible mode.
5900 With argument ARG turn Visible mode on if ARG is positive, otherwise
5901 turn it off.
5903 Enabling Visible mode makes all invisible text temporarily visible.
5904 Disabling Visible mode turns off that effect. Visible mode
5905 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5906 :lighter " Vis"
5907 :group 'editing-basics
5908 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5909 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5910 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5911 (when visible-mode
5912 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5913 buffer-invisibility-spec)
5914 (setq buffer-invisibility-spec nil)))
5915 \f
5916 ;; Minibuffer prompt stuff.
5918 ;(defun minibuffer-prompt-modification (start end)
5919 ; (error "You cannot modify the prompt"))
5920 ;
5921 ;
5922 ;(defun minibuffer-prompt-insertion (start end)
5923 ; (let ((inhibit-modification-hooks t))
5924 ; (delete-region start end)
5925 ; ;; Discard undo information for the text insertion itself
5926 ; ;; and for the text deletion.above.
5927 ; (when (consp buffer-undo-list)
5928 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5929 ; (message "You cannot modify the prompt")))
5930 ;
5931 ;
5932 ;(setq minibuffer-prompt-properties
5933 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5934 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5935 ;
5937 \f
5938 ;;;; Problematic external packages.
5940 ;; rms says this should be done by specifying symbols that define
5941 ;; versions together with bad values. This is therefore not as
5942 ;; flexible as it could be. See the thread:
5943 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00300.html
5944 (defconst bad-packages-alist
5945 ;; Not sure exactly which semantic versions have problems.
5946 ;; Definitely 2.0pre3, probably all 2.0pre's before this.
5948 "The version of `semantic' loaded does not work in Emacs 22.
5949 It can cause constant high CPU load.
5950 Upgrade to at least Semantic 2.0pre4 (distributed with CEDET 1.0pre4).")
5951 ;; CUA-mode does not work with GNU Emacs version 22.1 and newer.
5952 ;; Except for version 1.2, all of the 1.x and 2.x version of cua-mode
5953 ;; provided the `CUA-mode' feature. Since this is no longer true,
5954 ;; we can warn the user if the `CUA-mode' feature is ever provided.
5955 (CUA-mode t nil
5956 "CUA-mode is now part of the standard GNU Emacs distribution,
5957 so you can now enable CUA via the Options menu or by customizing `cua-mode'.
5959 You have loaded an older version of CUA-mode which does not work
5960 correctly with this version of Emacs. You should remove the old
5961 version and use the one distributed with Emacs."))
5962 "Alist of packages known to cause problems in this version of Emacs.
5963 Each element has the form (PACKAGE SYMBOL REGEXP STRING).
5964 PACKAGE is either a regular expression to match file names, or a
5965 symbol (a feature name); see the documentation of
5966 `after-load-alist', to which this variable adds functions.
5967 SYMBOL is either the name of a string variable, or `t'. Upon
5968 loading PACKAGE, if SYMBOL is t or matches REGEXP, display a
5969 warning using STRING as the message.")
5971 (defun bad-package-check (package)
5972 "Run a check using the element from `bad-packages-alist' matching PACKAGE."
5973 (condition-case nil
5974 (let* ((list (assoc package bad-packages-alist))
5975 (symbol (nth 1 list)))
5976 (and list
5977 (boundp symbol)
5978 (or (eq symbol t)
5979 (and (stringp (setq symbol (eval symbol)))
5980 (string-match (nth 2 list) symbol)))
5981 (display-warning :warning (nth 3 list))))
5982 (error nil)))
5984 (mapc (lambda (elem)
5985 (eval-after-load (car elem) `(bad-package-check ',(car elem))))
5986 bad-packages-alist)
5989 (provide 'simple)
5991 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5992 ;;; simple.el ends here