| blob | b50707531d103f12376e3400e0507cc7464fdcf2 |
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
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 2, 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., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, 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:
39 "*Idle time delay before updating various things on the screen.
40 Various Emacs features that update auxiliary information when point moves
41 wait this many seconds after Emacs becomes idle before doing an update."
47 "Killing and yanking commands."
51 "Highlight (un)matching of parens and expressions."
55 "Switch to the next buffer in cyclic order."
62 "Switch to the previous buffer in cyclic order."
65 found)
73 \f
74 ;;; next-error support framework
77 "next-error support framework."
83 "Face used to highlight next error locus."
88 "*Highlighting of locations in selected source buffers.
89 If number, highlight the locus in next-error face for given time in seconds.
90 If t, use persistent overlays fontified in next-error face.
91 If nil, don't highlight the locus in the source buffer.
92 If `fringe-arrow', indicate the locus by the fringe arrow."
101 "*Highlighting of locations in non-selected source buffers.
102 If number, highlight the locus in next-error face for given time in seconds.
103 If t, use persistent overlays fontified in next-error face.
104 If nil, don't highlight the locus in the source buffer.
105 If `fringe-arrow', indicate the locus by the fringe arrow."
120 "The most recent next-error buffer.
121 A buffer becomes most recent when its compilation, grep, or
126 "Function to use to find the next error in the current buffer.
127 The function is called with 2 parameters:
128 ARG is an integer specifying by how many errors to move.
129 RESET is a boolean which, if non-nil, says to go back to the beginning
130 of the errors before moving.
131 Major modes providing compile-like functionality should set this variable
132 to indicate to `next-error' that this is a candidate buffer and how
138 &optional avoid-current
139 extra-test-inclusive
140 extra-test-exclusive)
141 "Test if BUFFER is a next-error capable buffer.
143 If AVOID-CURRENT is non-nil, treat the current buffer
144 as an absolute last resort only.
146 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
147 that normally would not qualify. If it returns t, the buffer
148 in question is treated as usable.
150 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
151 that would normally be considered usable. if it returns nil,
152 that buffer is rejected."
157 ;; Optionally reject some buffers.
160 t)
161 ;; Optionally accept some other buffers.
166 extra-test-inclusive
167 extra-test-exclusive)
168 "Return a next-error capable buffer.
169 If AVOID-CURRENT is non-nil, treat the current buffer
170 as an absolute last resort only.
172 The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffers
173 that normally would not qualify. If it returns t, the buffer
174 in question is treated as usable.
176 The function EXTRA-TEST-EXCLUSIVE, if non-nil is called in each buffer
177 that would normally be considered usable. If it returns nil,
178 that buffer is rejected."
180 ;; 1. If one window on the selected frame displays such buffer, return it.
186 avoid-current
187 extra-test-inclusive extra-test-exclusive)
192 ;; 2. If next-error-last-buffer is an acceptable buffer, use that.
195 extra-test-inclusive extra-test-exclusive))
196 next-error-last-buffer)
197 ;; 3. If the current buffer is acceptable, choose it.
199 extra-test-inclusive extra-test-exclusive)
201 ;; 4. Look for any acceptable buffer.
206 extra-test-inclusive extra-test-exclusive)))
209 ;; 5. Use the current buffer as a last resort if it qualifies,
210 ;; even despite AVOID-CURRENT.
213 extra-test-inclusive extra-test-exclusive)
217 ;; 6. Give up.
221 "Visit next next-error message and corresponding source code.
223 If all the error messages parsed so far have been processed already,
224 the message buffer is checked for new ones.
226 A prefix ARG specifies how many error messages to move;
227 negative means move back to previous error messages.
229 and start at the first error.
231 The RESET argument specifies that we should restart from the beginning.
234 compilation, grep, or occur buffer. It can also operate on any
236 more generally, on any buffer in Compilation mode or with
237 Compilation Minor mode enabled, or any buffer in which
238 `next-error-function' is bound to an appropriate function.
239 To specify use of a particular buffer for error messages, type
241 in the current frame.
244 it stays with that buffer until you use it in some other buffer which
245 uses Compilation mode or Compilation Minor mode.
247 See variables `compilation-parse-errors-function' and
248 \`compilation-error-regexp-alist' for customization ideas."
252 ;; we know here that next-error-function is a valid symbol we can funcall
260 "Visit previous next-error message and corresponding source code.
262 Prefix arg N says how many error messages to move backwards (or
263 forwards, if negative).
270 "Restart at the first error.
271 Visit corresponding source code.
272 With prefix arg N, visit the source code of the Nth error.
278 "Move point to the next error in the next-error buffer and highlight match.
279 Prefix arg N says how many error messages to move forwards (or
280 backwards, if negative).
282 select the source buffer."
289 "Move point to the previous error in the next-error buffer and highlight match.
290 Prefix arg N says how many error messages to move backwards (or
291 forwards, if negative).
293 select the source buffer."
297 ;;; Internal variable for `next-error-follow-mode-post-command-hook'.
301 "Minor mode for compilation, occur and diff modes.
302 When turned on, cursor motion in the compilation, grep, occur or diff
303 buffer causes automatic display of the corresponding source code
304 location."
311 ;;; Used as a `post-command-hook' by `next-error-follow-mode'
312 ;;; for the *Compilation* *grep* and *Occur* buffers.
322 \f
323 ;;;
326 "Major mode not specialized for anything in particular.
327 Other major modes are defined by comparison with this one."
332 ;; Making and deleting lines.
335 "Insert a newline, and move to left margin of the new line if it's blank.
336 If `use-hard-newlines' is non-nil, the newline is marked with the
337 text-property `hard'.
338 With ARG, insert that many newlines.
339 Call `auto-fill-function' if the current column number is greater
340 than the value of `fill-column' and ARG is nil."
343 ;; Inserting a newline at the end of a line produces better redisplay in
344 ;; try_window_id than inserting at the beginning of a line, and the textual
345 ;; result is the same. So, if we're at beginning of line, pretend to be at
346 ;; the end of the previous line.
349 ;; Make sure no functions want to be told about
350 ;; the range of the changes.
353 ;; Make sure there are no markers here.
356 ;; Make sure no text properties want to know
357 ;; where the change was.
362 ;; Make sure the newline before point isn't intangible.
364 ;; Make sure the newline before point isn't read-only.
366 ;; Make sure the newline before point isn't invisible.
368 ;; Make sure the newline before point has the same
369 ;; properties as the char before it (if any).
376 ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
377 ;; Set last-command-char to tell self-insert what to insert.
379 ;; Don't auto-fill if we have a numeric argument.
380 ;; Also not if flag is true (it would fill wrong line);
381 ;; there is no need to since we're at BOL.
385 ;; If we get an error in self-insert-command, put point at right place.
387 ;; Even if we did *not* get an error, keep that forward-char;
388 ;; all further processing should apply to the newline that the user
389 ;; thinks he inserted.
391 ;; Mark the newline(s) `hard'.
395 ;; If the newline leaves the previous line blank,
396 ;; and we have a left margin, delete that from the blank line.
404 ;; Indent the line after the newline, except in one case:
405 ;; when we added the newline at the beginning of a line
406 ;; which starts a page.
409 nil)
414 ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
420 "Insert a newline and leave point before it.
421 If there is a fill prefix and/or a left-margin, insert them on the new line
422 if the line would have been blank.
423 With arg N, insert N newlines."
428 ;; Don't expand an abbrev before point.
442 "Split current line, moving portion beyond point vertically down.
443 If the current line starts with `fill-prefix', insert it on the new
444 line as well. With prefix ARG, don't insert fill-prefix on new line.
446 When called from Lisp code, ARG may be a prefix string to copy."
451 ;; What prefix should we check for (nil means don't).
455 ;; Does this line start with it?
466 "Join this line to previous and fix up whitespace at join.
467 If there is a fill prefix, delete it from the beginning of this line.
468 With argument, join this line to following line."
475 ;; If the second line started with the fill prefix,
476 ;; delete the prefix.
488 "On blank line, delete all surrounding blank lines, leaving just one.
489 On isolated blank line, delete that one.
490 On nonblank line, delete any immediately following blank lines."
496 ;; Set singleblank if there is just one blank line here.
503 ;; Delete preceding blank lines, and this one too if it's the only one.
512 ;; Delete following blank lines, unless the current line is blank
513 ;; and there are no following blank lines.
522 ;; Handle the special case where point is followed by newline and eob.
523 ;; Delete the line, leaving point at eob.
528 "Delete all the trailing whitespace across the current buffer.
529 All whitespace after the last non-whitespace character in a line is deleted.
531 A formfeed is not considered whitespace by this function."
538 ;; Don't delete formfeeds, even if they are considered whitespace.
545 "Insert a newline, then indent according to major mode.
546 Indentation is done using the value of `indent-line-function'.
547 In programming language modes, this is the same as TAB.
548 In some text modes, where TAB inserts a tab, this command indents to the
549 column specified by the function `current-left-margin'."
556 "Reindent current line, insert newline, then indent the new line.
557 Indentation of both lines is done according to the current major mode,
558 which means calling the current value of `indent-line-function'.
559 In programming language modes, this is the same as TAB.
560 In some text modes, where TAB inserts a tab, this indents to the
561 column specified by the function `current-left-margin'."
564 ;; Be careful to insert the newline before indenting the line.
565 ;; Otherwise, the indentation might be wrong.
574 "Read next input character and insert it.
575 This is useful for inserting control characters.
577 If the first character you type after this command is an octal digit,
578 you should type a sequence of octal digits which specify a character code.
579 Any nondigit terminates the sequence. If the terminator is a RET,
580 it is discarded; any other terminator is used itself as input.
581 The variable `read-quoted-char-radix' specifies the radix for this feature;
582 set it to 10 or 16 to use decimal or hex instead of octal.
584 In overwrite mode, this function inserts the character anyway, and
585 does not handle octal digits specially. This means that if you use
586 overwrite as your normal editing mode, you can use this function to
587 insert characters when necessary.
589 In binary overwrite mode, this function does overwrite, and octal
590 digits are interpreted as a character code. This is intended to be
591 useful for editing binary files."
598 ;; Assume character codes 0240 - 0377 stand for characters in some
599 ;; single-byte character set, and convert them to Emacs
600 ;; characters.
613 "Move forward ARG lines and position at first nonblank character."
619 "Move backward ARG lines and position at first nonblank character."
625 "Move point to the first non-whitespace character on this line."
629 ;; Move back over chars that have whitespace syntax but have the p flag.
633 "Fixup white space between objects around point.
634 Leave one space or none, according to the context."
641 nil
645 "Delete all spaces and tabs around point.
646 If BACKWARD-ONLY is non-nil, only delete spaces before point."
651 orig-pos
660 "Delete all spaces and tabs around point, leaving one space (or N spaces)."
674 \f
676 "Move point to the beginning of the buffer; leave mark at previous position.
678 With numeric arg N, put point N/10 of the way from the beginning.
680 If the buffer is narrowed, this command uses the beginning and size
681 of the accessible part of the buffer.
683 Don't use this command in Lisp programs!
684 \(goto-char (point-min)) is faster and avoids clobbering the mark."
693 ;; Avoid overflow for large buffer sizes!
701 "Move point to the end of the buffer; leave mark at previous position.
703 With numeric arg N, put point N/10 of the way from the end.
705 If the buffer is narrowed, this command uses the beginning and size
706 of the accessible part of the buffer.
708 Don't use this command in Lisp programs!
709 \(goto-char (point-max)) is faster and avoids clobbering the mark."
718 ;; Avoid overflow for large buffer sizes!
723 ;; If we went to a place in the middle of the buffer,
724 ;; adjust it to the beginning of a line.
727 ;; If the end of the buffer is not already on the screen,
728 ;; then scroll specially to put it near, but not at, the bottom.
733 "Put point at beginning and mark at end of buffer.
734 You probably should not use this function in Lisp programs;
735 it is usually a mistake for a Lisp function to use any subroutine
736 that uses or sets the mark."
741 \f
743 ;; Counting lines, one way or another.
746 "Goto line ARG, counting from line 1 at beginning of buffer.
747 Normally, move point in the current buffer.
749 displayed other buffer, and switch to it. When called from Lisp code,
750 the optional argument BUFFER specifies a buffer to switch to.
752 If there's a number in the buffer at point, it is the default for ARG."
756 ;; Look for a default, a number in the buffer at point.
765 ;; Decide if we're switching buffers.
773 ;; Read the argument, offering that number (if any) as default.
776 buffer-prompt
777 default)
778 nil nil t
779 'minibuffer-history
780 default)
781 buffer))))
782 ;; Switch to the desired buffer, one way or another.
787 ;; Move to the specified line number in that buffer.
796 "Print number of lines and characters in the region."
802 "Print the current buffer line number and narrowed line number of point."
815 "Return number of lines between START and END.
816 This is usually the number of newlines between them,
817 but can be one more if START is not equal to END
818 and the greater of them is not at the start of a line."
834 done)))
838 "Return (narrowed) buffer line number at position POS.
839 If POS is nil, use current buffer location."
849 "Print info on cursor position (on screen and within buffer).
850 Also describe the character after point, and give its character code
851 in octal, decimal and hex.
853 For a non-ASCII multibyte character, also give its encoding in the
854 buffer's selected coding system if the coding system encodes the
855 character safely. If the character is encoded into one byte, that
856 code is shown in hex. If the character is encoded into more than one
859 In addition, with prefix argument, show details about that character
860 in *Help* buffer. See also the command `describe-char'."
868 ;; Avoid overflow from multiplying by 100!
872 ""
878 pos total percent beg end col hscroll)
880 pos total percent col hscroll))
882 encoded encoding-msg)
893 char char char
895 "..."
899 ;; We show the detailed information about CHAR.
906 encoding-msg pos total percent beg end col hscroll)
911 encoding-msg pos total percent col hscroll))))))
912 \f
917 m)
923 "*Value to use for `print-level' when printing value in `eval-expression'.
924 A value of nil means no limit."
930 "*Value to use for `print-length' when printing value in `eval-expression'.
931 A value of nil means no limit."
937 "*Non-nil means set `debug-on-error' when evaluating in `eval-expression'.
938 If nil, don't change the value of `debug-on-error'."
944 "Format VALUE as a result of evaluated expression.
945 Return a formatted string which is displayed in the echo area
946 in addition to the value printed by prin1 in functions which
947 display the result of expression evaluation."
960 ;; We define this, rather than making `eval' interactive,
961 ;; for the sake of completion of names like eval-region, eval-current-buffer.
964 "Evaluate EVAL-EXPRESSION-ARG and print value in the echo area.
965 Value is also consed on to front of the variable `values'.
966 Optional argument EVAL-EXPRESSION-INSERT-VALUE, if non-nil, means
967 insert the result into the current buffer instead of printing it in
968 the echo area."
971 nil read-expression-map t
973 current-prefix-arg))
978 ;; Bind debug-on-error to something unique so that we can
979 ;; detect when evaled code changes it.
983 ;; If evaled code has changed the value of debug-on-error,
984 ;; propagate that change to the global binding.
1000 "Prompting with PROMPT, let user edit COMMAND and eval result.
1001 COMMAND is a Lisp expression. Let user edit that expression in
1002 the minibuffer, then read and evaluate the result."
1009 read-expression-map t
1011 ;; If command was added to command-history as a string,
1012 ;; get rid of that. We want only evaluable expressions there.
1016 ;; If command to be redone does not match front of history,
1017 ;; add it to the history.
1023 "Edit and re-evaluate last complex command, or ARGth from last.
1024 A complex command is one which used the minibuffer.
1025 The command is placed in the minibuffer as a Lisp form for editing.
1026 The result is executed, repeating the command as changed.
1027 If the command has been changed or is not the most recent previous command
1028 it is added to the front of the command history.
1029 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
1030 to get different commands to edit and resubmit."
1033 newcmd)
1045 ;; If command was added to command-history as a
1046 ;; string, get rid of that. We want only
1047 ;; evaluable expressions there.
1051 ;; If command to be redone does not match front of history,
1052 ;; add it to the history.
1059 \f
1061 "Default minibuffer history list.
1062 This is used for all minibuffer input
1065 "Control whether history list elements are expressions or strings.
1066 If the value of this variable equals current minibuffer depth,
1067 they are expressions; otherwise they are strings.
1068 \(That convention is designed to do the right thing fora
1075 "Text that was in this minibuffer before any history commands.
1076 This is nil if there have not yet been any history commands
1085 "A point-motion hook for the minibuffer, that moves point out of the prompt."
1089 "*Minibuffer history variables for which matching should ignore case.
1090 If a history variable is a member of this list, then the
1092 commands ignore case when searching it, regardless of `case-fold-search'."
1097 "Find the previous history element that matches REGEXP.
1098 \(Previous history elements refer to earlier actions.)
1099 With prefix argument N, search for Nth previous match.
1100 If N is negative, find the next or Nth next match.
1101 Normally, history elements are matched case-insensitively if
1102 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1103 makes the search case-sensitive.
1104 See also `minibuffer-history-case-insensitive-variables'."
1108 nil
1109 minibuffer-local-map
1110 nil
1111 'minibuffer-history-search-history
1113 ;; Use the last regexp specified, by default, if input is empty.
1118 regexp)
1128 ;; On some systems, ignore case for file names.
1130 minibuffer-history-case-insensitive-variables)
1131 t
1132 ;; Respect the user's setting for case-fold-search:
1133 case-fold-search)
1134 nil))
1135 prevpos
1136 match-string
1137 match-offset
1144 "No later matching history item"
1165 next-matching-history-element))
1169 "Find the next history element that matches REGEXP.
1170 \(The next history element refers to a more recent action.)
1171 With prefix argument N, search for Nth next match.
1172 If N is negative, find the previous or Nth previous match.
1173 Normally, history elements are matched case-insensitively if
1174 `case-fold-search' is non-nil, but an uppercase letter in REGEXP
1175 makes the search case-sensitive."
1179 nil
1180 minibuffer-local-map
1181 nil
1182 'minibuffer-history-search-history
1184 ;; Use the last regexp specified, by default, if input is empty.
1189 regexp)
1196 "Insert the next element of the minibuffer history into the minibuffer."
1201 elt minibuffer-returned-to-present)
1213 previous-history-element))
1235 elt))
1239 "Inserts the previous element of the minibuffer history into the minibuffer."
1244 "Get next history element which completes the minibuffer before the point.
1245 The contents of the minibuffer after the point are deleted, and replaced
1246 by the new completion."
1252 n)
1253 ;; next-matching-history-element always puts us at (point-min).
1254 ;; Move to the position we were at before changing the buffer contents.
1255 ;; This is still sensical, because the text before point has not changed.
1259 "\
1260 Get previous history element which completes the minibuffer before the point.
1261 The contents of the minibuffer after the point are deleted, and replaced
1262 by the new completion."
1266 ;; For compatibility with the old subr of the same name.
1268 "Return the display width of the minibuffer prompt.
1269 Return 0 if current buffer is not a mini-buffer."
1270 ;; Return the width of everything before the field at the end of
1271 ;; the buffer; this should be 0 for normal buffers.
1273 \f
1274 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
1278 "Table mapping redo records to the corresponding undo one.
1279 A redo record for undo-in-region maps to t.
1289 "Within a run of consecutive undo commands, list remaining to be undone.
1293 "Undo some previous changes.
1294 Repeat this command to undo more changes.
1295 A numeric argument serves as a repeat count.
1297 In Transient Mark mode when the mark is active, only undo changes within
1299 as an argument limits undo to changes within the current region."
1301 ;; Make last-command indicate for the next command that this was an undo.
1302 ;; That way, another undo will undo more.
1303 ;; If we get to the end of the undo history and get an error,
1304 ;; another undo command will find the undo history empty
1305 ;; and will get another error. To begin undoing the undos,
1306 ;; you must type some other command.
1309 ;; If we get an error in undo-start,
1310 ;; the next command should not be a "consecutive undo".
1311 ;; So set `this-command' to something other than `undo'.
1316 ;; If something (a timer or filter?) changed the buffer
1317 ;; since the previous command, don't continue the undo seq.
1321 ;; If the last undo record made was made by undo
1322 ;; it shows nothing else happened in between.
1329 ;; get rid of initial undo boundary
1331 ;; If we got this far, the next command should be a consecutive undo.
1333 ;; Check to see whether we're hitting a redo record, and if
1334 ;; so, ask the user whether she wants to skip the redo/undo pair.
1341 ;; The equiv entry might point to another redo record if we have done
1342 ;; undo-redo-undo-redo-... so skip to the very last equiv.
1350 ;; Record the fact that the just-generated undo records come from an
1351 ;; undo operation--that is, they are redo records.
1352 ;; In the ordinary case (not within a region), map the redo
1353 ;; record to the following undos.
1354 ;; I don't know how to do that in the undo-in-region case.
1357 undo-equiv-table)
1358 ;; Don't specify a position in the undo record for the undo command.
1359 ;; Instead, undoing this should move point to where the change is.
1378 ;; Record what the current undo list says,
1379 ;; so the next command can tell if the buffer was modified in between.
1384 "Make BUFFER stop keeping undo information.
1385 No argument or nil as argument means do this for the current buffer."
1391 "Undo some previous changes.
1392 Repeat this command to undo more changes.
1393 A numeric argument serves as a repeat count.
1394 Contrary to `undo', this will not redo a previous undo."
1399 "Non-nil while performing an undo.
1403 "Undo back N undo-boundaries beyond what was already undone recently.
1404 Call `undo-start' to get ready to undo recent changes,
1405 then call `undo-more' one or more times to undo them."
1415 ;; Deep copy of a list
1417 "Make a copy of undo list LIST."
1423 elt))
1426 "Set `pending-undo-list' to the front of the undo list.
1427 The next call to `undo-more' will undo the most recently made change.
1428 If BEG and END are specified, then only undo elements
1429 that apply to text between BEG and END are used; other undo elements
1430 are ignored. If BEG and END are nil, all undo elements are used."
1436 buffer-undo-list)))
1441 "Return a list of undo elements for the region START to END.
1442 The elements come from `buffer-undo-list', but we keep only
1443 the elements inside this region, and discard those outside this region.
1444 If we find an element that crosses an edge of this region,
1445 we stop and ignore all further elements."
1448 undo-adjusted-markers
1449 some-rejected
1450 undo-elt undo-elt temp-undo-list delta)
1455 ;; This is a "was unmodified" element.
1456 ;; Keep it if we have kept everything thus far.
1463 ;; Don't put two nils together in the list
1477 ;; Loop down the earlier events adjusting their buffer
1478 ;; positions to reflect the fact that a change to the buffer
1479 ;; isn't being undone. We only need to process those element
1480 ;; types which undo-elt-in-region will return as being in
1481 ;; the region since only those types can ever get into the
1482 ;; output
1491 ;; (TEXT . POSITION)
1498 ;; (BEGIN . END)
1503 ;; (nil PROPERTY VALUE BEG . END)
1513 "Determine whether UNDO-ELT falls inside the region START ... END.
1514 If it crosses the edge, we return nil."
1519 t)
1521 nil)
1523 ;; (TEXT . POSITION)
1527 ;; This is a marker-adjustment element (MARKER . ADJUSTMENT).
1528 ;; See if MARKER is inside the region.
1539 ;; (nil PROPERTY VALUE BEG . END)
1544 ;; (BEGIN . END)
1549 "Test whether UNDO-ELT crosses one edge of that region START ... END.
1550 This assumes we have already decided that UNDO-ELT
1551 is not *inside* the region START...END."
1554 ;; (nil PROPERTY VALUE BEG . END)
1559 ;; (BEGIN . END)
1563 ;; Return the first affected buffer position and the delta for an undo element
1564 ;; delta is defined as the change in subsequent buffer positions if we *did*
1565 ;; the undo.
1569 ;; (TEXT . POSITION)
1572 ;; (BEGIN . END)
1579 "If non-nil ask about discarding undo info for the current command.
1580 Normally, Emacs discards the undo info for the current command if
1581 it exceeds `undo-outer-limit'. But if you set this option
1582 non-nil, it asks in the echo area whether to discard the info.
1583 If you answer no, there a slight risk that Emacs might crash, so
1584 only do it if you really want to undo the command.
1586 This option is mainly intended for debugging. You have to be
1587 careful if you use it for other purposes. Garbage collection is
1588 inhibited while the question is asked, meaning that Emacs might
1589 leak memory. So you should make sure that you do not wait
1590 excessively long before answering the question."
1596 "If non-nil, an extra level of size that's ok in an undo item.
1597 We don't ask the user about truncating the undo list until the
1598 current item gets bigger than this amount.
1603 ;; When the first undo batch in an undo list is longer than
1604 ;; undo-outer-limit, this function gets called to warn the user that
1605 ;; the undo info for the current command was discarded. Garbage
1606 ;; collection is inhibited around the call, so it had better not do a
1607 ;; lot of consing.
1613 ;; Don't ask the question again unless it gets even bigger.
1614 ;; This applies, in particular, if the user quits from the question.
1615 ;; Such a quit quits out of GC, but something else will call GC
1616 ;; again momentarily. It will call this function again,
1617 ;; but we don't want to ask the question again.
1624 t)
1625 nil))
1630 "The undo info was discarded because it exceeded \
1631 `undo-outer-limit'.
1633 This is normal if you executed a command that made a huge change
1634 to the buffer. In that case, to prevent similar problems in the
1635 future, set `undo-outer-limit' to a value that is large enough to
1636 cover the maximum size of normal changes you expect a single
1637 command to make, but not so large that it might exceed the
1638 maximum memory allotted to Emacs.
1640 If you did not execute any such command, the situation is
1641 probably due to a bug and you should report it.
1643 You can disable the popping up of this buffer by adding the entry
1647 t))
1648 \f
1656 "*Buffer name for `shell-command' and `shell-command-on-region' error output.
1657 This buffer is used when `shell-command' or `shell-command-on-region'
1658 is run interactively. A value of nil means that output to stderr and
1662 "Execute string COMMAND in inferior shell; display output, if any.
1663 With prefix argument, insert the COMMAND's output at point.
1665 If COMMAND ends in ampersand, execute it asynchronously.
1666 The output appears in the buffer `*Async Shell Command*'.
1667 That buffer is in shell mode.
1669 Otherwise, COMMAND is executed synchronously. The output appears in
1670 the buffer `*Shell Command Output*'. If the output is short enough to
1671 display in the echo area (which is determined by the variables
1672 `resize-mini-windows' and `max-mini-window-height'), it is shown
1673 there, but it is nonetheless available in buffer `*Shell Command
1674 Output*' even though that buffer is not automatically displayed.
1676 To specify a coding system for converting non-ASCII characters
1678 before this command.
1680 Noninteractive callers can specify coding systems by binding
1681 `coding-system-for-read' and `coding-system-for-write'.
1683 The optional second argument OUTPUT-BUFFER, if non-nil,
1684 says to put the output in some other buffer.
1685 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1686 If OUTPUT-BUFFER is not a buffer and not nil,
1687 insert output in current buffer. (This cannot be done asynchronously.)
1688 In either case, the output is inserted after point (leaving mark after it).
1690 If the command terminates without error, but generates output,
1692 the output can be displayed in the echo area or in its buffer.
1693 If the output is short enough to display in the echo area
1694 \(determined by the variable `max-mini-window-height' if
1695 `resize-mini-windows' is non-nil), it is shown there. Otherwise,
1696 the buffer containing the output is displayed.
1700 of the output.
1702 If there is no output, or if output is inserted in the current buffer,
1703 then `*Shell Command Output*' is deleted.
1705 If the optional third argument ERROR-BUFFER is non-nil, it is a buffer
1706 or buffer name to which to direct the command's standard error output.
1707 If it is nil, error output is mingled with regular output.
1708 In an interactive call, the variable `shell-command-default-error-buffer'
1709 specifies the value of ERROR-BUFFER."
1713 current-prefix-arg
1714 shell-command-default-error-buffer))
1715 ;; Look for a handler in case default-directory is a remote file name.
1723 ;; Output goes in current buffer.
1729 temporary-file-directory)))
1730 nil)))
1733 ;; We do not use -f for csh; we will not support broken use of
1734 ;; .cshrcs. Even the BSD csh manual says to use
1735 ;; "if ($?prompt) exit" before things which are not useful
1736 ;; non-interactively. Besides, if someone wants their other
1737 ;; aliases for shell commands then they can still have them.
1741 t)
1742 nil shell-command-switch command)
1749 ;; Do no formatting while reading error file,
1750 ;; because that can run a shell command, and we
1751 ;; don't want that to cause an infinite recursion.
1753 ;; Put point after the inserted errors.
1757 ;; This is like exchange-point-and-mark, but doesn't
1758 ;; activate the mark. It is cleaner to avoid activation,
1759 ;; even though the command loop would deactivate the mark
1760 ;; because we inserted text.
1764 ;; Output goes in a separate buffer.
1765 ;; Preserve the match data in case called from a program.
1768 ;; Command ending with ampersand means asynchronous.
1772 proc)
1773 ;; Remove the ampersand.
1775 ;; If will kill a process, query first.
1787 shell-command-switch command))
1791 ))
1793 output-buffer nil error-buffer)))))))
1797 "Display MESSAGE in the echo area if possible, otherwise in a pop-up buffer.
1798 MESSAGE may be either a string or a buffer.
1800 A buffer is displayed using `display-buffer' if MESSAGE is too long for
1801 the maximum height of the echo area, as defined by `max-mini-window-height'
1802 if `resize-mini-windows' is non-nil.
1804 Returns either the string shown in the echo area, or when a pop-up
1805 buffer is used, the window used to display it.
1807 If MESSAGE is a string, then the optional argument BUFFER-NAME is the
1808 name of the buffer used to display it in the case where a pop-up buffer
1809 is used, defaulting to `*Message*'. In the case where MESSAGE is a
1810 string and it is displayed in the echo area, it is not specified whether
1811 the contents are inserted into the buffer anyway.
1813 Optional arguments NOT-THIS-WINDOW and FRAME are as for `display-buffer',
1814 and only used if a buffer is displayed."
1816 ;; Trivial case where we can use the echo area
1820 ;; Trivial case where we can just remove single trailing newline
1823 ;; General case
1826 message
1835 0
1839 (<= lines
1843 max-mini-window-height))
1845 max-mini-window-height)
1849 ;; Don't use the echo area if the output buffer is
1850 ;; already dispayed in the selected frame.
1852 ;; Echo area
1858 ;; Buffer
1861 not-this-window frame))))))))
1864 ;; We have a sentinel to prevent insertion of a termination message
1865 ;; in the buffer itself.
1873 &optional output-buffer replace
1874 error-buffer display-error-buffer)
1875 "Execute string COMMAND in inferior shell with region as input.
1876 Normally display output (if any) in temp buffer `*Shell Command Output*';
1877 Prefix arg means replace the region with it. Return the exit code of
1878 COMMAND.
1880 To specify a coding system for converting non-ASCII characters
1882 before this command. By default, the input (from the current buffer)
1883 is encoded in the same coding system that will be used to save the file,
1884 `buffer-file-coding-system'. If the output is going to replace the region,
1885 then it is decoded from that same coding system.
1887 The noninteractive arguments are START, END, COMMAND,
1888 OUTPUT-BUFFER, REPLACE, ERROR-BUFFER, and DISPLAY-ERROR-BUFFER.
1889 Noninteractive callers can specify coding systems by binding
1890 `coding-system-for-read' and `coding-system-for-write'.
1892 If the command generates output, the output may be displayed
1893 in the echo area or in a buffer.
1894 If the output is short enough to display in the echo area
1895 \(determined by the variable `max-mini-window-height' if
1896 `resize-mini-windows' is non-nil), it is shown there. Otherwise
1897 it is displayed in the buffer `*Shell Command Output*'. The output
1898 is available in that buffer in both cases.
1900 If there is output and an error, a message about the error
1901 appears at the end of the output.
1903 If there is no output, or if output is inserted in the current buffer,
1904 then `*Shell Command Output*' is deleted.
1906 If the optional fourth argument OUTPUT-BUFFER is non-nil,
1907 that says to put the output in some other buffer.
1908 If OUTPUT-BUFFER is a buffer or buffer name, put the output there.
1909 If OUTPUT-BUFFER is not a buffer and not nil,
1910 insert output in the current buffer.
1911 In either case, the output is inserted after point (leaving mark after it).
1913 If REPLACE, the optional fifth argument, is non-nil, that means insert
1914 the output in place of text from START to END, putting point and mark
1915 around it.
1917 If optional sixth argument ERROR-BUFFER is non-nil, it is a buffer
1918 or buffer name to which to direct the command's standard error output.
1919 If it is nil, error output is mingled with regular output.
1920 If DISPLAY-ERROR-BUFFER is non-nil, display the error buffer if there
1921 were any errors. (This is always t, interactively.)
1922 In an interactive call, the variable `shell-command-default-error-buffer'
1923 specifies the value of ERROR-BUFFER."
1927 ;; Do this before calling region-beginning
1928 ;; and region-end, in case subprocess output
1929 ;; relocates them while we are in the minibuffer.
1931 nil nil nil
1933 ;; call-interactively recognizes region-beginning and
1934 ;; region-end specially, leaving them in the history.
1936 string
1937 current-prefix-arg
1938 current-prefix-arg
1939 shell-command-default-error-buffer
1940 t)))
1946 temporary-file-directory)))
1947 nil))
1948 exit-status)
1952 ;; Replace specified region with output from command.
1954 ;; Don't muck with mark unless REPLACE says we should.
1961 t)
1962 nil shell-command-switch command))
1963 ;; It is rude to delete a buffer which the command is not using.
1964 ;; (let ((shell-buffer (get-buffer "*Shell Command Output*")))
1965 ;; (and shell-buffer (not (eq shell-buffer (current-buffer)))
1966 ;; (kill-buffer shell-buffer)))
1967 ;; Don't muck with mark unless REPLACE says we should.
1969 ;; No prefix argument: put the output in a temp buffer,
1970 ;; replacing its entire contents.
1975 ;; If the input is the same buffer as the output,
1976 ;; delete everything but the specified region,
1977 ;; then replace that region with the output.
1983 shell-file-name t
1986 t)
1987 nil shell-command-switch
1988 command)))
1989 ;; Clear the output buffer, then run the command with
1990 ;; output there.
2002 buffer)
2003 nil shell-command-switch command)))
2004 ;; Report the output.
2014 ;; There's some output, display it
2016 ;; No output; error?
2020 "some error output"
2026 output))
2029 exit-status))
2032 exit-status output))))
2033 ;; Don't kill: there might be useful info in the undo-log.
2034 ;; (kill-buffer buffer)
2035 ))))
2043 ;; Do no formatting while reading error file,
2044 ;; because that can run a shell command, and we
2045 ;; don't want that to cause an infinite recursion.
2047 ;; Put point after the inserted errors.
2052 exit-status))
2055 "Execute shell command COMMAND and return its output as a string."
2058 standard-output
2062 "Process files synchronously in a separate process.
2063 Similar to `call-process', but may invoke a file handler based on
2064 `default-directory'. The current working directory of the
2065 subprocess is `default-directory'.
2067 File names in INFILE and BUFFER are handled normally, but file
2068 names in ARGS should be relative to `default-directory', as they
2069 are passed to the process verbatim. \(This is a difference to
2070 `call-process' which does not support file handlers for INFILE
2071 and BUFFER.\)
2073 Some file handlers might not support all variants, for example
2074 they might behave as if DISPLAY was nil, regardless of the actual
2075 value passed."
2077 lc stderr-file)
2087 display args)
2093 \f
2097 (define-key map (vector meta-prefix-char t) 'universal-argument-other-key)
2098 (define-key map [switch-frame] nil)
2099 (define-key map [?\C-u] 'universal-argument-more)
2100 (define-key map [?-] 'universal-argument-minus)
2101 (define-key map [?0] 'digit-argument)
2102 (define-key map [?1] 'digit-argument)
2103 (define-key map [?2] 'digit-argument)
2104 (define-key map [?3] 'digit-argument)
2105 (define-key map [?4] 'digit-argument)
2106 (define-key map [?5] 'digit-argument)
2107 (define-key map [?6] 'digit-argument)
2108 (define-key map [?7] 'digit-argument)
2109 (define-key map [?8] 'digit-argument)
2110 (define-key map [?9] 'digit-argument)
2111 (define-key map [kp-0] 'digit-argument)
2112 (define-key map [kp-1] 'digit-argument)
2113 (define-key map [kp-2] 'digit-argument)
2114 (define-key map [kp-3] 'digit-argument)
2115 (define-key map [kp-4] 'digit-argument)
2116 (define-key map [kp-5] 'digit-argument)
2117 (define-key map [kp-6] 'digit-argument)
2118 (define-key map [kp-7] 'digit-argument)
2119 (define-key map [kp-8] 'digit-argument)
2120 (define-key map [kp-9] 'digit-argument)
2121 (define-key map [kp-subtract] 'universal-argument-minus)
2122 map)
2125 (defvar universal-argument-num-events nil
2126 "Number of argument-specifying events read by `universal-argument'.
2127 `universal-argument-other-key' uses this to discard those events
2128 from (this-command-keys), and reread only the final command.")
2130 (defvar overriding-map-is-bound nil
2131 "Non-nil when `overriding-terminal-local-map' is `universal-argument-map'.")
2133 (defvar saved-overriding-map nil
2134 "The saved value of `overriding-terminal-local-map'.
2138 (defun ensure-overriding-map-is-bound ()
2139 "Check `overriding-terminal-local-map' is `universal-argument-map'."
2140 (unless overriding-map-is-bound
2141 (setq saved-overriding-map overriding-terminal-local-map)
2142 (setq overriding-terminal-local-map universal-argument-map)
2143 (setq overriding-map-is-bound t)))
2145 (defun restore-overriding-map ()
2146 "Restore `overriding-terminal-local-map' to its saved value."
2147 (setq overriding-terminal-local-map saved-overriding-map)
2148 (setq overriding-map-is-bound nil))
2150 (defun universal-argument ()
2151 "Begin a numeric argument for the following command.
2156 multiplies the argument by 4 each time.
2158 which is different in effect from any particular numeric argument.
2160 (interactive)
2161 (setq prefix-arg (list 4))
2162 (setq universal-argument-num-events (length (this-command-keys)))
2163 (ensure-overriding-map-is-bound))
2165 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
2166 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
2167 (defun universal-argument-more (arg)
2168 (interactive "P")
2169 (if (consp arg)
2170 (setq prefix-arg (list (* 4 (car arg))))
2171 (if (eq arg '-)
2172 (setq prefix-arg (list -4))
2173 (setq prefix-arg arg)
2174 (restore-overriding-map)))
2175 (setq universal-argument-num-events (length (this-command-keys))))
2177 (defun negative-argument (arg)
2178 "Begin a negative numeric argument for the next command.
2180 (interactive "P")
2181 (cond ((integerp arg)
2182 (setq prefix-arg (- arg)))
2183 ((eq arg '-)
2184 (setq prefix-arg nil))
2185 (t
2186 (setq prefix-arg '-)))
2187 (setq universal-argument-num-events (length (this-command-keys)))
2188 (ensure-overriding-map-is-bound))
2190 (defun digit-argument (arg)
2191 "Part of the numeric argument for the next command.
2193 (interactive "P")
2194 (let* ((char (if (integerp last-command-char)
2195 last-command-char
2196 (get last-command-char 'ascii-character)))
2198 (cond ((integerp arg)
2199 (setq prefix-arg (+ (* arg 10)
2200 (if (< arg 0) (- digit) digit))))
2201 ((eq arg '-)
2202 ;; Treat -0 as just -, so that -01 will work.
2203 (setq prefix-arg (if (zerop digit) '- (- digit))))
2204 (t
2205 (setq prefix-arg digit))))
2206 (setq universal-argument-num-events (length (this-command-keys)))
2207 (ensure-overriding-map-is-bound))
2209 ;; For backward compatibility, minus with no modifiers is an ordinary
2210 ;; command if digits have already been entered.
2211 (defun universal-argument-minus (arg)
2212 (interactive "P")
2213 (if (integerp arg)
2214 (universal-argument-other-key arg)
2215 (negative-argument arg)))
2217 ;; Anything else terminates the argument and is left in the queue to be
2218 ;; executed as a command.
2219 (defun universal-argument-other-key (arg)
2220 (interactive "P")
2221 (setq prefix-arg arg)
2222 (let* ((key (this-command-keys))
2223 (keylist (listify-key-sequence key)))
2224 (setq unread-command-events
2225 (append (nthcdr universal-argument-num-events keylist)
2226 unread-command-events)))
2227 (reset-this-command-lengths)
2228 (restore-overriding-map))
2229 \f
2230 (defvar buffer-substring-filters nil
2231 "List of filter functions for `filter-buffer-substring'.
2232 Each function must accept a single argument, a string, and return
2233 a string. The buffer substring is passed to the first function
2234 in the list, and the return value of each function is passed to
2235 the next. The return value of the last function is used as the
2236 return value of `filter-buffer-substring'.
2238 If this variable is nil, no filtering is performed.")
2240 (defun filter-buffer-substring (beg end &optional delete)
2241 "Return the buffer substring between BEG and END, after filtering.
2242 The buffer substring is passed through each of the filter
2243 functions in `buffer-substring-filters', and the value from the
2244 last filter function is returned. If `buffer-substring-filters'
2245 is nil, the buffer substring is returned unaltered.
2247 If DELETE is non-nil, the text between BEG and END is deleted
2248 from the buffer.
2250 Point is temporarily set to BEG before calling
2251 `buffer-substring-filters', in case the functions need to know
2252 where the text came from.
2254 This function should be used instead of `buffer-substring' or
2255 `delete-and-extract-region' when you want to allow filtering to
2256 take place. For example, major or minor modes can use
2257 `buffer-substring-filters' to extract characters that are special
2258 to a buffer, and should not be copied into other buffers."
2259 (save-excursion
2260 (goto-char beg)
2261 (let ((string (if delete (delete-and-extract-region beg end)
2262 (buffer-substring beg end))))
2263 (dolist (filter buffer-substring-filters string)
2264 (setq string (funcall filter string))))))
2266 ;;;; Window system cut and paste hooks.
2268 (defvar interprogram-cut-function nil
2269 "Function to call to make a killed region available to other programs.
2271 Most window systems provide some sort of facility for cutting and
2272 pasting text between the windows of different programs.
2273 This variable holds a function that Emacs calls whenever text
2274 is put in the kill ring, to make the new kill available to other
2275 programs.
2277 The function takes one or two arguments.
2278 The first argument, TEXT, is a string containing
2279 the text which should be made available.
2280 The second, optional, argument PUSH, has the same meaning as the
2281 similar argument to `x-set-cut-buffer', which see.")
2283 (defvar interprogram-paste-function nil
2284 "Function to call to get text cut from other programs.
2286 Most window systems provide some sort of facility for cutting and
2287 pasting text between the windows of different programs.
2288 This variable holds a function that Emacs calls to obtain
2289 text that other programs have provided for pasting.
2291 The function should be called with no arguments. If the function
2292 returns nil, then no other program has provided such text, and the top
2293 of the Emacs kill ring should be used. If the function returns a
2294 string, then the caller of the function \(usually `current-kill')
2295 should put this string in the kill ring as the latest kill.
2297 Note that the function should return a string only if a program other
2298 than Emacs has provided a string for pasting; if Emacs provided the
2299 most recent string, the function should return nil. If it is
2300 difficult to tell whether Emacs or some other program provided the
2301 current string, it is probably good enough to return nil if the string
2302 is equal (according to `string=') to the last text Emacs provided.")
2303 \f
2306 ;;;; The kill ring data structure.
2308 (defvar kill-ring nil
2309 "List of killed text sequences.
2310 Since the kill ring is supposed to interact nicely with cut-and-paste
2311 facilities offered by window systems, use of this variable should
2312 interact nicely with `interprogram-cut-function' and
2313 `interprogram-paste-function'. The functions `kill-new',
2314 `kill-append', and `current-kill' are supposed to implement this
2315 interaction; you may want to use them instead of manipulating the kill
2316 ring directly.")
2318 (defcustom kill-ring-max 60
2319 "*Maximum length of kill ring before oldest elements are thrown away."
2320 :type 'integer
2321 :group 'killing)
2323 (defvar kill-ring-yank-pointer nil
2324 "The tail of the kill ring whose car is the last thing yanked.")
2326 (defun kill-new (string &optional replace yank-handler)
2327 "Make STRING the latest kill in the kill ring.
2328 Set `kill-ring-yank-pointer' to point to it.
2329 If `interprogram-cut-function' is non-nil, apply it to STRING.
2330 Optional second argument REPLACE non-nil means that STRING will replace
2331 the front of the kill ring, rather than being added to the list.
2333 Optional third arguments YANK-HANDLER controls how the STRING is later
2334 inserted into a buffer; see `insert-for-yank' for details.
2335 When a yank handler is specified, STRING must be non-empty (the yank
2336 handler, if non-nil, is stored as a `yank-handler' text property on STRING).
2338 When the yank handler has a non-nil PARAM element, the original STRING
2339 argument is not used by `insert-for-yank'. However, since Lisp code
2340 may access and use elements from the kill-ring directly, the STRING
2342 (if (> (length string) 0)
2343 (if yank-handler
2344 (put-text-property 0 (length string)
2345 'yank-handler yank-handler string))
2346 (if yank-handler
2347 (signal 'args-out-of-range
2348 (list string "yank-handler specified for empty string"))))
2349 (if (fboundp 'menu-bar-update-yank-menu)
2350 (menu-bar-update-yank-menu string (and replace (car kill-ring))))
2351 (if (and replace kill-ring)
2352 (setcar kill-ring string)
2353 (setq kill-ring (cons string kill-ring))
2354 (if (> (length kill-ring) kill-ring-max)
2355 (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
2356 (setq kill-ring-yank-pointer kill-ring)
2357 (if interprogram-cut-function
2358 (funcall interprogram-cut-function string (not replace))))
2360 (defun kill-append (string before-p &optional yank-handler)
2361 "Append STRING to the end of the latest kill in the kill ring.
2362 If BEFORE-P is non-nil, prepend STRING to the kill.
2363 Optional third argument YANK-HANDLER, if non-nil, specifies the
2364 yank-handler text property to be set on the combined kill ring
2365 string. If the specified yank-handler arg differs from the
2366 yank-handler property of the latest kill string, this function
2367 adds the combined string to the kill ring as a new element,
2368 instead of replacing the last kill with it.
2369 If `interprogram-cut-function' is set, pass the resulting kill to it."
2370 (let* ((cur (car kill-ring)))
2371 (kill-new (if before-p (concat string cur) (concat cur string))
2372 (or (= (length cur) 0)
2373 (equal yank-handler (get-text-property 0 'yank-handler cur)))
2374 yank-handler)))
2376 (defun current-kill (n &optional do-not-move)
2377 "Rotate the yanking point by N places, and then return that kill.
2378 If N is zero, `interprogram-paste-function' is set, and calling it
2379 returns a string, then that string is added to the front of the
2380 kill ring and returned as the latest kill.
2381 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
2382 yanking point; just return the Nth kill forward."
2383 (let ((interprogram-paste (and (= n 0)
2384 interprogram-paste-function
2385 (funcall interprogram-paste-function))))
2386 (if interprogram-paste
2387 (progn
2388 ;; Disable the interprogram cut function when we add the new
2389 ;; text to the kill ring, so Emacs doesn't try to own the
2390 ;; selection, with identical text.
2391 (let ((interprogram-cut-function nil))
2392 (kill-new interprogram-paste))
2393 interprogram-paste)
2394 (or kill-ring (error "Kill ring is empty"))
2395 (let ((ARGth-kill-element
2396 (nthcdr (mod (- n (length kill-ring-yank-pointer))
2397 (length kill-ring))
2398 kill-ring)))
2399 (or do-not-move
2400 (setq kill-ring-yank-pointer ARGth-kill-element))
2401 (car ARGth-kill-element)))))
2405 ;;;; Commands for manipulating the kill ring.
2407 (defcustom kill-read-only-ok nil
2408 "*Non-nil means don't signal an error for killing read-only text."
2409 :type 'boolean
2410 :group 'killing)
2412 (put 'text-read-only 'error-conditions
2413 '(text-read-only buffer-read-only error))
2414 (put 'text-read-only 'error-message "Text is read-only")
2416 (defun kill-region (beg end &optional yank-handler)
2417 "Kill between point and mark.
2418 The text is deleted but saved in the kill ring.
2422 If you want to append the killed region to the last killed text,
2425 If the buffer is read-only, Emacs will beep and refrain from deleting
2426 the text, but put the text in the kill ring anyway. This means that
2427 you can use the killing commands to copy text from a read-only buffer.
2429 This is the primitive for programs to kill text (as opposed to deleting it).
2430 Supply two arguments, character positions indicating the stretch of text
2431 to be killed.
2433 If the previous command was also a kill command,
2434 the text killed this time appends to the text killed last time
2435 to make one entry in the kill ring.
2437 In Lisp code, optional third arg YANK-HANDLER, if non-nil,
2438 specifies the yank-handler text property to be set on the killed
2439 text. See `insert-for-yank'."
2440 (interactive "r")
2441 (condition-case nil
2442 (let ((string (filter-buffer-substring beg end t)))
2443 (when string ;STRING is nil if BEG = END
2444 ;; Add that string to the kill ring, one way or another.
2445 (if (eq last-command 'kill-region)
2446 (kill-append string (< end beg) yank-handler)
2447 (kill-new string nil yank-handler)))
2448 (when (or string (eq last-command 'kill-region))
2449 (setq this-command 'kill-region))
2450 nil)
2451 ((buffer-read-only text-read-only)
2452 ;; The code above failed because the buffer, or some of the characters
2453 ;; in the region, are read-only.
2454 ;; We should beep, in case the user just isn't aware of this.
2455 ;; However, there's no harm in putting
2456 ;; the region's text in the kill ring, anyway.
2457 (copy-region-as-kill beg end)
2458 ;; Set this-command now, so it will be set even if we get an error.
2459 (setq this-command 'kill-region)
2460 ;; This should barf, if appropriate, and give us the correct error.
2461 (if kill-read-only-ok
2462 (progn (message "Read only text copied to kill ring") nil)
2463 ;; Signal an error if the buffer is read-only.
2464 (barf-if-buffer-read-only)
2465 ;; If the buffer isn't read-only, the text is.
2466 (signal 'text-read-only (list (current-buffer)))))))
2468 ;; copy-region-as-kill no longer sets this-command, because it's confusing
2469 ;; to get two copies of the text when the user accidentally types M-w and
2470 ;; then corrects it with the intended C-w.
2471 (defun copy-region-as-kill (beg end)
2472 "Save the region as if killed, but don't kill it.
2473 In Transient Mark mode, deactivate the mark.
2474 If `interprogram-cut-function' is non-nil, also save the text for a window
2475 system cut and paste."
2476 (interactive "r")
2477 (if (eq last-command 'kill-region)
2478 (kill-append (filter-buffer-substring beg end) (< end beg))
2479 (kill-new (filter-buffer-substring beg end)))
2480 (if transient-mark-mode
2481 (setq deactivate-mark t))
2482 nil)
2484 (defun kill-ring-save (beg end)
2485 "Save the region as if killed, but don't kill it.
2486 In Transient Mark mode, deactivate the mark.
2487 If `interprogram-cut-function' is non-nil, also save the text for a window
2488 system cut and paste.
2490 If you want to append the killed line to the last killed text,
2493 This command is similar to `copy-region-as-kill', except that it gives
2494 visual feedback indicating the extent of the region being copied."
2495 (interactive "r")
2496 (copy-region-as-kill beg end)
2497 ;; This use of interactive-p is correct
2498 ;; because the code it controls just gives the user visual feedback.
2499 (if (interactive-p)
2500 (let ((other-end (if (= (point) beg) end beg))
2501 (opoint (point))
2502 ;; Inhibit quitting so we can make a quit here
2503 ;; look like a C-g typed as a command.
2504 (inhibit-quit t))
2505 (if (pos-visible-in-window-p other-end (selected-window))
2506 (unless (and transient-mark-mode
2507 (face-background 'region))
2508 ;; Swap point and mark.
2509 (set-marker (mark-marker) (point) (current-buffer))
2510 (goto-char other-end)
2511 (sit-for blink-matching-delay)
2512 ;; Swap back.
2513 (set-marker (mark-marker) other-end (current-buffer))
2514 (goto-char opoint)
2515 ;; If user quit, deactivate the mark
2516 ;; as C-g would as a command.
2517 (and quit-flag mark-active
2518 (deactivate-mark)))
2519 (let* ((killed-text (current-kill 0))
2520 (message-len (min (length killed-text) 40)))
2521 (if (= (point) beg)
2522 ;; Don't say "killed"; that is misleading.
2524 (substring killed-text (- message-len)))
2526 (substring killed-text 0 message-len))))))))
2528 (defun append-next-kill (&optional interactive)
2529 "Cause following command, if it kills, to append to previous kill.
2530 The argument is used for internal purposes; do not supply one."
2531 (interactive "p")
2532 ;; We don't use (interactive-p), since that breaks kbd macros.
2533 (if interactive
2534 (progn
2535 (setq this-command 'kill-region)
2536 (message "If the next command is a kill, it will append"))
2537 (setq last-command 'kill-region)))
2538 \f
2539 ;; Yanking.
2541 ;; This is actually used in subr.el but defcustom does not work there.
2542 (defcustom yank-excluded-properties
2543 '(read-only invisible intangible field mouse-face help-echo local-map keymap
2544 yank-handler follow-link)
2545 "*Text properties to discard when yanking.
2546 The value should be a list of text properties to discard or t,
2547 which means to discard all text properties."
2548 :type '(choice (const :tag "All" t) (repeat symbol))
2549 :group 'killing
2550 :version "22.1")
2552 (defvar yank-window-start nil)
2553 (defvar yank-undo-function nil
2554 "If non-nil, function used by `yank-pop' to delete last stretch of yanked text.
2555 Function is called with two parameters, START and END corresponding to
2556 the value of the mark and point; it is guaranteed that START <= END.
2557 Normally set from the UNDO element of a yank-handler; see `insert-for-yank'.")
2559 (defun yank-pop (&optional arg)
2560 "Replace just-yanked stretch of killed text with a different stretch.
2561 This command is allowed only immediately after a `yank' or a `yank-pop'.
2562 At such a time, the region contains a stretch of reinserted
2563 previously-killed text. `yank-pop' deletes that text and inserts in its
2564 place a different stretch of killed text.
2566 With no argument, the previous kill is inserted.
2567 With argument N, insert the Nth previous kill.
2568 If N is negative, this is a more recent kill.
2570 The sequence of kills wraps around, so that after the oldest one
2571 comes the newest one.
2573 When this command inserts killed text into the buffer, it honors
2574 `yank-excluded-properties' and `yank-handler' as described in the
2575 doc string for `insert-for-yank-1', which see."
2576 (interactive "*p")
2577 (if (not (eq last-command 'yank))
2578 (error "Previous command was not a yank"))
2579 (setq this-command 'yank)
2580 (unless arg (setq arg 1))
2581 (let ((inhibit-read-only t)
2582 (before (< (point) (mark t))))
2583 (if before
2584 (funcall (or yank-undo-function 'delete-region) (point) (mark t))
2585 (funcall (or yank-undo-function 'delete-region) (mark t) (point)))
2586 (setq yank-undo-function nil)
2587 (set-marker (mark-marker) (point) (current-buffer))
2588 (insert-for-yank (current-kill arg))
2589 ;; Set the window start back where it was in the yank command,
2590 ;; if possible.
2591 (set-window-start (selected-window) yank-window-start t)
2592 (if before
2593 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2594 ;; It is cleaner to avoid activation, even though the command
2595 ;; loop would deactivate the mark because we inserted text.
2596 (goto-char (prog1 (mark t)
2597 (set-marker (mark-marker) (point) (current-buffer))))))
2598 nil)
2600 (defun yank (&optional arg)
2601 "Reinsert the last stretch of killed text.
2602 More precisely, reinsert the stretch of killed text most recently
2603 killed OR yanked. Put point at end, and set mark at beginning.
2604 With just \\[universal-argument] as argument, same but put point at beginning (and mark at end).
2605 With argument N, reinsert the Nth most recently killed stretch of killed
2606 text.
2608 When this command inserts killed text into the buffer, it honors
2609 `yank-excluded-properties' and `yank-handler' as described in the
2610 doc string for `insert-for-yank-1', which see.
2613 (interactive "*P")
2614 (setq yank-window-start (window-start))
2615 ;; If we don't get all the way thru, make last-command indicate that
2616 ;; for the following command.
2617 (setq this-command t)
2618 (push-mark (point))
2619 (insert-for-yank (current-kill (cond
2620 ((listp arg) 0)
2621 ((eq arg '-) -2)
2622 (t (1- arg)))))
2623 (if (consp arg)
2624 ;; This is like exchange-point-and-mark, but doesn't activate the mark.
2625 ;; It is cleaner to avoid activation, even though the command
2626 ;; loop would deactivate the mark because we inserted text.
2627 (goto-char (prog1 (mark t)
2628 (set-marker (mark-marker) (point) (current-buffer)))))
2629 ;; If we do get all the way thru, make this-command indicate that.
2630 (if (eq this-command t)
2631 (setq this-command 'yank))
2632 nil)
2634 (defun rotate-yank-pointer (arg)
2635 "Rotate the yanking point in the kill ring.
2636 With argument, rotate that many kills forward (or backward, if negative)."
2637 (interactive "p")
2638 (current-kill arg))
2639 \f
2640 ;; Some kill commands.
2642 ;; Internal subroutine of delete-char
2643 (defun kill-forward-chars (arg)
2644 (if (listp arg) (setq arg (car arg)))
2645 (if (eq arg '-) (setq arg -1))
2646 (kill-region (point) (forward-point arg)))
2648 ;; Internal subroutine of backward-delete-char
2649 (defun kill-backward-chars (arg)
2650 (if (listp arg) (setq arg (car arg)))
2651 (if (eq arg '-) (setq arg -1))
2652 (kill-region (point) (forward-point (- arg))))
2654 (defcustom backward-delete-char-untabify-method 'untabify
2655 "*The method for untabifying when deleting backward.
2656 Can be `untabify' -- turn a tab to many spaces, then delete one space;
2657 `hungry' -- delete all whitespace, both tabs and spaces;
2658 `all' -- delete all whitespace, including tabs, spaces and newlines;
2659 nil -- just delete one character."
2660 :type '(choice (const untabify) (const hungry) (const all) (const nil))
2661 :version "20.3"
2662 :group 'killing)
2664 (defun backward-delete-char-untabify (arg &optional killp)
2665 "Delete characters backward, changing tabs into spaces.
2666 The exact behavior depends on `backward-delete-char-untabify-method'.
2667 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
2668 Interactively, ARG is the prefix arg (default 1)
2669 and KILLP is t if a prefix arg was specified."
2671 (when (eq backward-delete-char-untabify-method 'untabify)
2672 (let ((count arg))
2673 (save-excursion
2674 (while (and (> count 0) (not (bobp)))
2676 (let ((col (current-column)))
2677 (forward-char -1)
2678 (setq col (- col (current-column)))
2679 (insert-char ?\ col)
2680 (delete-char 1)))
2681 (forward-char -1)
2682 (setq count (1- count))))))
2683 (delete-backward-char
2685 ((eq backward-delete-char-untabify-method 'all)
2687 (if skip
2688 (let ((wh (- (point) (save-excursion (skip-chars-backward skip)
2689 (point)))))
2690 (+ arg (if (zerop wh) 0 (1- wh))))
2691 arg))
2692 killp))
2694 (defun zap-to-char (arg char)
2695 "Kill up to and including ARG'th occurrence of CHAR.
2696 Case is ignored if `case-fold-search' is non-nil in the current buffer.
2697 Goes backward if ARG is negative; error if CHAR not found."
2699 (kill-region (point) (progn
2700 (search-forward (char-to-string char) nil nil arg)
2701 ; (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
2702 (point))))
2704 ;; kill-line and its subroutines.
2706 (defcustom kill-whole-line nil
2707 "*If non-nil, `kill-line' with no arg at beg of line kills the whole line."
2708 :type 'boolean
2709 :group 'killing)
2711 (defun kill-line (&optional arg)
2712 "Kill the rest of the current line; if no nonblanks there, kill thru newline.
2713 With prefix argument, kill that many lines from point.
2714 Negative arguments kill lines backward.
2715 With zero argument, kills the text before point on the current line.
2718 a number counts as a prefix arg.
2720 To kill a whole line, when point is not at the beginning, type \
2723 If `kill-whole-line' is non-nil, then this command kills the whole line
2724 including its terminating newline, when used at the beginning of a line
2725 with no argument. As a consequence, you can always kill a whole line
2728 If you want to append the killed line to the last killed text,
2731 If the buffer is read-only, Emacs will beep and refrain from deleting
2732 the line, but put the line in the kill ring anyway. This means that
2733 you can use this command to copy text from a read-only buffer.
2734 \(If the variable `kill-read-only-ok' is non-nil, then this won't
2735 even beep.)"
2736 (interactive "P")
2737 (kill-region (point)
2738 ;; It is better to move point to the other end of the kill
2739 ;; before killing. That way, in a read-only buffer, point
2740 ;; moves across the text that is copied to the kill ring.
2741 ;; The choice has no effect on undo now that undo records
2742 ;; the value of point from before the command was run.
2743 (progn
2744 (if arg
2745 (forward-visible-line (prefix-numeric-value arg))
2746 (if (eobp)
2747 (signal 'end-of-buffer nil))
2748 (let ((end
2749 (save-excursion
2750 (end-of-visible-line) (point))))
2751 (if (or (save-excursion
2752 ;; If trailing whitespace is visible,
2753 ;; don't treat it as nothing.
2754 (unless show-trailing-whitespace
2756 (= (point) end))
2757 (and kill-whole-line (bolp)))
2758 (forward-visible-line 1)
2759 (goto-char end))))
2760 (point))))
2762 (defun kill-whole-line (&optional arg)
2763 "Kill current line.
2764 With prefix arg, kill that many lines starting from the current line.
2765 If arg is negative, kill backward. Also kill the preceding newline.
2766 \(This is meant to make C-x z work well with negative arguments.\)
2767 If arg is zero, kill current line but exclude the trailing newline."
2768 (interactive "p")
2769 (if (and (> arg 0) (eobp) (save-excursion (forward-visible-line 0) (eobp)))
2770 (signal 'end-of-buffer nil))
2771 (if (and (< arg 0) (bobp) (save-excursion (end-of-visible-line) (bobp)))
2772 (signal 'beginning-of-buffer nil))
2773 (unless (eq last-command 'kill-region)
2774 (kill-new "")
2775 (setq last-command 'kill-region))
2776 (cond ((zerop arg)
2777 ;; We need to kill in two steps, because the previous command
2778 ;; could have been a kill command, in which case the text
2779 ;; before point needs to be prepended to the current kill
2780 ;; ring entry and the text after point appended. Also, we
2781 ;; need to use save-excursion to avoid copying the same text
2782 ;; twice to the kill ring in read-only buffers.
2783 (save-excursion
2784 (kill-region (point) (progn (forward-visible-line 0) (point))))
2785 (kill-region (point) (progn (end-of-visible-line) (point))))
2786 ((< arg 0)
2787 (save-excursion
2788 (kill-region (point) (progn (end-of-visible-line) (point))))
2789 (kill-region (point)
2790 (progn (forward-visible-line (1+ arg))
2791 (unless (bobp) (backward-char))
2792 (point))))
2793 (t
2794 (save-excursion
2795 (kill-region (point) (progn (forward-visible-line 0) (point))))
2796 (kill-region (point)
2797 (progn (forward-visible-line arg) (point))))))
2799 (defun forward-visible-line (arg)
2800 "Move forward by ARG lines, ignoring currently invisible newlines only.
2801 If ARG is negative, move backward -ARG lines.
2802 If ARG is zero, move to the beginning of the current line."
2803 (condition-case nil
2804 (if (> arg 0)
2805 (progn
2806 (while (> arg 0)
2807 (or (zerop (forward-line 1))
2808 (signal 'end-of-buffer nil))
2809 ;; If the newline we just skipped is invisible,
2810 ;; don't count it.
2811 (let ((prop
2812 (get-char-property (1- (point)) 'invisible)))
2813 (if (if (eq buffer-invisibility-spec t)
2814 prop
2815 (or (memq prop buffer-invisibility-spec)
2816 (assq prop buffer-invisibility-spec)))
2817 (setq arg (1+ arg))))
2818 (setq arg (1- arg)))
2819 ;; If invisible text follows, and it is a number of complete lines,
2820 ;; skip it.
2821 (let ((opoint (point)))
2822 (while (and (not (eobp))
2823 (let ((prop
2824 (get-char-property (point) 'invisible)))
2825 (if (eq buffer-invisibility-spec t)
2826 prop
2827 (or (memq prop buffer-invisibility-spec)
2828 (assq prop buffer-invisibility-spec)))))
2829 (goto-char
2830 (if (get-text-property (point) 'invisible)
2831 (or (next-single-property-change (point) 'invisible)
2832 (point-max))
2833 (next-overlay-change (point)))))
2834 (unless (bolp)
2835 (goto-char opoint))))
2836 (let ((first t))
2837 (while (or first (<= arg 0))
2838 (if first
2839 (beginning-of-line)
2840 (or (zerop (forward-line -1))
2841 (signal 'beginning-of-buffer nil)))
2842 ;; If the newline we just moved to is invisible,
2843 ;; don't count it.
2844 (unless (bobp)
2845 (let ((prop
2846 (get-char-property (1- (point)) 'invisible)))
2847 (unless (if (eq buffer-invisibility-spec t)
2848 prop
2849 (or (memq prop buffer-invisibility-spec)
2850 (assq prop buffer-invisibility-spec)))
2851 (setq arg (1+ arg)))))
2852 (setq first nil))
2853 ;; If invisible text follows, and it is a number of complete lines,
2854 ;; skip it.
2855 (let ((opoint (point)))
2856 (while (and (not (bobp))
2857 (let ((prop
2858 (get-char-property (1- (point)) 'invisible)))
2859 (if (eq buffer-invisibility-spec t)
2860 prop
2861 (or (memq prop buffer-invisibility-spec)
2862 (assq prop buffer-invisibility-spec)))))
2863 (goto-char
2864 (if (get-text-property (1- (point)) 'invisible)
2865 (or (previous-single-property-change (point) 'invisible)
2866 (point-min))
2867 (previous-overlay-change (point)))))
2868 (unless (bolp)
2869 (goto-char opoint)))))
2870 ((beginning-of-buffer end-of-buffer)
2871 nil)))
2873 (defun end-of-visible-line ()
2874 "Move to end of current visible line."
2875 (end-of-line)
2876 ;; If the following character is currently invisible,
2877 ;; skip all characters with that same `invisible' property value,
2878 ;; then find the next newline.
2879 (while (and (not (eobp))
2880 (save-excursion
2882 (let ((prop
2883 (get-char-property (point) 'invisible)))
2884 (if (eq buffer-invisibility-spec t)
2885 prop
2886 (or (memq prop buffer-invisibility-spec)
2887 (assq prop buffer-invisibility-spec))))))
2889 (if (get-text-property (point) 'invisible)
2890 (goto-char (next-single-property-change (point) 'invisible))
2891 (goto-char (next-overlay-change (point))))
2892 (end-of-line)))
2893 \f
2894 (defun insert-buffer (buffer)
2895 "Insert after point the contents of BUFFER.
2896 Puts mark after the inserted text.
2897 BUFFER may be a buffer or a buffer name.
2899 This function is meant for the user to run interactively.
2900 Don't call it from programs: use `insert-buffer-substring' instead!"
2901 (interactive
2902 (list
2903 (progn
2904 (barf-if-buffer-read-only)
2905 (read-buffer "Insert buffer: "
2906 (if (eq (selected-window) (next-window (selected-window)))
2907 (other-buffer (current-buffer))
2908 (window-buffer (next-window (selected-window))))
2909 t))))
2910 (push-mark
2911 (save-excursion
2912 (insert-buffer-substring (get-buffer buffer))
2913 (point)))
2914 nil)
2916 (defun append-to-buffer (buffer start end)
2917 "Append to specified buffer the text of the region.
2918 It is inserted into that buffer before its point.
2920 When calling from a program, give three arguments:
2921 BUFFER (or buffer name), START and END.
2922 START and END specify the portion of the current buffer to be copied."
2923 (interactive
2924 (list (read-buffer "Append to buffer: " (other-buffer (current-buffer) t))
2925 (region-beginning) (region-end)))
2926 (let ((oldbuf (current-buffer)))
2927 (save-excursion
2928 (let* ((append-to (get-buffer-create buffer))
2929 (windows (get-buffer-window-list append-to t t))
2930 point)
2931 (set-buffer append-to)
2932 (setq point (point))
2933 (barf-if-buffer-read-only)
2934 (insert-buffer-substring oldbuf start end)
2935 (dolist (window windows)
2936 (when (= (window-point window) point)
2937 (set-window-point window (point))))))))
2939 (defun prepend-to-buffer (buffer start end)
2940 "Prepend to specified buffer the text of the region.
2941 It is inserted into that buffer after its point.
2943 When calling from a program, give three arguments:
2944 BUFFER (or buffer name), START and END.
2945 START and END specify the portion of the current buffer to be copied."
2947 (let ((oldbuf (current-buffer)))
2948 (save-excursion
2949 (set-buffer (get-buffer-create buffer))
2950 (barf-if-buffer-read-only)
2951 (save-excursion
2952 (insert-buffer-substring oldbuf start end)))))
2954 (defun copy-to-buffer (buffer start end)
2955 "Copy to specified buffer the text of the region.
2956 It is inserted into that buffer, replacing existing text there.
2958 When calling from a program, give three arguments:
2959 BUFFER (or buffer name), START and END.
2960 START and END specify the portion of the current buffer to be copied."
2962 (let ((oldbuf (current-buffer)))
2963 (save-excursion
2964 (set-buffer (get-buffer-create buffer))
2965 (barf-if-buffer-read-only)
2966 (erase-buffer)
2967 (save-excursion
2968 (insert-buffer-substring oldbuf start end)))))
2969 \f
2970 (put 'mark-inactive 'error-conditions '(mark-inactive error))
2971 (put 'mark-inactive 'error-message "The mark is not active now")
2973 (defvar activate-mark-hook nil
2974 "Hook run when the mark becomes active.
2975 It is also run at the end of a command, if the mark is active and
2976 it is possible that the region may have changed")
2978 (defvar deactivate-mark-hook nil
2979 "Hook run when the mark becomes inactive.")
2981 (defun mark (&optional force)
2982 "Return this buffer's mark value as integer; error if mark inactive.
2983 If optional argument FORCE is non-nil, access the mark value
2984 even if the mark is not currently active, and return nil
2985 if there is no mark at all.
2987 If you are using this in an editing command, you are most likely making
2988 a mistake; see the documentation of `set-mark'."
2989 (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
2990 (marker-position (mark-marker))
2991 (signal 'mark-inactive nil)))
2993 ;; Many places set mark-active directly, and several of them failed to also
2994 ;; run deactivate-mark-hook. This shorthand should simplify.
2995 (defsubst deactivate-mark ()
2996 "Deactivate the mark by setting `mark-active' to nil.
2997 \(That makes a difference only in Transient Mark mode.)
2998 Also runs the hook `deactivate-mark-hook'."
2999 (cond
3000 ((eq transient-mark-mode 'lambda)
3001 (setq transient-mark-mode nil))
3002 (transient-mark-mode
3003 (setq mark-active nil)
3004 (run-hooks 'deactivate-mark-hook))))
3006 (defun set-mark (pos)
3007 "Set this buffer's mark to POS. Don't use this function!
3008 That is to say, don't use this function unless you want
3009 the user to see that the mark has moved, and you want the previous
3010 mark position to be lost.
3012 Normally, when a new mark is set, the old one should go on the stack.
3013 This is why most applications should use `push-mark', not `set-mark'.
3015 Novice Emacs Lisp programmers often try to use the mark for the wrong
3016 purposes. The mark saves a location for the user's convenience.
3017 Most editing commands should not alter the mark.
3018 To remember a location for internal use in the Lisp program,
3019 store it in a Lisp variable. Example:
3021 (let ((beg (point))) (forward-line 1) (delete-region beg (point)))."
3023 (if pos
3024 (progn
3025 (setq mark-active t)
3026 (run-hooks 'activate-mark-hook)
3027 (set-marker (mark-marker) pos (current-buffer)))
3028 ;; Normally we never clear mark-active except in Transient Mark mode.
3029 ;; But when we actually clear out the mark value too,
3030 ;; we must clear mark-active in any mode.
3031 (setq mark-active nil)
3032 (run-hooks 'deactivate-mark-hook)
3033 (set-marker (mark-marker) nil)))
3035 (defvar mark-ring nil
3036 "The list of former marks of the current buffer, most recent first.")
3037 (make-variable-buffer-local 'mark-ring)
3038 (put 'mark-ring 'permanent-local t)
3040 (defcustom mark-ring-max 16
3041 "*Maximum size of mark ring. Start discarding off end if gets this big."
3042 :type 'integer
3043 :group 'editing-basics)
3045 (defvar global-mark-ring nil
3046 "The list of saved global marks, most recent first.")
3048 (defcustom global-mark-ring-max 16
3049 "*Maximum size of global mark ring. \
3050 Start discarding off end if gets this big."
3051 :type 'integer
3052 :group 'editing-basics)
3054 (defun pop-to-mark-command ()
3055 "Jump to mark, and pop a new position for mark off the ring
3056 \(does not affect global mark ring\)."
3057 (interactive)
3058 (if (null (mark t))
3059 (error "No mark set in this buffer")
3060 (goto-char (mark t))
3061 (pop-mark)))
3063 (defun push-mark-command (arg &optional nomsg)
3064 "Set mark at where point is.
3065 If no prefix arg and mark is already set there, just activate it.
3066 Display `Mark set' unless the optional second arg NOMSG is non-nil."
3067 (interactive "P")
3068 (let ((mark (marker-position (mark-marker))))
3069 (if (or arg (null mark) (/= mark (point)))
3070 (push-mark nil nomsg t)
3071 (setq mark-active t)
3072 (run-hooks 'activate-mark-hook)
3073 (unless nomsg
3074 (message "Mark activated")))))
3076 (defun set-mark-command (arg)
3077 "Set mark at where point is, or jump to mark.
3078 With no prefix argument, set mark, and push old mark position on local
3079 mark ring; also push mark on global mark ring if last mark was set in
3080 another buffer. Immediately repeating the command activates
3081 `transient-mark-mode' temporarily.
3084 jump to mark, and pop a new position
3085 for mark off the local mark ring \(this does not affect the global
3087 mark ring \(see `pop-global-mark'\).
3090 the next position off the local (or global) mark ring.
3094 set mark where point is.
3096 Novice Emacs Lisp programmers often try to use the mark for the wrong
3097 purposes. See the documentation of `set-mark' for more information."
3098 (interactive "P")
3099 (if (eq transient-mark-mode 'lambda)
3100 (setq transient-mark-mode nil))
3101 (cond
3102 ((and (consp arg) (> (prefix-numeric-value arg) 4))
3103 (push-mark-command nil))
3104 ((not (eq this-command 'set-mark-command))
3105 (if arg
3106 (pop-to-mark-command)
3107 (push-mark-command t)))
3108 ((eq last-command 'pop-to-mark-command)
3109 (setq this-command 'pop-to-mark-command)
3110 (pop-to-mark-command))
3111 ((and (eq last-command 'pop-global-mark) (not arg))
3112 (setq this-command 'pop-global-mark)
3113 (pop-global-mark))
3114 (arg
3115 (setq this-command 'pop-to-mark-command)
3116 (pop-to-mark-command))
3117 ((and (eq last-command 'set-mark-command)
3118 mark-active (null transient-mark-mode))
3119 (setq transient-mark-mode 'lambda)
3120 (message "Transient-mark-mode temporarily enabled"))
3121 (t
3122 (push-mark-command nil))))
3124 (defun push-mark (&optional location nomsg activate)
3125 "Set mark at LOCATION (point, by default) and push old mark on mark ring.
3126 If the last global mark pushed was not in the current buffer,
3127 also push LOCATION on the global mark ring.
3128 Display `Mark set' unless the optional second arg NOMSG is non-nil.
3129 In Transient Mark mode, activate mark if optional third arg ACTIVATE non-nil.
3131 Novice Emacs Lisp programmers often try to use the mark for the wrong
3132 purposes. See the documentation of `set-mark' for more information.
3134 In Transient Mark mode, this does not activate the mark."
3135 (unless (null (mark t))
3136 (setq mark-ring (cons (copy-marker (mark-marker)) mark-ring))
3137 (when (> (length mark-ring) mark-ring-max)
3138 (move-marker (car (nthcdr mark-ring-max mark-ring)) nil)
3139 (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))
3140 (set-marker (mark-marker) (or location (point)) (current-buffer))
3141 ;; Now push the mark on the global mark ring.
3142 (if (and global-mark-ring
3143 (eq (marker-buffer (car global-mark-ring)) (current-buffer)))
3144 ;; The last global mark pushed was in this same buffer.
3145 ;; Don't push another one.
3146 nil
3147 (setq global-mark-ring (cons (copy-marker (mark-marker)) global-mark-ring))
3148 (when (> (length global-mark-ring) global-mark-ring-max)
3149 (move-marker (car (nthcdr global-mark-ring-max global-mark-ring)) nil)
3150 (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))
3151 (or nomsg executing-kbd-macro (> (minibuffer-depth) 0)
3152 (message "Mark set"))
3153 (if (or activate (not transient-mark-mode))
3154 (set-mark (mark t)))
3155 nil)
3157 (defun pop-mark ()
3158 "Pop off mark ring into the buffer's actual mark.
3159 Does not set point. Does nothing if mark ring is empty."
3160 (when mark-ring
3161 (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker)))))
3162 (set-marker (mark-marker) (+ 0 (car mark-ring)) (current-buffer))
3163 (move-marker (car mark-ring) nil)
3164 (if (null (mark t)) (ding))
3165 (setq mark-ring (cdr mark-ring)))
3166 (deactivate-mark))
3168 (defalias 'exchange-dot-and-mark 'exchange-point-and-mark)
3169 (defun exchange-point-and-mark (&optional arg)
3170 "Put the mark where point is now, and point where the mark is now.
3171 This command works even when the mark is not active,
3172 and it reactivates the mark.
3173 With prefix arg, `transient-mark-mode' is enabled temporarily."
3174 (interactive "P")
3175 (if arg
3176 (if mark-active
3177 (if (null transient-mark-mode)
3178 (setq transient-mark-mode 'lambda))
3179 (setq arg nil)))
3180 (unless arg
3181 (let ((omark (mark t)))
3182 (if (null omark)
3183 (error "No mark set in this buffer"))
3184 (set-mark (point))
3185 (goto-char omark)
3186 nil)))
3188 (define-minor-mode transient-mark-mode
3189 "Toggle Transient Mark mode.
3190 With arg, turn Transient Mark mode on if arg is positive, off otherwise.
3192 In Transient Mark mode, when the mark is active, the region is highlighted.
3194 So do certain other operations that set the mark
3195 but whose main purpose is something else--for example,
3201 Many commands change their behavior when Transient Mark mode is in effect
3202 and the mark is active, by acting on the region instead of their usual
3203 default part of the buffer's text. Examples of such commands include
3208 commands which are sensitive to the Transient Mark mode."
3209 :global t :group 'editing-basics :require nil)
3211 (defvar widen-automatically t
3212 "Non-nil means it is ok for commands to call `widen' when they want to.
3213 Some commands will do this in order to go to positions outside
3214 the current accessible part of the buffer.
3216 If `widen-automatically' is nil, these commands will do something else
3217 as a fallback, and won't change the buffer bounds.")
3219 (defun pop-global-mark ()
3220 "Pop off global mark ring and jump to the top location."
3221 (interactive)
3222 ;; Pop entries which refer to non-existent buffers.
3223 (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
3224 (setq global-mark-ring (cdr global-mark-ring)))
3225 (or global-mark-ring
3226 (error "No global mark set"))
3227 (let* ((marker (car global-mark-ring))
3228 (buffer (marker-buffer marker))
3229 (position (marker-position marker)))
3230 (setq global-mark-ring (nconc (cdr global-mark-ring)
3231 (list (car global-mark-ring))))
3232 (set-buffer buffer)
3233 (or (and (>= position (point-min))
3234 (<= position (point-max)))
3235 (if widen-automatically
3236 (error "Global mark position is outside accessible part of buffer")
3237 (widen)))
3238 (goto-char position)
3239 (switch-to-buffer buffer)))
3240 \f
3241 (defcustom next-line-add-newlines nil
3242 "*If non-nil, `next-line' inserts newline to avoid `end of buffer' error."
3243 :type 'boolean
3244 :version "21.1"
3245 :group 'editing-basics)
3247 (defun next-line (&optional arg try-vscroll)
3248 "Move cursor vertically down ARG lines.
3249 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3250 If there is no character in the target line exactly under the current column,
3251 the cursor is positioned after the character in that line which spans this
3252 column, or at the end of the line if it is not long enough.
3253 If there is no line in the buffer after this one, behavior depends on the
3254 value of `next-line-add-newlines'. If non-nil, it inserts a newline character
3255 to create a line, and moves the cursor to that line. Otherwise it moves the
3256 cursor to the end of the buffer.
3259 a semipermanent goal column for this command.
3260 Then instead of trying to move exactly vertically (or as close as possible),
3261 this command moves to the specified goal column (or as close as possible).
3262 The goal column is stored in the variable `goal-column', which is nil
3263 when there is no goal column.
3265 If you are thinking of using this in a Lisp program, consider
3266 using `forward-line' instead. It is usually easier to use
3267 and more reliable (no dependence on goal column, etc.)."
3269 (or arg (setq arg 1))
3270 (if (and next-line-add-newlines (= arg 1))
3271 (if (save-excursion (end-of-line) (eobp))
3272 ;; When adding a newline, don't expand an abbrev.
3273 (let ((abbrev-mode nil))
3274 (end-of-line)
3276 (line-move arg nil nil try-vscroll))
3277 (if (interactive-p)
3278 (condition-case nil
3279 (line-move arg nil nil try-vscroll)
3280 ((beginning-of-buffer end-of-buffer) (ding)))
3281 (line-move arg nil nil try-vscroll)))
3282 nil)
3284 (defun previous-line (&optional arg try-vscroll)
3285 "Move cursor vertically up ARG lines.
3286 Interactively, vscroll tall lines if `auto-window-vscroll' is enabled.
3287 If there is no character in the target line exactly over the current column,
3288 the cursor is positioned after the character in that line which spans this
3289 column, or at the end of the line if it is not long enough.
3292 a semipermanent goal column for this command.
3293 Then instead of trying to move exactly vertically (or as close as possible),
3294 this command moves to the specified goal column (or as close as possible).
3295 The goal column is stored in the variable `goal-column', which is nil
3296 when there is no goal column.
3298 If you are thinking of using this in a Lisp program, consider using
3299 `forward-line' with a negative argument instead. It is usually easier
3300 to use and more reliable (no dependence on goal column, etc.)."
3302 (or arg (setq arg 1))
3303 (if (interactive-p)
3304 (condition-case nil
3305 (line-move (- arg) nil nil try-vscroll)
3306 ((beginning-of-buffer end-of-buffer) (ding)))
3307 (line-move (- arg) nil nil try-vscroll))
3308 nil)
3310 (defcustom track-eol nil
3311 "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
3312 This means moving to the end of each line moved onto.
3313 The beginning of a blank line does not count as the end of a line."
3314 :type 'boolean
3315 :group 'editing-basics)
3317 (defcustom goal-column nil
3319 :type '(choice integer
3320 (const :tag "None" nil))
3321 :group 'editing-basics)
3322 (make-variable-buffer-local 'goal-column)
3324 (defvar temporary-goal-column 0
3325 "Current goal column for vertical motion.
3326 It is the column where point was
3327 at the start of current run of vertical motion commands.
3328 When the `track-eol' feature is doing its job, the value is 9999.")
3330 (defcustom line-move-ignore-invisible t
3332 Outline mode sets this."
3333 :type 'boolean
3334 :group 'editing-basics)
3336 (defun line-move-invisible-p (pos)
3337 "Return non-nil if the character after POS is currently invisible."
3338 (let ((prop
3339 (get-char-property pos 'invisible)))
3340 (if (eq buffer-invisibility-spec t)
3341 prop
3342 (or (memq prop buffer-invisibility-spec)
3343 (assq prop buffer-invisibility-spec)))))
3345 ;; Perform vertical scrolling of tall images if necessary.
3346 ;; Don't vscroll in a keyboard macro.
3347 (defun line-move (arg &optional noerror to-end try-vscroll)
3348 (if (and auto-window-vscroll try-vscroll
3349 (not defining-kbd-macro)
3350 (not executing-kbd-macro))
3351 (let ((forward (> arg 0))
3352 (part (nth 2 (pos-visible-in-window-p (point) nil t))))
3353 (if (and (consp part)
3354 (> (setq part (if forward (cdr part) (car part))) 0))
3355 (set-window-vscroll nil
3356 (if forward
3357 (+ (window-vscroll nil t)
3358 (min part
3359 (* (frame-char-height) arg)))
3360 (max 0
3361 (- (window-vscroll nil t)
3362 (min part
3363 (* (frame-char-height) (- arg))))))
3364 t)
3365 (set-window-vscroll nil 0)
3366 (when (line-move-1 arg noerror to-end)
3367 (sit-for 0)
3368 (if (and (not forward)
3369 (setq part (nth 2 (pos-visible-in-window-p
3370 (line-beginning-position) nil t)))
3371 (> (cdr part) 0))
3372 (set-window-vscroll nil (cdr part) t))
3373 t)))
3374 (line-move-1 arg noerror to-end)))
3376 ;; This is the guts of next-line and previous-line.
3377 ;; Arg says how many lines to move.
3378 ;; The value is t if we can move the specified number of lines.
3379 (defun line-move-1 (arg &optional noerror to-end)
3380 ;; Don't run any point-motion hooks, and disregard intangibility,
3381 ;; for intermediate positions.
3382 (let ((inhibit-point-motion-hooks t)
3383 (opoint (point))
3384 (forward (> arg 0)))
3385 (unwind-protect
3386 (progn
3387 (if (not (memq last-command '(next-line previous-line)))
3388 (setq temporary-goal-column
3389 (if (and track-eol (eolp)
3390 ;; Don't count beg of empty line as end of line
3391 ;; unless we just did explicit end-of-line.
3392 (or (not (bolp)) (eq last-command 'end-of-line)))
3393 9999
3394 (current-column))))
3396 (if (and (not (integerp selective-display))
3397 (not line-move-ignore-invisible))
3398 ;; Use just newline characters.
3399 ;; Set ARG to 0 if we move as many lines as requested.
3400 (or (if (> arg 0)
3401 (progn (if (> arg 1) (forward-line (1- arg)))
3402 ;; This way of moving forward ARG lines
3403 ;; verifies that we have a newline after the last one.
3404 ;; It doesn't get confused by intangible text.
3405 (end-of-line)
3406 (if (zerop (forward-line 1))
3407 (setq arg 0)))
3408 (and (zerop (forward-line arg))
3409 (bolp)
3410 (setq arg 0)))
3411 (unless noerror
3412 (signal (if (< arg 0)
3413 'beginning-of-buffer
3414 'end-of-buffer)
3415 nil)))
3416 ;; Move by arg lines, but ignore invisible ones.
3417 (let (done)
3418 (while (and (> arg 0) (not done))
3419 ;; If the following character is currently invisible,
3420 ;; skip all characters with that same `invisible' property value.
3421 (while (and (not (eobp)) (line-move-invisible-p (point)))
3422 (goto-char (next-char-property-change (point))))
3423 ;; Now move a line.
3424 (end-of-line)
3425 ;; If there's no invisibility here, move over the newline.
3426 (if (and (not (integerp selective-display))
3427 (not (line-move-invisible-p (point))))
3428 ;; We avoid vertical-motion when possible
3429 ;; because that has to fontify.
3430 (if (eobp)
3431 (if (not noerror)
3432 (signal 'end-of-buffer nil)
3433 (setq done t))
3434 (forward-line 1))
3435 ;; Otherwise move a more sophisticated way.
3436 ;; (What's the logic behind this code?)
3437 (and (zerop (vertical-motion 1))
3438 (if (not noerror)
3439 (signal 'end-of-buffer nil)
3440 (setq done t))))
3441 (unless done
3442 (setq arg (1- arg))))
3443 ;; The logic of this is the same as the loop above,
3444 ;; it just goes in the other direction.
3445 (while (and (< arg 0) (not done))
3446 (beginning-of-line)
3447 (if (or (bobp)
3448 (and (not (integerp selective-display))
3449 (not (line-move-invisible-p (1- (point))))))
3450 (if (bobp)
3451 (if (not noerror)
3452 (signal 'beginning-of-buffer nil)
3453 (setq done t))
3454 (forward-line -1))
3455 (if (zerop (vertical-motion -1))
3456 (if (not noerror)
3457 (signal 'beginning-of-buffer nil)
3458 (setq done t))))
3459 (unless done
3460 (setq arg (1+ arg))
3461 (while (and ;; Don't move over previous invis lines
3462 ;; if our target is the middle of this line.
3463 (or (zerop (or goal-column temporary-goal-column))
3464 (< arg 0))
3465 (not (bobp)) (line-move-invisible-p (1- (point))))
3466 (goto-char (previous-char-property-change (point))))))))
3467 ;; This is the value the function returns.
3468 (= arg 0))
3470 (cond ((> arg 0)
3471 ;; If we did not move down as far as desired,
3472 ;; at least go to end of line.
3473 (end-of-line))
3474 ((< arg 0)
3475 ;; If we did not move down as far as desired,
3476 ;; at least go to end of line.
3477 (beginning-of-line))
3478 (t
3479 (line-move-finish (or goal-column temporary-goal-column)
3480 opoint forward))))))
3482 (defun line-move-finish (column opoint forward)
3483 (let ((repeat t))
3484 (while repeat
3485 ;; Set REPEAT to t to repeat the whole thing.
3486 (setq repeat nil)
3488 (let (new
3489 (line-beg (save-excursion (beginning-of-line) (point)))
3490 (line-end
3491 ;; Compute the end of the line
3492 ;; ignoring effectively invisible newlines.
3493 (save-excursion
3494 (end-of-line)
3495 (while (and (not (eobp)) (line-move-invisible-p (point)))
3496 (goto-char (next-char-property-change (point)))
3497 (end-of-line))
3498 (point))))
3500 ;; Move to the desired column.
3501 (line-move-to-column column)
3502 (setq new (point))
3504 ;; Process intangibility within a line.
3505 ;; Move to the chosen destination position from above,
3506 ;; with intangibility processing enabled.
3508 (goto-char (point-min))
3509 (let ((inhibit-point-motion-hooks nil))
3510 (goto-char new)
3512 ;; If intangibility moves us to a different (later) place
3513 ;; in the same line, use that as the destination.
3514 (if (<= (point) line-end)
3515 (setq new (point))
3516 ;; If that position is "too late",
3517 ;; try the previous allowable position.
3518 ;; See if it is ok.
3519 (backward-char)
3520 (if (if forward
3521 ;; If going forward, don't accept the previous
3522 ;; allowable position if it is before the target line.
3523 (< line-beg (point))
3524 ;; If going backward, don't accept the previous
3525 ;; allowable position if it is still after the target line.
3526 (<= (point) line-end))
3527 (setq new (point))
3528 ;; As a last resort, use the end of the line.
3529 (setq new line-end))))
3531 ;; Now move to the updated destination, processing fields
3532 ;; as well as intangibility.
3533 (goto-char opoint)
3534 (let ((inhibit-point-motion-hooks nil))
3535 (goto-char
3536 (constrain-to-field new opoint nil t
3537 'inhibit-line-move-field-capture)))
3539 ;; If all this moved us to a different line,
3540 ;; retry everything within that new line.
3541 (when (or (< (point) line-beg) (> (point) line-end))
3542 ;; Repeat the intangibility and field processing.
3543 (setq repeat t))))))
3545 (defun line-move-to-column (col)
3546 "Try to find column COL, considering invisibility.
3547 This function works only in certain cases,
3548 because what we really need is for `move-to-column'
3549 and `current-column' to be able to ignore invisible text."
3550 (if (zerop col)
3551 (beginning-of-line)
3552 (move-to-column col))
3554 (when (and line-move-ignore-invisible
3555 (not (bolp)) (line-move-invisible-p (1- (point))))
3556 (let ((normal-location (point))
3557 (normal-column (current-column)))
3558 ;; If the following character is currently invisible,
3559 ;; skip all characters with that same `invisible' property value.
3560 (while (and (not (eobp))
3561 (line-move-invisible-p (point)))
3562 (goto-char (next-char-property-change (point))))
3563 ;; Have we advanced to a larger column position?
3564 (if (> (current-column) normal-column)
3565 ;; We have made some progress towards the desired column.
3566 ;; See if we can make any further progress.
3567 (line-move-to-column (+ (current-column) (- col normal-column)))
3568 ;; Otherwise, go to the place we originally found
3569 ;; and move back over invisible text.
3570 ;; that will get us to the same place on the screen
3571 ;; but with a more reasonable buffer position.
3572 (goto-char normal-location)
3573 (let ((line-beg (save-excursion (beginning-of-line) (point))))
3574 (while (and (not (bolp)) (line-move-invisible-p (1- (point))))
3575 (goto-char (previous-char-property-change (point) line-beg))))))))
3577 (defun move-end-of-line (arg)
3578 "Move point to end of current line.
3579 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3580 If point reaches the beginning or end of buffer, it stops there.
3581 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3583 This command does not move point across a field boundary unless doing so
3584 would move beyond there to a different line; if ARG is nil or 1, and
3585 point starts at a field boundary, point does not move. To ignore field
3586 boundaries bind `inhibit-field-text-motion' to t."
3587 (interactive "p")
3588 (or arg (setq arg 1))
3589 (let (done)
3590 (while (not done)
3591 (let ((newpos
3592 (save-excursion
3593 (let ((goal-column 0))
3594 (and (line-move arg t)
3595 (not (bobp))
3596 (progn
3597 (while (and (not (bobp)) (line-move-invisible-p (1- (point))))
3598 (goto-char (previous-char-property-change (point))))
3599 (backward-char 1)))
3600 (point)))))
3601 (goto-char newpos)
3602 (if (and (> (point) newpos)
3604 (backward-char 1)
3605 (if (and (> (point) newpos) (not (eobp))
3607 ;; If we skipped something intangible
3608 ;; and now we're not really at eol,
3609 ;; keep going.
3610 (setq arg 1)
3611 (setq done t)))))))
3613 (defun move-beginning-of-line (arg)
3614 "Move point to beginning of current display line.
3615 With argument ARG not nil or 1, move forward ARG - 1 lines first.
3616 If point reaches the beginning or end of buffer, it stops there.
3617 To ignore intangibility, bind `inhibit-point-motion-hooks' to t.
3619 This command does not move point across a field boundary unless doing so
3620 would move beyond there to a different line; if ARG is nil or 1, and
3621 point starts at a field boundary, point does not move. To ignore field
3622 boundaries bind `inhibit-field-text-motion' to t."
3623 (interactive "p")
3624 (or arg (setq arg 1))
3625 (if (/= arg 1)
3626 (line-move (1- arg) t))
3627 (beginning-of-line 1)
3628 (let ((orig (point)))
3629 (vertical-motion 0)
3630 (if (/= orig (point))
3631 (goto-char (constrain-to-field (point) orig (/= arg 1) t nil)))))
3634 ;;; Many people have said they rarely use this feature, and often type
3635 ;;; it by accident. Maybe it shouldn't even be on a key.
3636 (put 'set-goal-column 'disabled t)
3638 (defun set-goal-column (arg)
3640 Those commands will move to this position in the line moved to
3641 rather than trying to keep the same horizontal position.
3642 With a non-nil argument, clears out the goal column
3644 The goal column is stored in the variable `goal-column'."
3645 (interactive "P")
3646 (if arg
3647 (progn
3648 (setq goal-column nil)
3649 (message "No goal column"))
3650 (setq goal-column (current-column))
3651 (message (substitute-command-keys
3653 goal-column))
3654 nil)
3655 \f
3657 (defun scroll-other-window-down (lines)
3659 For more details, see the documentation for `scroll-other-window'."
3660 (interactive "P")
3661 (scroll-other-window
3662 ;; Just invert the argument's meaning.
3663 ;; We can do that without knowing which window it will be.
3664 (if (eq lines '-) nil
3665 (if (null lines) '-
3666 (- (prefix-numeric-value lines))))))
3668 (defun beginning-of-buffer-other-window (arg)
3669 "Move point to the beginning of the buffer in the other window.
3670 Leave mark at previous position.
3671 With arg N, put point N/10 of the way from the true beginning."
3672 (interactive "P")
3673 (let ((orig-window (selected-window))
3674 (window (other-window-for-scrolling)))
3675 ;; We use unwind-protect rather than save-window-excursion
3676 ;; because the latter would preserve the things we want to change.
3677 (unwind-protect
3678 (progn
3679 (select-window window)
3680 ;; Set point and mark in that window's buffer.
3681 (with-no-warnings
3682 (beginning-of-buffer arg))
3683 ;; Set point accordingly.
3684 (recenter '(t)))
3685 (select-window orig-window))))
3687 (defun end-of-buffer-other-window (arg)
3688 "Move point to the end of the buffer in the other window.
3689 Leave mark at previous position.
3690 With arg N, put point N/10 of the way from the true end."
3691 (interactive "P")
3692 ;; See beginning-of-buffer-other-window for comments.
3693 (let ((orig-window (selected-window))
3694 (window (other-window-for-scrolling)))
3695 (unwind-protect
3696 (progn
3697 (select-window window)
3698 (with-no-warnings
3699 (end-of-buffer arg))
3700 (recenter '(t)))
3701 (select-window orig-window))))
3702 \f
3703 (defun transpose-chars (arg)
3704 "Interchange characters around point, moving forward one character.
3705 With prefix arg ARG, effect is to take character before point
3706 and drag it forward past ARG other characters (backward if ARG negative).
3707 If no argument and at end of line, the previous two chars are exchanged."
3708 (interactive "*P")
3709 (and (null arg) (eolp) (forward-char -1))
3710 (transpose-subr 'forward-char (prefix-numeric-value arg)))
3712 (defun transpose-words (arg)
3713 "Interchange words around point, leaving point at end of them.
3714 With prefix arg ARG, effect is to take word before or around point
3715 and drag it forward past ARG other words (backward if ARG negative).
3716 If ARG is zero, the words around or after point and around or after mark
3717 are interchanged."
3718 ;; FIXME: `foo a!nd bar' should transpose into `bar and foo'.
3719 (interactive "*p")
3720 (transpose-subr 'forward-word arg))
3722 (defun transpose-sexps (arg)
3724 Does not work on a sexp that point is in the middle of
3725 if it is a list or string."
3726 (interactive "*p")
3727 (transpose-subr
3728 (lambda (arg)
3729 ;; Here we should try to simulate the behavior of
3730 ;; (cons (progn (forward-sexp x) (point))
3731 ;; (progn (forward-sexp (- x)) (point)))
3732 ;; Except that we don't want to rely on the second forward-sexp
3733 ;; putting us back to where we want to be, since forward-sexp-function
3734 ;; might do funny things like infix-precedence.
3735 (if (if (> arg 0)
3737 (and (not (bobp))
3739 ;; Jumping over a symbol. We might be inside it, mind you.
3740 (progn (funcall (if (> arg 0)
3741 'skip-syntax-backward 'skip-syntax-forward)
3742 "w_")
3743 (cons (save-excursion (forward-sexp arg) (point)) (point)))
3744 ;; Otherwise, we're between sexps. Take a step back before jumping
3745 ;; to make sure we'll obey the same precedence no matter which direction
3746 ;; we're going.
3747 (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) " .")
3748 (cons (save-excursion (forward-sexp arg) (point))
3749 (progn (while (or (forward-comment (if (> arg 0) 1 -1))
3750 (not (zerop (funcall (if (> arg 0)
3751 'skip-syntax-forward
3752 'skip-syntax-backward)
3753 ".")))))
3754 (point)))))
3755 arg 'special))
3757 (defun transpose-lines (arg)
3758 "Exchange current line and previous line, leaving point after both.
3759 With argument ARG, takes previous line and moves it past ARG lines.
3760 With argument 0, interchanges line point is in with line mark is in."
3761 (interactive "*p")
3762 (transpose-subr (function
3763 (lambda (arg)
3764 (if (> arg 0)
3765 (progn
3766 ;; Move forward over ARG lines,
3767 ;; but create newlines if necessary.
3768 (setq arg (forward-line arg))
3770 (setq arg (1+ arg)))
3771 (if (> arg 0)
3772 (newline arg)))
3773 (forward-line arg))))
3774 arg))
3776 (defun transpose-subr (mover arg &optional special)
3777 (let ((aux (if special mover
3778 (lambda (x)
3779 (cons (progn (funcall mover x) (point))
3780 (progn (funcall mover (- x)) (point))))))
3781 pos1 pos2)
3782 (cond
3783 ((= arg 0)
3784 (save-excursion
3785 (setq pos1 (funcall aux 1))
3786 (goto-char (mark))
3787 (setq pos2 (funcall aux 1))
3788 (transpose-subr-1 pos1 pos2))
3789 (exchange-point-and-mark))
3790 ((> arg 0)
3791 (setq pos1 (funcall aux -1))
3792 (setq pos2 (funcall aux arg))
3793 (transpose-subr-1 pos1 pos2)
3794 (goto-char (car pos2)))
3795 (t
3796 (setq pos1 (funcall aux -1))
3797 (goto-char (car pos1))
3798 (setq pos2 (funcall aux arg))
3799 (transpose-subr-1 pos1 pos2)))))
3801 (defun transpose-subr-1 (pos1 pos2)
3802 (when (> (car pos1) (cdr pos1)) (setq pos1 (cons (cdr pos1) (car pos1))))
3803 (when (> (car pos2) (cdr pos2)) (setq pos2 (cons (cdr pos2) (car pos2))))
3804 (when (> (car pos1) (car pos2))
3805 (let ((swap pos1))
3806 (setq pos1 pos2 pos2 swap)))
3807 (if (> (cdr pos1) (car pos2)) (error "Don't have two things to transpose"))
3808 (atomic-change-group
3809 (let (word2)
3810 ;; FIXME: We first delete the two pieces of text, so markers that
3811 ;; used to point to after the text end up pointing to before it :-(
3812 (setq word2 (delete-and-extract-region (car pos2) (cdr pos2)))
3813 (goto-char (car pos2))
3814 (insert (delete-and-extract-region (car pos1) (cdr pos1)))
3815 (goto-char (car pos1))
3816 (insert word2))))
3817 \f
3818 (defun backward-word (&optional arg)
3819 "Move backward until encountering the beginning of a word.
3820 With argument, do this that many times."
3821 (interactive "p")
3822 (forward-word (- (or arg 1))))
3824 (defun mark-word (&optional arg allow-extend)
3825 "Set mark ARG words away from point.
3827 move to with the same argument.
3828 Interactively, if this command is repeated
3829 or (in Transient Mark mode) if the mark is active,
3830 it marks the next ARG words after the ones already marked."
3832 (cond ((and allow-extend
3833 (or (and (eq last-command this-command) (mark t))
3834 (and transient-mark-mode mark-active)))
3835 (setq arg (if arg (prefix-numeric-value arg)
3836 (if (< (mark) (point)) -1 1)))
3837 (set-mark
3838 (save-excursion
3839 (goto-char (mark))
3840 (forward-word arg)
3841 (point))))
3842 (t
3843 (push-mark
3844 (save-excursion
3845 (forward-word (prefix-numeric-value arg))
3846 (point))
3847 nil t))))
3849 (defun kill-word (arg)
3850 "Kill characters forward until encountering the end of a word.
3851 With argument, do this that many times."
3852 (interactive "p")
3853 (kill-region (point) (progn (forward-word arg) (point))))
3855 (defun backward-kill-word (arg)
3856 "Kill characters backward until encountering the end of a word.
3857 With argument, do this that many times."
3858 (interactive "p")
3859 (kill-word (- arg)))
3861 (defun current-word (&optional strict really-word)
3862 "Return the symbol or word that point is on (or a nearby one) as a string.
3863 The return value includes no text properties.
3864 If optional arg STRICT is non-nil, return nil unless point is within
3865 or adjacent to a symbol or word. In all cases the value can be nil
3866 if there is no word nearby.
3867 The function, belying its name, normally finds a symbol.
3868 If optional arg REALLY-WORD is non-nil, it finds just a word."
3869 (save-excursion
3870 (let* ((oldpoint (point)) (start (point)) (end (point))
3871 (syntaxes (if really-word "w" "w_"))
3872 (not-syntaxes (concat "^" syntaxes)))
3873 (skip-syntax-backward syntaxes) (setq start (point))
3874 (goto-char oldpoint)
3875 (skip-syntax-forward syntaxes) (setq end (point))
3876 (when (and (eq start oldpoint) (eq end oldpoint)
3877 ;; Point is neither within nor adjacent to a word.
3878 (not strict))
3879 ;; Look for preceding word in same line.
3880 (skip-syntax-backward not-syntaxes
3881 (save-excursion (beginning-of-line)
3882 (point)))
3883 (if (bolp)
3884 ;; No preceding word in same line.
3885 ;; Look for following word in same line.
3886 (progn
3887 (skip-syntax-forward not-syntaxes
3888 (save-excursion (end-of-line)
3889 (point)))
3890 (setq start (point))
3891 (skip-syntax-forward syntaxes)
3892 (setq end (point)))
3893 (setq end (point))
3894 (skip-syntax-backward syntaxes)
3895 (setq start (point))))
3896 ;; If we found something nonempty, return it as a string.
3897 (unless (= start end)
3898 (buffer-substring-no-properties start end)))))
3899 \f
3900 (defcustom fill-prefix nil
3901 "*String for filling to insert at front of new line, or nil for none."
3902 :type '(choice (const :tag "None" nil)
3903 string)
3904 :group 'fill)
3905 (make-variable-buffer-local 'fill-prefix)
3907 (defcustom auto-fill-inhibit-regexp nil
3908 "*Regexp to match lines which should not be auto-filled."
3909 :type '(choice (const :tag "None" nil)
3910 regexp)
3911 :group 'fill)
3913 (defvar comment-line-break-function 'comment-indent-new-line
3914 "*Mode-specific function which line breaks and continues a comment.
3916 This function is only called during auto-filling of a comment section.
3917 The function should take a single optional argument, which is a flag
3918 indicating whether it should use soft newlines.
3920 Setting this variable automatically makes it local to the current buffer.")
3922 ;; This function is used as the auto-fill-function of a buffer
3923 ;; when Auto-Fill mode is enabled.
3924 ;; It returns t if it really did any work.
3925 ;; (Actually some major modes use a different auto-fill function,
3926 ;; but this one is the default one.)
3927 (defun do-auto-fill ()
3928 (let (fc justify give-up
3929 (fill-prefix fill-prefix))
3930 (if (or (not (setq justify (current-justification)))
3931 (null (setq fc (current-fill-column)))
3932 (and (eq justify 'left)
3933 (<= (current-column) fc))
3934 (and auto-fill-inhibit-regexp
3935 (save-excursion (beginning-of-line)
3936 (looking-at auto-fill-inhibit-regexp))))
3937 nil ;; Auto-filling not required
3938 (if (memq justify '(full center right))
3939 (save-excursion (unjustify-current-line)))
3941 ;; Choose a fill-prefix automatically.
3942 (when (and adaptive-fill-mode
3943 (or (null fill-prefix) (string= fill-prefix "")))
3944 (let ((prefix
3945 (fill-context-prefix
3946 (save-excursion (backward-paragraph 1) (point))
3947 (save-excursion (forward-paragraph 1) (point)))))
3948 (and prefix (not (equal prefix ""))
3949 ;; Use auto-indentation rather than a guessed empty prefix.
3950 (not (and fill-indent-according-to-mode
3952 (setq fill-prefix prefix))))
3954 (while (and (not give-up) (> (current-column) fc))
3955 ;; Determine where to split the line.
3956 (let* (after-prefix
3957 (fill-point
3958 (save-excursion
3959 (beginning-of-line)
3960 (setq after-prefix (point))
3961 (and fill-prefix
3962 (looking-at (regexp-quote fill-prefix))
3963 (setq after-prefix (match-end 0)))
3964 (move-to-column (1+ fc))
3965 (fill-move-to-break-point after-prefix)
3966 (point))))
3968 ;; See whether the place we found is any good.
3969 (if (save-excursion
3970 (goto-char fill-point)
3971 (or (bolp)
3972 ;; There is no use breaking at end of line.
3973 (save-excursion (skip-chars-forward " ") (eolp))
3974 ;; It is futile to split at the end of the prefix
3975 ;; since we would just insert the prefix again.
3976 (and after-prefix (<= (point) after-prefix))
3977 ;; Don't split right after a comment starter
3978 ;; since we would just make another comment starter.
3979 (and comment-start-skip
3980 (let ((limit (point)))
3981 (beginning-of-line)
3982 (and (re-search-forward comment-start-skip
3983 limit t)
3984 (eq (point) limit))))))
3985 ;; No good place to break => stop trying.
3986 (setq give-up t)
3987 ;; Ok, we have a useful place to break the line. Do it.
3988 (let ((prev-column (current-column)))
3989 ;; If point is at the fill-point, do not `save-excursion'.
3990 ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3991 ;; point will end up before it rather than after it.
3992 (if (save-excursion
3994 (= (point) fill-point))
3995 (funcall comment-line-break-function t)
3996 (save-excursion
3997 (goto-char fill-point)
3998 (funcall comment-line-break-function t)))
3999 ;; Now do justification, if required
4000 (if (not (eq justify 'left))
4001 (save-excursion
4002 (end-of-line 0)
4003 (justify-current-line justify nil t)))
4004 ;; If making the new line didn't reduce the hpos of
4005 ;; the end of the line, then give up now;
4006 ;; trying again will not help.
4007 (if (>= (current-column) prev-column)
4008 (setq give-up t))))))
4009 ;; Justify last line.
4010 (justify-current-line justify t t)
4011 t)))
4013 (defvar normal-auto-fill-function 'do-auto-fill
4014 "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
4015 Some major modes set this.")
4017 (put 'auto-fill-function :minor-mode-function 'auto-fill-mode)
4018 ;; FIXME: turn into a proper minor mode.
4019 ;; Add a global minor mode version of it.
4020 (defun auto-fill-mode (&optional arg)
4021 "Toggle Auto Fill mode.
4022 With arg, turn Auto Fill mode on if and only if arg is positive.
4023 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
4024 automatically breaks the line at a previous space.
4026 The value of `normal-auto-fill-function' specifies the function to use
4027 for `auto-fill-function' when turning Auto Fill mode on."
4028 (interactive "P")
4029 (prog1 (setq auto-fill-function
4030 (if (if (null arg)
4031 (not auto-fill-function)
4032 (> (prefix-numeric-value arg) 0))
4033 normal-auto-fill-function
4034 nil))
4035 (force-mode-line-update)))
4037 ;; This holds a document string used to document auto-fill-mode.
4038 (defun auto-fill-function ()
4039 "Automatically break line at a previous space, in insertion of text."
4040 nil)
4042 (defun turn-on-auto-fill ()
4043 "Unconditionally turn on Auto Fill mode."
4044 (auto-fill-mode 1))
4046 (defun turn-off-auto-fill ()
4047 "Unconditionally turn off Auto Fill mode."
4048 (auto-fill-mode -1))
4050 (custom-add-option 'text-mode-hook 'turn-on-auto-fill)
4052 (defun set-fill-column (arg)
4053 "Set `fill-column' to specified argument.
4056 (interactive "P")
4057 (if (consp arg)
4058 (setq arg (current-column)))
4059 (if (not (integerp arg))
4060 ;; Disallow missing argument; it's probably a typo for C-x C-f.
4061 (error "Set-fill-column requires an explicit argument")
4062 (message "Fill column set to %d (was %d)" arg fill-column)
4063 (setq fill-column arg)))
4064 \f
4065 (defun set-selective-display (arg)
4066 "Set `selective-display' to ARG; clear it if no arg.
4067 When the value of `selective-display' is a number > 0,
4068 lines whose indentation is >= that value are not displayed.
4069 The variable `selective-display' has a separate value for each buffer."
4070 (interactive "P")
4071 (if (eq selective-display t)
4072 (error "selective-display already in use for marked lines"))
4073 (let ((current-vpos
4074 (save-restriction
4075 (narrow-to-region (point-min) (point))
4076 (goto-char (window-start))
4077 (vertical-motion (window-height)))))
4078 (setq selective-display
4079 (and arg (prefix-numeric-value arg)))
4080 (recenter current-vpos))
4081 (set-window-start (selected-window) (window-start (selected-window)))
4082 (princ "selective-display set to " t)
4083 (prin1 selective-display t)
4084 (princ "." t))
4086 (defvaralias 'indicate-unused-lines 'indicate-empty-lines)
4087 (defvaralias 'default-indicate-unused-lines 'default-indicate-empty-lines)
4089 (defun toggle-truncate-lines (arg)
4090 "Toggle whether to fold or truncate long lines on the screen.
4091 With arg, truncate long lines iff arg is positive.
4092 Note that in side-by-side windows, truncation is always enabled."
4093 (interactive "P")
4094 (setq truncate-lines
4095 (if (null arg)
4096 (not truncate-lines)
4097 (> (prefix-numeric-value arg) 0)))
4098 (force-mode-line-update)
4099 (unless truncate-lines
4100 (let ((buffer (current-buffer)))
4101 (walk-windows (lambda (window)
4102 (if (eq buffer (window-buffer window))
4103 (set-window-hscroll window 0)))
4104 nil t)))
4105 (message "Truncate long lines %s"
4106 (if truncate-lines "enabled" "disabled")))
4108 (defvar overwrite-mode-textual " Ovwrt"
4109 "The string displayed in the mode line when in overwrite mode.")
4110 (defvar overwrite-mode-binary " Bin Ovwrt"
4111 "The string displayed in the mode line when in binary overwrite mode.")
4113 (defun overwrite-mode (arg)
4114 "Toggle overwrite mode.
4115 With arg, turn overwrite mode on iff arg is positive.
4116 In overwrite mode, printing characters typed in replace existing text
4117 on a one-for-one basis, rather than pushing it to the right. At the
4118 end of a line, such characters extend the line. Before a tab,
4119 such characters insert until the tab is filled in.
4121 is supposed to make it easier to insert characters when necessary."
4122 (interactive "P")
4123 (setq overwrite-mode
4124 (if (if (null arg) (not overwrite-mode)
4125 (> (prefix-numeric-value arg) 0))
4126 'overwrite-mode-textual))
4127 (force-mode-line-update))
4129 (defun binary-overwrite-mode (arg)
4130 "Toggle binary overwrite mode.
4131 With arg, turn binary overwrite mode on iff arg is positive.
4132 In binary overwrite mode, printing characters typed in replace
4133 existing text. Newlines are not treated specially, so typing at the
4134 end of a line joins the line to the next, with the typed character
4135 between them. Typing before a tab character simply replaces the tab
4136 with the character typed.
4138 typing characters do.
4140 Note that binary overwrite mode is not its own minor mode; it is a
4141 specialization of overwrite-mode, entered by setting the
4142 `overwrite-mode' variable to `overwrite-mode-binary'."
4143 (interactive "P")
4144 (setq overwrite-mode
4145 (if (if (null arg)
4146 (not (eq overwrite-mode 'overwrite-mode-binary))
4147 (> (prefix-numeric-value arg) 0))
4148 'overwrite-mode-binary))
4149 (force-mode-line-update))
4151 (define-minor-mode line-number-mode
4152 "Toggle Line Number mode.
4153 With arg, turn Line Number mode on iff arg is positive.
4154 When Line Number mode is enabled, the line number appears
4155 in the mode line.
4157 Line numbers do not appear for very large buffers and buffers
4158 with very long lines; see variables `line-number-display-limit'
4159 and `line-number-display-limit-width'."
4160 :init-value t :global t :group 'editing-basics :require nil)
4162 (define-minor-mode column-number-mode
4163 "Toggle Column Number mode.
4164 With arg, turn Column Number mode on iff arg is positive.
4165 When Column Number mode is enabled, the column number appears
4166 in the mode line."
4167 :global t :group 'editing-basics :require nil)
4169 (define-minor-mode size-indication-mode
4170 "Toggle Size Indication mode.
4171 With arg, turn Size Indication mode on iff arg is positive. When
4172 Size Indication mode is enabled, the size of the accessible part
4173 of the buffer appears in the mode line."
4174 :global t :group 'editing-basics :require nil)
4175 \f
4176 (defgroup paren-blinking nil
4177 "Blinking matching of parens and expressions."
4178 :prefix "blink-matching-"
4179 :group 'paren-matching)
4181 (defcustom blink-matching-paren t
4182 "*Non-nil means show matching open-paren when close-paren is inserted."
4183 :type 'boolean
4184 :group 'paren-blinking)
4186 (defcustom blink-matching-paren-on-screen t
4187 "*Non-nil means show matching open-paren when it is on screen.
4188 If nil, means don't show it (but the open-paren can still be shown
4189 when it is off screen)."
4190 :type 'boolean
4191 :group 'paren-blinking)
4193 (defcustom blink-matching-paren-distance (* 25 1024)
4194 "*If non-nil, is maximum distance to search for matching open-paren."
4195 :type 'integer
4196 :group 'paren-blinking)
4198 (defcustom blink-matching-delay 1
4199 "*Time in seconds to delay after showing a matching paren."
4200 :type 'number
4201 :group 'paren-blinking)
4203 (defcustom blink-matching-paren-dont-ignore-comments nil
4204 "*Non-nil means `blink-matching-paren' will not ignore comments."
4205 :type 'boolean
4206 :group 'paren-blinking)
4208 (defun blink-matching-open ()
4209 "Move cursor momentarily to the beginning of the sexp before point."
4210 (interactive)
4211 (and (> (point) (1+ (point-min)))
4212 blink-matching-paren
4213 ;; Verify an even number of quoting characters precede the close.
4214 (= 1 (logand 1 (- (point)
4215 (save-excursion
4216 (forward-char -1)
4218 (point)))))
4219 (let* ((oldpos (point))
4220 (blinkpos)
4221 (mismatch)
4222 matching-paren)
4223 (save-excursion
4224 (save-restriction
4225 (if blink-matching-paren-distance
4226 (narrow-to-region (max (point-min)
4227 (- (point) blink-matching-paren-distance))
4228 oldpos))
4229 (condition-case ()
4230 (let ((parse-sexp-ignore-comments
4231 (and parse-sexp-ignore-comments
4232 (not blink-matching-paren-dont-ignore-comments))))
4233 (setq blinkpos (scan-sexps oldpos -1)))
4234 (error nil)))
4235 (and blinkpos
4236 ;; Not syntax '$'.
4237 (not (eq (syntax-class (syntax-after blinkpos)) 8))
4238 (setq matching-paren
4239 (let ((syntax (syntax-after blinkpos)))
4240 (and (consp syntax)
4241 (eq (syntax-class syntax) 4)
4242 (cdr syntax)))
4243 mismatch
4244 (or (null matching-paren)
4245 (/= (char-after (1- oldpos))
4246 matching-paren))))
4247 (if mismatch (setq blinkpos nil))
4248 (if blinkpos
4249 ;; Don't log messages about paren matching.
4250 (let (message-log-max)
4251 (goto-char blinkpos)
4252 (if (pos-visible-in-window-p)
4253 (and blink-matching-paren-on-screen
4254 (sit-for blink-matching-delay))
4255 (goto-char blinkpos)
4256 (message
4257 "Matches %s"
4258 ;; Show what precedes the open in its line, if anything.
4259 (if (save-excursion
4261 (not (bolp)))
4262 (buffer-substring (progn (beginning-of-line) (point))
4263 (1+ blinkpos))
4264 ;; Show what follows the open in its line, if anything.
4265 (if (save-excursion
4266 (forward-char 1)
4268 (not (eolp)))
4269 (buffer-substring blinkpos
4270 (progn (end-of-line) (point)))
4271 ;; Otherwise show the previous nonblank line,
4272 ;; if there is one.
4273 (if (save-excursion
4275 (not (bobp)))
4276 (concat
4277 (buffer-substring (progn
4279 (beginning-of-line)
4280 (point))
4281 (progn (end-of-line)
4283 (point)))
4284 ;; Replace the newline and other whitespace with `...'.
4285 "..."
4286 (buffer-substring blinkpos (1+ blinkpos)))
4287 ;; There is nothing to show except the char itself.
4288 (buffer-substring blinkpos (1+ blinkpos))))))))
4289 (cond (mismatch
4290 (message "Mismatched parentheses"))
4291 ((not blink-matching-paren-distance)
4292 (message "Unmatched parenthesis"))))))))
4294 ;Turned off because it makes dbx bomb out.
4295 (setq blink-paren-function 'blink-matching-open)
4296 \f
4297 ;; This executes C-g typed while Emacs is waiting for a command.
4298 ;; Quitting out of a program does not go through here;
4299 ;; that happens in the QUIT macro at the C code level.
4300 (defun keyboard-quit ()
4301 "Signal a `quit' condition.
4302 During execution of Lisp code, this character causes a quit directly.
4303 At top-level, as an editor command, this simply beeps."
4304 (interactive)
4305 (deactivate-mark)
4306 (if (fboundp 'kmacro-keyboard-quit)
4307 (kmacro-keyboard-quit))
4308 (setq defining-kbd-macro nil)
4309 (signal 'quit nil))
4311 (defvar buffer-quit-function nil
4314 \(such as cancelling a prefix argument, minibuffer or region) do not apply.")
4316 (defun keyboard-escape-quit ()
4318 This command can exit an interactive command such as `query-replace',
4319 can clear out a prefix argument or a region,
4320 can get out of the minibuffer or other recursive edit,
4321 cancel the use of the current buffer (for special-purpose buffers),
4322 or go back to just one window (by deleting all but the selected window)."
4323 (interactive)
4324 (cond ((eq last-command 'mode-exited) nil)
4325 ((> (minibuffer-depth) 0)
4326 (abort-recursive-edit))
4327 (current-prefix-arg
4328 nil)
4329 ((and transient-mark-mode mark-active)
4330 (deactivate-mark))
4331 ((> (recursion-depth) 0)
4332 (exit-recursive-edit))
4333 (buffer-quit-function
4334 (funcall buffer-quit-function))
4335 ((not (one-window-p t))
4336 (delete-other-windows))
4338 (bury-buffer))))
4340 (defun play-sound-file (file &optional volume device)
4341 "Play sound stored in FILE.
4342 VOLUME and DEVICE correspond to the keywords of the sound
4343 specification for `play-sound'."
4344 (interactive "fPlay sound file: ")
4345 (let ((sound (list :file file)))
4346 (if volume
4347 (plist-put sound :volume volume))
4348 (if device
4349 (plist-put sound :device device))
4350 (push 'sound sound)
4351 (play-sound sound)))
4353 \f
4354 (defcustom read-mail-command 'rmail
4355 "*Your preference for a mail reading package.
4356 This is used by some keybindings which support reading mail.
4357 See also `mail-user-agent' concerning sending mail."
4358 :type '(choice (function-item rmail)
4359 (function-item gnus)
4360 (function-item mh-rmail)
4361 (function :tag "Other"))
4362 :version "21.1"
4363 :group 'mail)
4365 (defcustom mail-user-agent 'sendmail-user-agent
4366 "*Your preference for a mail composition package.
4367 Various Emacs Lisp packages (e.g. Reporter) require you to compose an
4368 outgoing email message. This variable lets you specify which
4369 mail-sending package you prefer.
4371 Valid values include:
4373 `sendmail-user-agent' -- use the default Emacs Mail package.
4374 See Info node `(emacs)Sending Mail'.
4375 `mh-e-user-agent' -- use the Emacs interface to the MH mail system.
4376 See Info node `(mh-e)'.
4377 `message-user-agent' -- use the Gnus Message package.
4378 See Info node `(message)'.
4379 `gnus-user-agent' -- like `message-user-agent', but with Gnus
4380 paraphernalia, particularly the Gcc: header for
4381 archiving.
4383 Additional valid symbols may be available; check with the author of
4384 your package for details. The function should return non-nil if it
4385 succeeds.
4387 See also `read-mail-command' concerning reading mail."
4388 :type '(radio (function-item :tag "Default Emacs mail"
4390 sendmail-user-agent)
4391 (function-item :tag "Emacs interface to MH"
4393 mh-e-user-agent)
4394 (function-item :tag "Gnus Message package"
4396 message-user-agent)
4397 (function-item :tag "Gnus Message with full Gnus features"
4399 gnus-user-agent)
4400 (function :tag "Other"))
4401 :group 'mail)
4403 (define-mail-user-agent 'sendmail-user-agent
4404 'sendmail-user-agent-compose
4405 'mail-send-and-exit)
4407 (defun rfc822-goto-eoh ()
4408 ;; Go to header delimiter line in a mail message, following RFC822 rules
4409 (goto-char (point-min))
4410 (when (re-search-forward
4412 (goto-char (match-beginning 0))))
4414 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
4415 switch-function yank-action
4416 send-actions)
4417 (if switch-function
4418 (let ((special-display-buffer-names nil)
4419 (special-display-regexps nil)
4420 (same-window-buffer-names nil)
4421 (same-window-regexps nil))
4422 (funcall switch-function "*mail*")))
4423 (let ((cc (cdr (assoc-string "cc" other-headers t)))
4424 (in-reply-to (cdr (assoc-string "in-reply-to" other-headers t)))
4425 (body (cdr (assoc-string "body" other-headers t))))
4426 (or (mail continue to subject in-reply-to cc yank-action send-actions)
4427 continue
4428 (error "Message aborted"))
4429 (save-excursion
4430 (rfc822-goto-eoh)
4431 (while other-headers
4432 (unless (member-ignore-case (car (car other-headers))
4433 '("in-reply-to" "cc" "body"))
4434 (insert (car (car other-headers)) ": "
4436 (setq other-headers (cdr other-headers)))
4437 (when body
4438 (forward-line 1)
4439 (insert body))
4440 t)))
4442 (define-mail-user-agent 'mh-e-user-agent
4443 'mh-smail-batch 'mh-send-letter 'mh-fully-kill-draft
4444 'mh-before-send-letter-hook)
4446 (defun compose-mail (&optional to subject other-headers continue
4447 switch-function yank-action send-actions)
4448 "Start composing a mail message to send.
4449 This uses the user's chosen mail composition package
4450 as selected with the variable `mail-user-agent'.
4451 The optional arguments TO and SUBJECT specify recipients
4452 and the initial Subject field, respectively.
4454 OTHER-HEADERS is an alist specifying additional
4455 header fields. Elements look like (HEADER . VALUE) where both
4456 HEADER and VALUE are strings.
4458 CONTINUE, if non-nil, says to continue editing a message already
4459 being composed.
4461 SWITCH-FUNCTION, if non-nil, is a function to use to
4462 switch to and display the buffer used for mail composition.
4464 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
4465 to insert the raw text of the message being replied to.
4466 It has the form (FUNCTION . ARGS). The user agent will apply
4467 FUNCTION to ARGS, to insert the raw text of the original message.
4468 \(The user agent will also run `mail-citation-hook', *after* the
4469 original text has been inserted in this way.)
4471 SEND-ACTIONS is a list of actions to call when the message is sent.
4472 Each action has the form (FUNCTION . ARGS)."
4473 (interactive
4474 (list nil nil nil current-prefix-arg))
4475 (let ((function (get mail-user-agent 'composefunc)))
4476 (funcall function to subject other-headers continue
4477 switch-function yank-action send-actions)))
4479 (defun compose-mail-other-window (&optional to subject other-headers continue
4480 yank-action send-actions)
4482 (interactive
4483 (list nil nil nil current-prefix-arg))
4484 (compose-mail to subject other-headers continue
4485 'switch-to-buffer-other-window yank-action send-actions))
4488 (defun compose-mail-other-frame (&optional to subject other-headers continue
4489 yank-action send-actions)
4491 (interactive
4492 (list nil nil nil current-prefix-arg))
4493 (compose-mail to subject other-headers continue
4494 'switch-to-buffer-other-frame yank-action send-actions))
4495 \f
4496 (defvar set-variable-value-history nil
4497 "History of values entered with `set-variable'.")
4499 (defun set-variable (var val &optional make-local)
4500 "Set VARIABLE to VALUE. VALUE is a Lisp object.
4501 When using this interactively, enter a Lisp object for VALUE.
4502 If you want VALUE to be a string, you must surround it with doublequotes.
4503 VALUE is used literally, not evaluated.
4505 If VARIABLE has a `variable-interactive' property, that is used as if
4506 it were the arg to `interactive' (which see) to interactively read VALUE.
4508 If VARIABLE has been defined with `defcustom', then the type information
4509 in the definition is used to check that VALUE is valid.
4511 With a prefix argument, set VARIABLE to VALUE buffer-locally."
4512 (interactive
4513 (let* ((default-var (variable-at-point))
4514 (var (if (symbolp default-var)
4515 (read-variable (format "Set variable (default %s): " default-var)
4516 default-var)
4517 (read-variable "Set variable: ")))
4518 (minibuffer-help-form '(describe-variable var))
4519 (prop (get var 'variable-interactive))
4520 (prompt (format "Set %s%s to value: " var
4521 (cond ((local-variable-p var)
4522 " (buffer-local)")
4523 ((or current-prefix-arg
4524 (local-variable-if-set-p var))
4525 " buffer-locally")
4526 (t " globally"))))
4527 (val (if prop
4528 ;; Use VAR's `variable-interactive' property
4529 ;; as an interactive spec for prompting.
4530 (call-interactively `(lambda (arg)
4531 (interactive ,prop)
4532 arg))
4533 (read
4534 (read-string prompt nil
4535 'set-variable-value-history)))))
4536 (list var val current-prefix-arg)))
4538 (and (custom-variable-p var)
4539 (not (get var 'custom-type))
4540 (custom-load-symbol var))
4541 (let ((type (get var 'custom-type)))
4542 (when type
4543 ;; Match with custom type.
4544 (require 'cus-edit)
4545 (setq type (widget-convert type))
4546 (unless (widget-apply type :match val)
4547 (error "Value `%S' does not match type %S of %S"
4548 val (car type) var))))
4550 (if make-local
4551 (make-local-variable var))
4553 (set var val)
4555 ;; Force a thorough redisplay for the case that the variable
4556 ;; has an effect on the display, like `tab-width' has.
4557 (force-mode-line-update))
4558 \f
4559 ;; Define the major mode for lists of completions.
4561 (defvar completion-list-mode-map nil
4562 "Local map for completion list buffers.")
4563 (or completion-list-mode-map
4564 (let ((map (make-sparse-keymap)))
4565 (define-key map [mouse-2] 'mouse-choose-completion)
4566 (define-key map [follow-link] 'mouse-face)
4567 (define-key map [down-mouse-2] nil)
4568 (define-key map "\C-m" 'choose-completion)
4569 (define-key map "\e\e\e" 'delete-completion-window)
4570 (define-key map [left] 'previous-completion)
4571 (define-key map [right] 'next-completion)
4572 (setq completion-list-mode-map map)))
4574 ;; Completion mode is suitable only for specially formatted data.
4575 (put 'completion-list-mode 'mode-class 'special)
4577 (defvar completion-reference-buffer nil
4578 "Record the buffer that was current when the completion list was requested.
4579 This is a local variable in the completion list buffer.
4580 Initial value is nil to avoid some compiler warnings.")
4582 (defvar completion-no-auto-exit nil
4583 "Non-nil means `choose-completion-string' should never exit the minibuffer.
4584 This also applies to other functions such as `choose-completion'
4585 and `mouse-choose-completion'.")
4587 (defvar completion-base-size nil
4588 "Number of chars at beginning of minibuffer not involved in completion.
4589 This is a local variable in the completion list buffer
4590 but it talks about the buffer in `completion-reference-buffer'.
4591 If this is nil, it means to compare text to determine which part
4592 of the tail end of the buffer's text is involved in completion.")
4594 (defun delete-completion-window ()
4595 "Delete the completion list window.
4596 Go to the window from which completion was requested."
4597 (interactive)
4598 (let ((buf completion-reference-buffer))
4599 (if (one-window-p t)
4600 (if (window-dedicated-p (selected-window))
4601 (delete-frame (selected-frame)))
4602 (delete-window (selected-window))
4603 (if (get-buffer-window buf)
4604 (select-window (get-buffer-window buf))))))
4606 (defun previous-completion (n)
4607 "Move to the previous item in the completion list."
4608 (interactive "p")
4609 (next-completion (- n)))
4611 (defun next-completion (n)
4612 "Move to the next item in the completion list.
4613 With prefix argument N, move N items (negative N means move backward)."
4614 (interactive "p")
4615 (let ((beg (point-min)) (end (point-max)))
4616 (while (and (> n 0) (not (eobp)))
4617 ;; If in a completion, move to the end of it.
4618 (when (get-text-property (point) 'mouse-face)
4619 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4620 ;; Move to start of next one.
4621 (unless (get-text-property (point) 'mouse-face)
4622 (goto-char (next-single-property-change (point) 'mouse-face nil end)))
4623 (setq n (1- n)))
4624 (while (and (< n 0) (not (bobp)))
4625 (let ((prop (get-text-property (1- (point)) 'mouse-face)))
4626 ;; If in a completion, move to the start of it.
4627 (when (and prop (eq prop (get-text-property (point) 'mouse-face)))
4628 (goto-char (previous-single-property-change
4629 (point) 'mouse-face nil beg)))
4630 ;; Move to end of the previous completion.
4631 (unless (or (bobp) (get-text-property (1- (point)) 'mouse-face))
4632 (goto-char (previous-single-property-change
4633 (point) 'mouse-face nil beg)))
4634 ;; Move to the start of that one.
4635 (goto-char (previous-single-property-change
4636 (point) 'mouse-face nil beg))
4637 (setq n (1+ n))))))
4639 (defun choose-completion ()
4640 "Choose the completion that point is in or next to."
4641 (interactive)
4642 (let (beg end completion (buffer completion-reference-buffer)
4643 (base-size completion-base-size))
4644 (if (and (not (eobp)) (get-text-property (point) 'mouse-face))
4645 (setq end (point) beg (1+ (point))))
4646 (if (and (not (bobp)) (get-text-property (1- (point)) 'mouse-face))
4647 (setq end (1- (point)) beg (point)))
4648 (if (null beg)
4649 (error "No completion here"))
4650 (setq beg (previous-single-property-change beg 'mouse-face))
4651 (setq end (or (next-single-property-change end 'mouse-face) (point-max)))
4652 (setq completion (buffer-substring beg end))
4653 (let ((owindow (selected-window)))
4654 (if (and (one-window-p t 'selected-frame)
4655 (window-dedicated-p (selected-window)))
4656 ;; This is a special buffer's frame
4657 (iconify-frame (selected-frame))
4658 (or (window-dedicated-p (selected-window))
4659 (bury-buffer)))
4660 (select-window owindow))
4661 (choose-completion-string completion buffer base-size)))
4663 ;; Delete the longest partial match for STRING
4664 ;; that can be found before POINT.
4665 (defun choose-completion-delete-max-match (string)
4666 (let ((opoint (point))
4667 len)
4668 ;; Try moving back by the length of the string.
4669 (goto-char (max (- (point) (length string))
4670 (minibuffer-prompt-end)))
4671 ;; See how far back we were actually able to move. That is the
4672 ;; upper bound on how much we can match and delete.
4673 (setq len (- opoint (point)))
4674 (if completion-ignore-case
4675 (setq string (downcase string)))
4676 (while (and (> len 0)
4677 (let ((tail (buffer-substring (point) opoint)))
4678 (if completion-ignore-case
4679 (setq tail (downcase tail)))
4680 (not (string= tail (substring string 0 len)))))
4681 (setq len (1- len))
4682 (forward-char 1))
4683 (delete-char len)))
4685 (defvar choose-completion-string-functions nil
4686 "Functions that may override the normal insertion of a completion choice.
4687 These functions are called in order with four arguments:
4688 CHOICE - the string to insert in the buffer,
4689 BUFFER - the buffer in which the choice should be inserted,
4690 MINI-P - non-nil iff BUFFER is a minibuffer, and
4691 BASE-SIZE - the number of characters in BUFFER before
4692 the string being completed.
4694 If a function in the list returns non-nil, that function is supposed
4695 to have inserted the CHOICE in the BUFFER, and possibly exited
4696 the minibuffer; no further functions will be called.
4698 If all functions in the list return nil, that means to use
4699 the default method of inserting the completion in BUFFER.")
4701 (defun choose-completion-string (choice &optional buffer base-size)
4702 "Switch to BUFFER and insert the completion choice CHOICE.
4703 BASE-SIZE, if non-nil, says how many characters of BUFFER's text
4704 to keep. If it is nil, we call `choose-completion-delete-max-match'
4705 to decide what to delete."
4707 ;; If BUFFER is the minibuffer, exit the minibuffer
4708 ;; unless it is reading a file name and CHOICE is a directory,
4709 ;; or completion-no-auto-exit is non-nil.
4711 (let* ((buffer (or buffer completion-reference-buffer))
4712 (mini-p (minibufferp buffer)))
4713 ;; If BUFFER is a minibuffer, barf unless it's the currently
4714 ;; active minibuffer.
4715 (if (and mini-p
4716 (or (not (active-minibuffer-window))
4717 (not (equal buffer
4718 (window-buffer (active-minibuffer-window))))))
4719 (error "Minibuffer is not active for completion")
4720 ;; Set buffer so buffer-local choose-completion-string-functions works.
4721 (set-buffer buffer)
4722 (unless (run-hook-with-args-until-success
4723 'choose-completion-string-functions
4724 choice buffer mini-p base-size)
4725 ;; Insert the completion into the buffer where it was requested.
4726 (if base-size
4727 (delete-region (+ base-size (if mini-p
4728 (minibuffer-prompt-end)
4729 (point-min)))
4730 (point))
4731 (choose-completion-delete-max-match choice))
4732 (insert choice)
4733 (remove-text-properties (- (point) (length choice)) (point)
4734 '(mouse-face nil))
4735 ;; Update point in the window that BUFFER is showing in.
4736 (let ((window (get-buffer-window buffer t)))
4737 (set-window-point window (point)))
4738 ;; If completing for the minibuffer, exit it with this choice.
4739 (and (not completion-no-auto-exit)
4740 (equal buffer (window-buffer (minibuffer-window)))
4741 minibuffer-completion-table
4742 ;; If this is reading a file name, and the file name chosen
4743 ;; is a directory, don't exit the minibuffer.
4744 (if (and (eq minibuffer-completion-table 'read-file-name-internal)
4745 (file-directory-p (field-string (point-max))))
4746 (let ((mini (active-minibuffer-window)))
4747 (select-window mini)
4748 (when minibuffer-auto-raise
4749 (raise-frame (window-frame mini))))
4750 (exit-minibuffer)))))))
4752 (defun completion-list-mode ()
4753 "Major mode for buffers showing lists of possible completions.
4755 to select the completion near point.
4757 with the mouse."
4758 (interactive)
4759 (kill-all-local-variables)
4760 (use-local-map completion-list-mode-map)
4761 (setq mode-name "Completion List")
4762 (setq major-mode 'completion-list-mode)
4763 (make-local-variable 'completion-base-size)
4764 (setq completion-base-size nil)
4765 (run-mode-hooks 'completion-list-mode-hook))
4767 (defun completion-list-mode-finish ()
4768 "Finish setup of the completions buffer.
4769 Called from `temp-buffer-show-hook'."
4770 (when (eq major-mode 'completion-list-mode)
4771 (toggle-read-only 1)))
4773 (add-hook 'temp-buffer-show-hook 'completion-list-mode-finish)
4775 (defvar completion-setup-hook nil
4776 "Normal hook run at the end of setting up a completion list buffer.
4777 When this hook is run, the current buffer is the one in which the
4778 command to display the completion list buffer was run.
4779 The completion list buffer is available as the value of `standard-output'.")
4781 ;; This function goes in completion-setup-hook, so that it is called
4782 ;; after the text of the completion list buffer is written.
4783 (defface completions-first-difference
4784 '((t (:inherit bold)))
4785 "Face put on the first uncommon character in completions in *Completions* buffer."
4786 :group 'completion)
4788 (defface completions-common-part
4789 '((t (:inherit default)))
4790 "Face put on the common prefix substring in completions in *Completions* buffer.
4791 The idea of `completions-common-part' is that you can use it to
4792 make the common parts less visible than normal, so that the rest
4793 of the differing parts is, by contrast, slightly highlighted."
4794 :group 'completion)
4796 ;; This is for packages that need to bind it to a non-default regexp
4797 ;; in order to make the first-differing character highlight work
4798 ;; to their liking
4799 (defvar completion-root-regexp "^/"
4800 "Regexp to use in `completion-setup-function' to find the root directory.")
4802 (defun completion-setup-function ()
4803 (let ((mainbuf (current-buffer))
4804 (mbuf-contents (minibuffer-contents)))
4805 ;; When reading a file name in the minibuffer,
4806 ;; set default-directory in the minibuffer
4807 ;; so it will get copied into the completion list buffer.
4808 (if minibuffer-completing-file-name
4809 (with-current-buffer mainbuf
4810 (setq default-directory (file-name-directory mbuf-contents))))
4811 ;; If partial-completion-mode is on, point might not be after the
4812 ;; last character in the minibuffer.
4813 ;; FIXME: This still doesn't work if the text to be completed
4814 ;; starts with a `-'.
4815 (when (and partial-completion-mode (not (eobp)))
4816 (setq mbuf-contents
4817 (substring mbuf-contents 0 (- (point) (point-max)))))
4818 (with-current-buffer standard-output
4819 (completion-list-mode)
4820 (make-local-variable 'completion-reference-buffer)
4821 (setq completion-reference-buffer mainbuf)
4822 (if minibuffer-completing-file-name
4823 ;; For file name completion,
4824 ;; use the number of chars before the start of the
4825 ;; last file name component.
4826 (setq completion-base-size
4827 (with-current-buffer mainbuf
4828 (save-excursion
4829 (goto-char (point-max))
4830 (skip-chars-backward completion-root-regexp)
4831 (- (point) (minibuffer-prompt-end)))))
4832 ;; Otherwise, in minibuffer, the whole input is being completed.
4833 (if (minibufferp mainbuf)
4834 (setq completion-base-size 0)))
4835 ;; Put faces on first uncommon characters and common parts.
4836 (when completion-base-size
4837 (let* ((common-string-length
4838 (- (length mbuf-contents) completion-base-size))
4839 (element-start (next-single-property-change
4840 (point-min)
4841 'mouse-face))
4842 (element-common-end
4843 (and element-start
4844 (+ (or element-start nil) common-string-length)))
4845 (maxp (point-max)))
4846 (while (and element-start (< element-common-end maxp))
4847 (when (and (get-char-property element-start 'mouse-face)
4848 (get-char-property element-common-end 'mouse-face))
4849 (put-text-property element-start element-common-end
4850 'font-lock-face 'completions-common-part)
4851 (put-text-property element-common-end (1+ element-common-end)
4852 'font-lock-face 'completions-first-difference))
4853 (setq element-start (next-single-property-change
4854 element-start
4855 'mouse-face))
4856 (if element-start
4857 (setq element-common-end (+ element-start common-string-length))))))
4858 ;; Insert help string.
4859 (goto-char (point-min))
4860 (if (display-mouse-p)
4861 (insert (substitute-command-keys
4863 (insert (substitute-command-keys
4867 (add-hook 'completion-setup-hook 'completion-setup-function)
4869 (define-key minibuffer-local-completion-map [prior]
4870 'switch-to-completions)
4871 (define-key minibuffer-local-must-match-map [prior]
4872 'switch-to-completions)
4873 (define-key minibuffer-local-completion-map "\M-v"
4874 'switch-to-completions)
4875 (define-key minibuffer-local-must-match-map "\M-v"
4876 'switch-to-completions)
4878 (defun switch-to-completions ()
4879 "Select the completion list window."
4880 (interactive)
4881 ;; Make sure we have a completions window.
4882 (or (get-buffer-window "*Completions*")
4883 (minibuffer-completion-help))
4884 (let ((window (get-buffer-window "*Completions*")))
4885 (when window
4886 (select-window window)
4887 (goto-char (point-min))
4889 (forward-line 1))))
4891 ;; Support keyboard commands to turn on various modifiers.
4893 ;; These functions -- which are not commands -- each add one modifier
4894 ;; to the following event.
4896 (defun event-apply-alt-modifier (ignore-prompt)
4899 (vector (event-apply-modifier (read-event) 'alt 22 "A-")))
4900 (defun event-apply-super-modifier (ignore-prompt)
4903 (vector (event-apply-modifier (read-event) 'super 23 "s-")))
4904 (defun event-apply-hyper-modifier (ignore-prompt)
4907 (vector (event-apply-modifier (read-event) 'hyper 24 "H-")))
4908 (defun event-apply-shift-modifier (ignore-prompt)
4911 (vector (event-apply-modifier (read-event) 'shift 25 "S-")))
4912 (defun event-apply-control-modifier (ignore-prompt)
4915 (vector (event-apply-modifier (read-event) 'control 26 "C-")))
4916 (defun event-apply-meta-modifier (ignore-prompt)
4919 (vector (event-apply-modifier (read-event) 'meta 27 "M-")))
4921 (defun event-apply-modifier (event symbol lshiftby prefix)
4922 "Apply a modifier flag to event EVENT.
4923 SYMBOL is the name of this modifier, as a symbol.
4924 LSHIFTBY is the numeric value of this modifier, in keyboard events.
4925 PREFIX is the string that represents this modifier in an event type symbol."
4926 (if (numberp event)
4927 (cond ((eq symbol 'control)
4928 (if (and (<= (downcase event) ?z)
4929 (>= (downcase event) ?a))
4930 (- (downcase event) ?a -1)
4931 (if (and (<= (downcase event) ?Z)
4932 (>= (downcase event) ?A))
4933 (- (downcase event) ?A -1)
4934 (logior (lsh 1 lshiftby) event))))
4935 ((eq symbol 'shift)
4936 (if (and (<= (downcase event) ?z)
4937 (>= (downcase event) ?a))
4938 (upcase event)
4939 (logior (lsh 1 lshiftby) event)))
4940 (t
4941 (logior (lsh 1 lshiftby) event)))
4942 (if (memq symbol (event-modifiers event))
4943 event
4944 (let ((event-type (if (symbolp event) event (car event))))
4945 (setq event-type (intern (concat prefix (symbol-name event-type))))
4946 (if (symbolp event)
4947 event-type
4948 (cons event-type (cdr event)))))))
4950 (define-key function-key-map [?\C-x ?@ ?h] 'event-apply-hyper-modifier)
4951 (define-key function-key-map [?\C-x ?@ ?s] 'event-apply-super-modifier)
4952 (define-key function-key-map [?\C-x ?@ ?m] 'event-apply-meta-modifier)
4953 (define-key function-key-map [?\C-x ?@ ?a] 'event-apply-alt-modifier)
4954 (define-key function-key-map [?\C-x ?@ ?S] 'event-apply-shift-modifier)
4955 (define-key function-key-map [?\C-x ?@ ?c] 'event-apply-control-modifier)
4957 ;;;; Keypad support.
4959 ;;; Make the keypad keys act like ordinary typing keys. If people add
4960 ;;; bindings for the function key symbols, then those bindings will
4961 ;;; override these, so this shouldn't interfere with any existing
4962 ;;; bindings.
4964 ;; Also tell read-char how to handle these keys.
4965 (mapc
4966 (lambda (keypad-normal)
4967 (let ((keypad (nth 0 keypad-normal))
4968 (normal (nth 1 keypad-normal)))
4969 (put keypad 'ascii-character normal)
4970 (define-key function-key-map (vector keypad) (vector normal))))
4971 '((kp-0 ?0) (kp-1 ?1) (kp-2 ?2) (kp-3 ?3) (kp-4 ?4)
4972 (kp-5 ?5) (kp-6 ?6) (kp-7 ?7) (kp-8 ?8) (kp-9 ?9)
4973 (kp-space ?\ )
4976 (kp-multiply ?*)
4977 (kp-add ?+)
4978 (kp-separator ?,)
4979 (kp-subtract ?-)
4980 (kp-decimal ?.)
4981 (kp-divide ?/)
4982 (kp-equal ?=)))
4983 \f
4984 ;;;;
4985 ;;;; forking a twin copy of a buffer.
4986 ;;;;
4988 (defvar clone-buffer-hook nil
4989 "Normal hook to run in the new buffer at the end of `clone-buffer'.")
4991 (defun clone-process (process &optional newname)
4992 "Create a twin copy of PROCESS.
4993 If NEWNAME is nil, it defaults to PROCESS' name;
4994 NEWNAME is modified by adding or incrementing <N> at the end as necessary.
4995 If PROCESS is associated with a buffer, the new process will be associated
4996 with the current buffer instead.
4997 Returns nil if PROCESS has already terminated."
4998 (setq newname (or newname (process-name process)))
5000 (setq newname (substring newname 0 (match-beginning 0))))
5001 (when (memq (process-status process) '(run stop open))
5002 (let* ((process-connection-type (process-tty-name process))
5003 (new-process
5004 (if (memq (process-status process) '(open))
5005 (let ((args (process-contact process t)))
5006 (setq args (plist-put args :name newname))
5007 (setq args (plist-put args :buffer
5008 (if (process-buffer process)
5009 (current-buffer))))
5010 (apply 'make-network-process args))
5011 (apply 'start-process newname
5012 (if (process-buffer process) (current-buffer))
5013 (process-command process)))))
5014 (set-process-query-on-exit-flag
5015 new-process (process-query-on-exit-flag process))
5016 (set-process-inherit-coding-system-flag
5017 new-process (process-inherit-coding-system-flag process))
5018 (set-process-filter new-process (process-filter process))
5019 (set-process-sentinel new-process (process-sentinel process))
5020 (set-process-plist new-process (copy-sequence (process-plist process)))
5021 new-process)))
5023 ;; things to maybe add (currently partly covered by `funcall mode'):
5024 ;; - syntax-table
5025 ;; - overlays
5026 (defun clone-buffer (&optional newname display-flag)
5027 "Create and return a twin copy of the current buffer.
5028 Unlike an indirect buffer, the new buffer can be edited
5029 independently of the old one (if it is not read-only).
5030 NEWNAME is the name of the new buffer. It may be modified by
5031 adding or incrementing <N> at the end as necessary to create a
5032 unique buffer name. If nil, it defaults to the name of the
5033 current buffer, with the proper suffix. If DISPLAY-FLAG is
5034 non-nil, the new buffer is shown with `pop-to-buffer'. Trying to
5035 clone a file-visiting buffer, or a buffer whose major mode symbol
5036 has a non-nil `no-clone' property, results in an error.
5038 Interactively, DISPLAY-FLAG is t and NEWNAME is the name of the
5039 current buffer with appropriate suffix. However, if a prefix
5040 argument is given, then the command prompts for NEWNAME in the
5041 minibuffer.
5043 This runs the normal hook `clone-buffer-hook' in the new buffer
5044 after it has been set up properly in other respects."
5045 (interactive
5046 (progn
5047 (if buffer-file-name
5048 (error "Cannot clone a file-visiting buffer"))
5049 (if (get major-mode 'no-clone)
5050 (error "Cannot clone a buffer in %s mode" mode-name))
5051 (list (if current-prefix-arg (read-string "Name: "))
5052 t)))
5053 (if buffer-file-name
5054 (error "Cannot clone a file-visiting buffer"))
5055 (if (get major-mode 'no-clone)
5056 (error "Cannot clone a buffer in %s mode" mode-name))
5057 (setq newname (or newname (buffer-name)))
5059 (setq newname (substring newname 0 (match-beginning 0))))
5060 (let ((buf (current-buffer))
5061 (ptmin (point-min))
5062 (ptmax (point-max))
5063 (pt (point))
5064 (mk (if mark-active (mark t)))
5065 (modified (buffer-modified-p))
5066 (mode major-mode)
5067 (lvars (buffer-local-variables))
5068 (process (get-buffer-process (current-buffer)))
5069 (new (generate-new-buffer (or newname (buffer-name)))))
5070 (save-restriction
5071 (widen)
5072 (with-current-buffer new
5073 (insert-buffer-substring buf)))
5074 (with-current-buffer new
5075 (narrow-to-region ptmin ptmax)
5076 (goto-char pt)
5077 (if mk (set-mark mk))
5078 (set-buffer-modified-p modified)
5080 ;; Clone the old buffer's process, if any.
5081 (when process (clone-process process))
5083 ;; Now set up the major mode.
5084 (funcall mode)
5086 ;; Set up other local variables.
5087 (mapcar (lambda (v)
5088 (condition-case () ;in case var is read-only
5089 (if (symbolp v)
5090 (makunbound v)
5091 (set (make-local-variable (car v)) (cdr v)))
5092 (error nil)))
5093 lvars)
5095 ;; Run any hooks (typically set up by the major mode
5096 ;; for cloning to work properly).
5097 (run-hooks 'clone-buffer-hook))
5098 (if display-flag (pop-to-buffer new))
5099 new))
5102 (defun clone-indirect-buffer (newname display-flag &optional norecord)
5103 "Create an indirect buffer that is a twin copy of the current buffer.
5105 Give the indirect buffer name NEWNAME. Interactively, read NEW-NAME
5106 from the minibuffer when invoked with a prefix arg. If NEWNAME is nil
5107 or if not called with a prefix arg, NEWNAME defaults to the current
5108 buffer's name. The name is modified by adding a `<N>' suffix to it
5109 or by incrementing the N in an existing suffix.
5111 DISPLAY-FLAG non-nil means show the new buffer with `pop-to-buffer'.
5112 This is always done when called interactively.
5114 Optional last arg NORECORD non-nil means do not put this buffer at the
5115 front of the list of recently selected ones."
5116 (interactive
5117 (progn
5118 (if (get major-mode 'no-clone-indirect)
5119 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5120 (list (if current-prefix-arg
5121 (read-string "BName of indirect buffer: "))
5122 t)))
5123 (if (get major-mode 'no-clone-indirect)
5124 (error "Cannot indirectly clone a buffer in %s mode" mode-name))
5125 (setq newname (or newname (buffer-name)))
5127 (setq newname (substring newname 0 (match-beginning 0))))
5128 (let* ((name (generate-new-buffer-name newname))
5129 (buffer (make-indirect-buffer (current-buffer) name t)))
5130 (when display-flag
5131 (pop-to-buffer buffer norecord))
5132 buffer))
5135 (defun clone-indirect-buffer-other-window (buffer &optional norecord)
5136 "Create an indirect buffer that is a twin copy of BUFFER.
5137 Select the new buffer in another window.
5138 Optional second arg NORECORD non-nil means do not put this buffer at
5139 the front of the list of recently selected ones."
5140 (interactive "bClone buffer in other window: ")
5141 (let ((pop-up-windows t))
5142 (set-buffer buffer)
5143 (clone-indirect-buffer nil t norecord)))
5145 \f
5146 ;;; Handling of Backspace and Delete keys.
5148 (defcustom normal-erase-is-backspace
5149 (and (not noninteractive)
5150 (or (memq system-type '(ms-dos windows-nt))
5151 (eq window-system 'mac)
5152 (and (memq window-system '(x))
5153 (fboundp 'x-backspace-delete-keys-p)
5154 (x-backspace-delete-keys-p))
5155 ;; If the terminal Emacs is running on has erase char
5156 ;; set to ^H, use the Backspace key for deleting
5157 ;; backward and, and the Delete key for deleting forward.
5158 (and (null window-system)
5159 (eq tty-erase-char ?\^H))))
5160 "If non-nil, Delete key deletes forward and Backspace key deletes backward.
5162 On window systems, the default value of this option is chosen
5163 according to the keyboard used. If the keyboard has both a Backspace
5164 key and a Delete key, and both are mapped to their usual meanings, the
5165 option's default value is set to t, so that Backspace can be used to
5166 delete backward, and Delete can be used to delete forward.
5168 If not running under a window system, customizing this option accomplishes
5169 a similar effect by mapping C-h, which is usually generated by the
5170 Backspace key, to DEL, and by mapping DEL to C-d via
5171 `keyboard-translate'. The former functionality of C-h is available on
5172 the F1 key. You should probably not use this setting if you don't
5173 have both Backspace, Delete and F1 keys.
5175 Setting this variable with setq doesn't take effect. Programmatically,
5176 call `normal-erase-is-backspace-mode' (which see) instead."
5177 :type 'boolean
5178 :group 'editing-basics
5179 :version "21.1"
5180 :set (lambda (symbol value)
5181 ;; The fboundp is because of a problem with :set when
5182 ;; dumping Emacs. It doesn't really matter.
5183 (if (fboundp 'normal-erase-is-backspace-mode)
5184 (normal-erase-is-backspace-mode (or value 0))
5185 (set-default symbol value))))
5188 (defun normal-erase-is-backspace-mode (&optional arg)
5189 "Toggle the Erase and Delete mode of the Backspace and Delete keys.
5191 With numeric arg, turn the mode on if and only if ARG is positive.
5193 On window systems, when this mode is on, Delete is mapped to C-d and
5194 Backspace is mapped to DEL; when this mode is off, both Delete and
5195 Backspace are mapped to DEL. (The remapping goes via
5196 `function-key-map', so binding Delete or Backspace in the global or
5197 local keymap will override that.)
5199 In addition, on window systems, the bindings of C-Delete, M-Delete,
5200 C-M-Delete, C-Backspace, M-Backspace, and C-M-Backspace are changed in
5201 the global keymap in accordance with the functionality of Delete and
5202 Backspace. For example, if Delete is remapped to C-d, which deletes
5203 forward, C-Delete is bound to `kill-word', but if Delete is remapped
5204 to DEL, which deletes backward, C-Delete is bound to
5205 `backward-kill-word'.
5207 If not running on a window system, a similar effect is accomplished by
5208 remapping C-h (normally produced by the Backspace key) and DEL via
5209 `keyboard-translate': if this mode is on, C-h is mapped to DEL and DEL
5210 to C-d; if it's off, the keys are not remapped.
5212 When not running on a window system, and this mode is turned on, the
5213 former functionality of C-h is available on the F1 key. You should
5214 probably not turn on this mode on a text-only terminal if you don't
5215 have both Backspace, Delete and F1 keys.
5217 See also `normal-erase-is-backspace'."
5218 (interactive "P")
5219 (setq normal-erase-is-backspace
5220 (if arg
5221 (> (prefix-numeric-value arg) 0)
5222 (not normal-erase-is-backspace)))
5224 (cond ((or (memq window-system '(x w32 mac pc))
5225 (memq system-type '(ms-dos windows-nt)))
5226 (let ((bindings
5227 `(([C-delete] [C-backspace])
5228 ([M-delete] [M-backspace])
5229 ([C-M-delete] [C-M-backspace])
5230 (,esc-map
5231 [C-delete] [C-backspace])))
5232 (old-state (lookup-key function-key-map [delete])))
5234 (if normal-erase-is-backspace
5235 (progn
5236 (define-key function-key-map [delete] [?\C-d])
5237 (define-key function-key-map [kp-delete] [?\C-d])
5238 (define-key function-key-map [backspace] [?\C-?]))
5239 (define-key function-key-map [delete] [?\C-?])
5240 (define-key function-key-map [kp-delete] [?\C-?])
5241 (define-key function-key-map [backspace] [?\C-?]))
5243 ;; Maybe swap bindings of C-delete and C-backspace, etc.
5244 (unless (equal old-state (lookup-key function-key-map [delete]))
5245 (dolist (binding bindings)
5246 (let ((map global-map))
5247 (when (keymapp (car binding))
5248 (setq map (car binding) binding (cdr binding)))
5249 (let* ((key1 (nth 0 binding))
5250 (key2 (nth 1 binding))
5251 (binding1 (lookup-key map key1))
5252 (binding2 (lookup-key map key2)))
5253 (define-key map key1 binding2)
5254 (define-key map key2 binding1)))))))
5255 (t
5256 (if normal-erase-is-backspace
5257 (progn
5258 (keyboard-translate ?\C-h ?\C-?)
5259 (keyboard-translate ?\C-? ?\C-d))
5260 (keyboard-translate ?\C-h ?\C-h)
5261 (keyboard-translate ?\C-? ?\C-?))))
5263 (run-hooks 'normal-erase-is-backspace-hook)
5264 (if (interactive-p)
5265 (message "Delete key deletes %s"
5266 (if normal-erase-is-backspace "forward" "backward"))))
5267 \f
5268 (defvar vis-mode-saved-buffer-invisibility-spec nil
5269 "Saved value of `buffer-invisibility-spec' when Visible mode is on.")
5271 (define-minor-mode visible-mode
5272 "Toggle Visible mode.
5273 With argument ARG turn Visible mode on iff ARG is positive.
5275 Enabling Visible mode makes all invisible text temporarily visible.
5276 Disabling Visible mode turns off that effect. Visible mode
5277 works by saving the value of `buffer-invisibility-spec' and setting it to nil."
5278 :lighter " Vis"
5279 :group 'editing-basics
5280 (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec)
5281 (setq buffer-invisibility-spec vis-mode-saved-buffer-invisibility-spec)
5282 (kill-local-variable 'vis-mode-saved-buffer-invisibility-spec))
5283 (when visible-mode
5284 (set (make-local-variable 'vis-mode-saved-buffer-invisibility-spec)
5285 buffer-invisibility-spec)
5286 (setq buffer-invisibility-spec nil)))
5287 \f
5288 ;; Minibuffer prompt stuff.
5290 ;(defun minibuffer-prompt-modification (start end)
5291 ; (error "You cannot modify the prompt"))
5292 ;
5293 ;
5294 ;(defun minibuffer-prompt-insertion (start end)
5295 ; (let ((inhibit-modification-hooks t))
5296 ; (delete-region start end)
5297 ; ;; Discard undo information for the text insertion itself
5298 ; ;; and for the text deletion.above.
5299 ; (when (consp buffer-undo-list)
5300 ; (setq buffer-undo-list (cddr buffer-undo-list)))
5301 ; (message "You cannot modify the prompt")))
5302 ;
5303 ;
5304 ;(setq minibuffer-prompt-properties
5305 ; (list 'modification-hooks '(minibuffer-prompt-modification)
5306 ; 'insert-in-front-hooks '(minibuffer-prompt-insertion)))
5307 ;
5309 (provide 'simple)
5311 ;; arch-tag: 24af67c0-2a49-44f6-b3b1-312d8b570dfd
5312 ;;; simple.el ends here