Initial revision
[chise/xemacs-chise.git.1] / lisp / simple.el
1 ;;; simple.el --- basic editing commands for XEmacs
2
3 ;; Copyright (C) 1985-7, 1993-5, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Tinker Systems and INS Engineering Corp.
5 ;; Copyright (C) 2000 Ben Wing.
6
7 ;; Maintainer: XEmacs Development Team
8 ;; Keywords: lisp, extensions, internal, dumped
9
10 ;; This file is part of XEmacs.
11
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; 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.
16
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20 ;; General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING.  If not, write to the Free
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
25 ;; 02111-1307, USA.
26
27 ;;; Synched up with: FSF 19.34 [But not very closely].
28
29 ;;; Commentary:
30
31 ;; This file is dumped with XEmacs.
32
33 ;; A grab-bag of basic XEmacs commands not specifically related to some
34 ;; major mode or to file-handling.
35
36 ;; Changes for zmacs-style active-regions:
37 ;;
38 ;; beginning-of-buffer, end-of-buffer, count-lines-region,
39 ;; count-lines-buffer, what-line, what-cursor-position, set-goal-column,
40 ;; set-fill-column, prefix-arg-internal, and line-move (which is used by
41 ;; next-line and previous-line) set zmacs-region-stays to t, so that they
42 ;; don't affect the current region-hilighting state.
43 ;;
44 ;; mark-whole-buffer, mark-word, exchange-point-and-mark, and
45 ;; set-mark-command (without an argument) call zmacs-activate-region.
46 ;;
47 ;; mark takes an optional arg like the new Fmark_marker() does.  When
48 ;; the region is not active, mark returns nil unless the optional arg is true.
49 ;;
50 ;; push-mark, pop-mark, exchange-point-and-mark, and set-marker, and
51 ;; set-mark-command use (mark t) so that they can access the mark whether
52 ;; the region is active or not.
53 ;;
54 ;; shell-command, shell-command-on-region, yank, and yank-pop (which all
55 ;; push a mark) have been altered to call exchange-point-and-mark with an
56 ;; argument, meaning "don't activate the region".  These commands  only use
57 ;; exchange-point-and-mark to position the newly-pushed mark correctly, so
58 ;; this isn't a user-visible change.  These functions have also been altered
59 ;; to use (mark t) for the same reason.
60
61 ;; 97/3/14 Jareth Hein (jhod@po.iijnet.or.jp) added kinsoku processing (support
62 ;; for filling of Asian text) into the fill code. This was ripped bleeding from
63 ;; Mule-2.3, and could probably use some feature additions (like additional wrap
64 ;; styles, etc)
65
66 ;; 97/06/11 Steve Baur (steve@xemacs.org) Convert use of
67 ;;  (preceding|following)-char to char-(after|before).
68
69 ;;; Code:
70
71 (defgroup editing-basics nil
72   "Most basic editing variables."
73   :group 'editing)
74
75 (defgroup killing nil
76   "Killing and yanking commands."
77   :group 'editing)
78
79 (defgroup fill-comments nil
80   "Indenting and filling of comments."
81   :prefix "comment-"
82   :group 'fill)
83
84 (defgroup paren-matching nil
85   "Highlight (un)matching of parens and expressions."
86   :prefix "paren-"
87   :group 'matching)
88
89 (defgroup log-message nil
90   "Messages logging and display customizations."
91   :group 'minibuffer)
92
93 (defgroup warnings nil
94   "Warnings customizations."
95   :group 'minibuffer)
96
97
98 (defcustom search-caps-disable-folding t
99   "*If non-nil, upper case chars disable case fold searching.
100 This does not apply to \"yanked\" strings."
101   :type 'boolean
102   :group 'editing-basics)
103
104 ;; This is stolen (and slightly modified) from FSF emacs's
105 ;; `isearch-no-upper-case-p'.
106 (defun no-upper-case-p (string &optional regexp-flag)
107   "Return t if there are no upper case chars in STRING.
108 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
109 since they have special meaning in a regexp."
110   (let ((case-fold-search nil))
111     (not (string-match (if regexp-flag
112                            "\\(^\\|\\\\\\\\\\|[^\\]\\)[A-Z]"
113                          "[A-Z]")
114                        string))
115     ))
116
117 (defmacro with-search-caps-disable-folding (string regexp-flag &rest body) "\
118 Eval BODY with `case-fold-search' let to nil if `search-caps-disable-folding'
119 is non-nil, and if STRING (either a string or a regular expression according
120 to REGEXP-FLAG) contains uppercase letters."
121   `(let ((case-fold-search
122           (if (and case-fold-search search-caps-disable-folding)
123               (no-upper-case-p ,string ,regexp-flag)
124             case-fold-search)))
125      ,@body))
126 (put 'with-search-caps-disable-folding 'lisp-indent-function 2)
127 (put 'with-search-caps-disable-folding 'edebug-form-spec
128      '(sexp sexp &rest form))
129
130 (defmacro with-interactive-search-caps-disable-folding (string regexp-flag
131                                                                &rest body)
132   "Same as `with-search-caps-disable-folding', but only in the case of a
133 function called interactively."
134   `(let ((case-fold-search
135           (if (and (interactive-p)
136                    case-fold-search search-caps-disable-folding)
137               (no-upper-case-p ,string ,regexp-flag)
138             case-fold-search)))
139      ,@body))
140 (put 'with-interactive-search-caps-disable-folding 'lisp-indent-function 2)
141 (put 'with-interactive-search-caps-disable-folding 'edebug-form-spec
142      '(sexp sexp &rest form))
143
144 (defun newline (&optional n)
145   "Insert a newline, and move to left margin of the new line if it's blank.
146 The newline is marked with the text-property `hard'.
147 With optional arg N, insert that many newlines.
148 In Auto Fill mode, if no numeric arg, break the preceding line if it's long."
149   (interactive "*P")
150   (barf-if-buffer-read-only nil (point))
151   ;; Inserting a newline at the end of a line produces better redisplay in
152   ;; try_window_id than inserting at the beginning of a line, and the textual
153   ;; result is the same.  So, if we're at beginning of line, pretend to be at
154   ;; the end of the previous line.
155   ;; #### Does this have any relevance in XEmacs?
156   (let ((flag (and (not (bobp))
157                    (bolp)
158                    ;; Make sure the newline before point isn't intangible.
159                    (not (get-char-property (1- (point)) 'intangible))
160                    ;; Make sure the newline before point isn't read-only.
161                    (not (get-char-property (1- (point)) 'read-only))
162                    ;; Make sure the newline before point isn't invisible.
163                    (not (get-char-property (1- (point)) 'invisible))
164                    ;; This should probably also test for the previous char
165                    ;;  being the *last* character too.
166                    (not (get-char-property (1- (point)) 'end-open))
167                    ;; Make sure the newline before point has the same
168                    ;; properties as the char before it (if any).
169                    (< (or (previous-extent-change (point)) -2)
170                       (- (point) 2))))
171         (was-page-start (and (bolp)
172                              (looking-at page-delimiter)))
173         (beforepos (point)))
174     (if flag (backward-char 1))
175     ;; Call self-insert so that auto-fill, abbrev expansion etc. happens.
176     ;; Set last-command-char to tell self-insert what to insert.
177     (let ((last-command-char ?\n)
178           ;; Don't auto-fill if we have a numeric argument.
179           ;; Also not if flag is true (it would fill wrong line);
180           ;; there is no need to since we're at BOL.
181           (auto-fill-function (if (or n flag) nil auto-fill-function)))
182       (unwind-protect
183           (self-insert-command (prefix-numeric-value n))
184         ;; If we get an error in self-insert-command, put point at right place.
185         (if flag (forward-char 1))))
186     ;; If we did *not* get an error, cancel that forward-char.
187     (if flag (backward-char 1))
188     ;; Mark the newline(s) `hard'.
189     (if use-hard-newlines
190         (let* ((from (- (point) (if n (prefix-numeric-value n) 1)))
191                (sticky (get-text-property from 'end-open))) ; XEmacs
192           (put-text-property from (point) 'hard 't)
193           ;; If end-open is not "t", add 'hard to end-open list
194           (if (and (listp sticky) (not (memq 'hard sticky)))
195               (put-text-property from (point) 'end-open ; XEmacs
196                                  (cons 'hard sticky)))))
197     ;; If the newline leaves the previous line blank,
198     ;; and we have a left margin, delete that from the blank line.
199     (or flag
200         (save-excursion
201           (goto-char beforepos)
202           (beginning-of-line)
203           (and (looking-at "[ \t]$")
204                (> (current-left-margin) 0)
205                (delete-region (point) (progn (end-of-line) (point))))))
206     (if flag (forward-char 1))
207     ;; Indent the line after the newline, except in one case:
208     ;; when we added the newline at the beginning of a line
209     ;; which starts a page.
210     (or was-page-start
211         (move-to-left-margin nil t)))
212   nil)
213
214 (defun set-hard-newline-properties (from to)
215   (let ((sticky (get-text-property from 'rear-nonsticky)))
216     (put-text-property from to 'hard 't)
217     ;; If rear-nonsticky is not "t", add 'hard to rear-nonsticky list
218     (if (and (listp sticky) (not (memq 'hard sticky)))
219         (put-text-property from (point) 'rear-nonsticky
220                            (cons 'hard sticky)))))
221
222 (defun open-line (n)
223   "Insert a newline and leave point before it.
224 If there is a fill prefix and/or a left-margin, insert them on the new line
225 if the line would have been blank.
226 With arg N, insert N newlines."
227   (interactive "*p")
228   (let* ((do-fill-prefix (and fill-prefix (bolp)))
229          (do-left-margin (and (bolp) (> (current-left-margin) 0)))
230          (loc (point)))
231     (newline n)
232     (goto-char loc)
233     (while (> n 0)
234       (cond ((bolp)
235              (if do-left-margin (indent-to (current-left-margin)))
236              (if do-fill-prefix (insert fill-prefix))))
237       (forward-line 1)
238       (setq n (1- n)))
239     (goto-char loc)
240     (end-of-line)))
241
242 (defun split-line ()
243   "Split current line, moving portion beyond point vertically down."
244   (interactive "*")
245   (skip-chars-forward " \t")
246   (let ((col (current-column))
247         (pos (point)))
248     (newline 1)
249     (indent-to col 0)
250     (goto-char pos)))
251
252 (defun quoted-insert (arg)
253   "Read next input character and insert it.
254 This is useful for inserting control characters.
255 You may also type up to 3 octal digits, to insert a character with that code.
256
257 In overwrite mode, this function inserts the character anyway, and
258 does not handle octal digits specially.  This means that if you use
259 overwrite as your normal editing mode, you can use this function to
260 insert characters when necessary.
261
262 In binary overwrite mode, this function does overwrite, and octal
263 digits are interpreted as a character code.  This is supposed to make
264 this function useful in editing binary files."
265   (interactive "*p")
266   (let ((char (if (or (not overwrite-mode)
267                       (eq overwrite-mode 'overwrite-mode-binary))
268                   (read-quoted-char)
269                 ;; read-char obeys C-g, so we should protect.  FSF
270                 ;; doesn't have the protection here, but it's a bug in
271                 ;; FSF.
272                 (let ((inhibit-quit t))
273                   (read-char)))))
274     (if (> arg 0)
275         (if (eq overwrite-mode 'overwrite-mode-binary)
276             (delete-char arg)))
277     (while (> arg 0)
278       (insert char)
279       (setq arg (1- arg)))))
280
281 (defun delete-indentation (&optional arg)
282   "Join this line to previous and fix up whitespace at join.
283 If there is a fill prefix, delete it from the beginning of this line.
284 With argument, join this line to following line."
285   (interactive "*P")
286   (beginning-of-line)
287   (if arg (forward-line 1))
288   (if (eq (char-before (point)) ?\n)
289       (progn
290         (delete-region (point) (1- (point)))
291         ;; If the second line started with the fill prefix,
292         ;; delete the prefix.
293         (if (and fill-prefix
294                  (<= (+ (point) (length fill-prefix)) (point-max))
295                  (string= fill-prefix
296                           (buffer-substring (point)
297                                             (+ (point) (length fill-prefix)))))
298             (delete-region (point) (+ (point) (length fill-prefix))))
299         (fixup-whitespace))))
300
301 (defun fixup-whitespace ()
302   "Fixup white space between objects around point.
303 Leave one space or none, according to the context."
304   (interactive "*")
305   (save-excursion
306     (delete-horizontal-space)
307     (if (or (looking-at "^\\|\\s)")
308             (save-excursion (backward-char 1)
309                             (looking-at "$\\|\\s(\\|\\s'")))
310         nil
311       (insert ?\ ))))
312
313 (defun delete-horizontal-space ()
314   "Delete all spaces and tabs around point."
315   (interactive "*")
316   (skip-chars-backward " \t")
317   (delete-region (point) (progn (skip-chars-forward " \t") (point))))
318
319 (defun just-one-space ()
320   "Delete all spaces and tabs around point, leaving one space."
321   (interactive "*")
322   (if abbrev-mode ; XEmacs
323       (expand-abbrev))
324   (skip-chars-backward " \t")
325   (if (eq (char-after (point)) ? ) ; XEmacs
326       (forward-char 1)
327     (insert ? ))
328   (delete-region (point) (progn (skip-chars-forward " \t") (point))))
329
330 (defun delete-blank-lines ()
331   "On blank line, delete all surrounding blank lines, leaving just one.
332 On isolated blank line, delete that one.
333 On nonblank line, delete any immediately following blank lines."
334   (interactive "*")
335   (let (thisblank singleblank)
336     (save-excursion
337       (beginning-of-line)
338       (setq thisblank (looking-at "[ \t]*$"))
339       ;; Set singleblank if there is just one blank line here.
340       (setq singleblank
341             (and thisblank
342                  (not (looking-at "[ \t]*\n[ \t]*$"))
343                  (or (bobp)
344                      (progn (forward-line -1)
345                             (not (looking-at "[ \t]*$")))))))
346     ;; Delete preceding blank lines, and this one too if it's the only one.
347     (if thisblank
348         (progn
349           (beginning-of-line)
350           (if singleblank (forward-line 1))
351           (delete-region (point)
352                          (if (re-search-backward "[^ \t\n]" nil t)
353                              (progn (forward-line 1) (point))
354                            (point-min)))))
355     ;; Delete following blank lines, unless the current line is blank
356     ;; and there are no following blank lines.
357     (if (not (and thisblank singleblank))
358         (save-excursion
359           (end-of-line)
360           (forward-line 1)
361           (delete-region (point)
362                          (if (re-search-forward "[^ \t\n]" nil t)
363                              (progn (beginning-of-line) (point))
364                            (point-max)))))
365     ;; Handle the special case where point is followed by newline and eob.
366     ;; Delete the line, leaving point at eob.
367     (if (looking-at "^[ \t]*\n\\'")
368         (delete-region (point) (point-max)))))
369
370 (defun back-to-indentation ()
371   "Move point to the first non-whitespace character on this line."
372   ;; XEmacs change
373   (interactive "_")
374   (beginning-of-line 1)
375   (skip-chars-forward " \t"))
376
377 (defun newline-and-indent ()
378   "Insert a newline, then indent according to major mode.
379 Indentation is done using the value of `indent-line-function'.
380 In programming language modes, this is the same as TAB.
381 In some text modes, where TAB inserts a tab, this command indents to the
382 column specified by the function `current-left-margin'."
383   (interactive "*")
384   (delete-region (point) (progn (skip-chars-backward " \t") (point)))
385   (newline)
386   (indent-according-to-mode))
387
388 (defun reindent-then-newline-and-indent ()
389   "Reindent current line, insert newline, then indent the new line.
390 Indentation of both lines is done according to the current major mode,
391 which means calling the current value of `indent-line-function'.
392 In programming language modes, this is the same as TAB.
393 In some text modes, where TAB inserts a tab, this indents to the
394 column specified by the function `current-left-margin'."
395   (interactive "*")
396   (save-excursion
397     (delete-region (point) (progn (skip-chars-backward " \t") (point)))
398     (indent-according-to-mode))
399   (newline)
400   (indent-according-to-mode))
401
402 ;; Internal subroutine of delete-char
403 (defun kill-forward-chars (arg)
404   (if (listp arg) (setq arg (car arg)))
405   (if (eq arg '-) (setq arg -1))
406   (kill-region (point) (+ (point) arg)))
407
408 ;; Internal subroutine of backward-delete-char
409 (defun kill-backward-chars (arg)
410   (if (listp arg) (setq arg (car arg)))
411   (if (eq arg '-) (setq arg -1))
412   (kill-region (point) (- (point) arg)))
413
414 (defun backward-delete-char-untabify (arg &optional killp)
415   "Delete characters backward, changing tabs into spaces.
416 Delete ARG chars, and kill (save in kill ring) if KILLP is non-nil.
417 Interactively, ARG is the prefix arg (default 1)
418 and KILLP is t if a prefix arg was specified."
419   (interactive "*p\nP")
420   (let ((count arg))
421     (save-excursion
422       (while (and (> count 0) (not (bobp)))
423         (if (eq (char-before (point)) ?\t) ; XEmacs
424             (let ((col (current-column)))
425               (backward-char 1)
426               (setq col (- col (current-column)))
427               (insert-char ?\ col)
428               (delete-char 1)))
429         (backward-char 1)
430         (setq count (1- count)))))
431   (delete-backward-char arg killp)
432   ;; XEmacs: In overwrite mode, back over columns while clearing them out,
433   ;; unless at end of line.
434   (and overwrite-mode (not (eolp))
435        (save-excursion (insert-char ?\  arg))))
436
437 (defcustom delete-key-deletes-forward t
438   "*If non-nil, the DEL key will erase one character forwards.
439 If nil, the DEL key will erase one character backwards."
440   :type 'boolean
441   :group 'editing-basics)
442
443 (defcustom backward-delete-function 'delete-backward-char
444   "*Function called to delete backwards on a delete keypress.
445 If `delete-key-deletes-forward' is nil, `backward-or-forward-delete-char'
446 calls this function to erase one character backwards.  Default value
447 is `delete-backward-char', with `backward-delete-char-untabify' being a
448 popular alternate setting."
449   :type 'function
450   :group 'editing-basics)
451
452 ;; Trash me, baby.
453 (defsubst delete-forward-p ()
454   (and delete-key-deletes-forward
455        (or (not (eq (device-type) 'x))
456            (x-keysym-on-keyboard-sans-modifiers-p 'backspace))))
457
458 (defun backward-or-forward-delete-char (arg)
459   "Delete either one character backwards or one character forwards.
460 Controlled by the state of `delete-key-deletes-forward' and whether the
461 BackSpace keysym even exists on your keyboard.  If you don't have a
462 BackSpace keysym, the delete key should always delete one character
463 backwards."
464   (interactive "*p")
465   (if (delete-forward-p)
466       (delete-char arg)
467     (funcall backward-delete-function arg)))
468
469 (defun backward-or-forward-kill-word (arg)
470   "Delete either one word backwards or one word forwards.
471 Controlled by the state of `delete-key-deletes-forward' and whether the
472 BackSpace keysym even exists on your keyboard.  If you don't have a
473 BackSpace keysym, the delete key should always delete one character
474 backwards."
475   (interactive "*p")
476   (if (delete-forward-p)
477       (kill-word arg)
478     (backward-kill-word arg)))
479
480 (defun backward-or-forward-kill-sentence (arg)
481     "Delete either one sentence backwards or one sentence forwards.
482 Controlled by the state of `delete-key-deletes-forward' and whether the
483 BackSpace keysym even exists on your keyboard.  If you don't have a
484 BackSpace keysym, the delete key should always delete one character
485 backwards."
486   (interactive "*P")
487   (if (delete-forward-p)
488       (kill-sentence arg)
489     (backward-kill-sentence (prefix-numeric-value arg))))
490
491 (defun backward-or-forward-kill-sexp (arg)
492     "Delete either one sexpr backwards or one sexpr forwards.
493 Controlled by the state of `delete-key-deletes-forward' and whether the
494 BackSpace keysym even exists on your keyboard.  If you don't have a
495 BackSpace keysym, the delete key should always delete one character
496 backwards."
497   (interactive "*p")
498   (if (delete-forward-p)
499       (kill-sexp arg)
500     (backward-kill-sexp arg)))
501
502 (defun zap-to-char (arg char)
503   "Kill up to and including ARG'th occurrence of CHAR.
504 Goes backward if ARG is negative; error if CHAR not found."
505   (interactive "*p\ncZap to char: ")
506   (kill-region (point) (with-interactive-search-caps-disable-folding
507                            (char-to-string char) nil
508                          (search-forward (char-to-string char) nil nil arg)
509                          (point))))
510
511 (defun zap-up-to-char (arg char)
512   "Kill up to ARG'th occurrence of CHAR.
513 Goes backward if ARG is negative; error if CHAR not found."
514   (interactive "*p\ncZap up to char: ")
515   (kill-region (point) (with-interactive-search-caps-disable-folding
516                            (char-to-string char) nil
517                          (search-forward (char-to-string char) nil nil arg)
518                          (goto-char (if (> arg 0) (1- (point)) (1+ (point))))
519                          (point))))
520
521 (defun beginning-of-buffer (&optional arg)
522   "Move point to the beginning of the buffer; leave mark at previous position.
523 With arg N, put point N/10 of the way from the beginning.
524
525 If the buffer is narrowed, this command uses the beginning and size
526 of the accessible part of the buffer.
527
528 The characters that are moved over may be added to the current selection
529 \(i.e. active region) if the Shift key is held down, a motion key is used
530 to invoke this command, and `shifted-motion-keys-select-region' is t; see
531 the documentation for this variable for more details.
532
533 Don't use this command in Lisp programs!
534 \(goto-char (point-min)) is faster and avoids clobbering the mark."
535   ;; XEmacs change
536   (interactive "_P")
537   (push-mark)
538   (let ((size (- (point-max) (point-min))))
539     (goto-char (if arg
540                    (+ (point-min)
541                       (if (> size 10000)
542                           ;; Avoid overflow for large buffer sizes!
543                           (* (prefix-numeric-value arg)
544                              (/ size 10))
545                         (/ (+ 10 (* size (prefix-numeric-value arg))) 10)))
546                  (point-min))))
547   (if arg (forward-line 1)))
548
549 (defun end-of-buffer (&optional arg)
550   "Move point to the end of the buffer; leave mark at previous position.
551 With arg N, put point N/10 of the way from the end.
552
553 If the buffer is narrowed, this command uses the beginning and size
554 of the accessible part of the buffer.
555
556 The characters that are moved over may be added to the current selection
557 \(i.e. active region) if the Shift key is held down, a motion key is used
558 to invoke this command, and `shifted-motion-keys-select-region' is t; see
559 the documentation for this variable for more details.
560
561 Don't use this command in Lisp programs!
562 \(goto-char (point-max)) is faster and avoids clobbering the mark."
563   ;; XEmacs change
564   (interactive "_P")
565   (push-mark)
566   ;; XEmacs changes here.
567   (let ((scroll-to-end (not (pos-visible-in-window-p (point-max))))
568         (size (- (point-max) (point-min))))
569     (goto-char (if arg
570                    (- (point-max)
571                       (if (> size 10000)
572                           ;; Avoid overflow for large buffer sizes!
573                           (* (prefix-numeric-value arg)
574                              (/ size 10))
575                         (/ (* size (prefix-numeric-value arg)) 10)))
576                  (point-max)))
577     (cond (arg
578            ;; If we went to a place in the middle of the buffer,
579            ;; adjust it to the beginning of a line.
580            (forward-line 1))
581           ;; XEmacs change
582           (scroll-to-end
583            ;; If the end of the buffer is not already on the screen,
584            ;; then scroll specially to put it near, but not at, the bottom.
585            (recenter -3)))))
586
587 ;; XEmacs (not in FSF)
588 (defun mark-beginning-of-buffer (&optional arg)
589   "Push a mark at the beginning of the buffer; leave point where it is.
590 With arg N, push mark N/10 of the way from the true beginning."
591   (interactive "P")
592   (push-mark (if arg
593                  (if (> (buffer-size) 10000)
594                      ;; Avoid overflow for large buffer sizes!
595                      (* (prefix-numeric-value arg)
596                         (/ (buffer-size) 10))
597                    (/ (+ 10 (* (buffer-size) (prefix-numeric-value arg))) 10))
598                (point-min))
599              nil
600              t))
601 (define-function 'mark-bob 'mark-beginning-of-buffer)
602
603 ;; XEmacs (not in FSF)
604 (defun mark-end-of-buffer (&optional arg)
605   "Push a mark at the end of the buffer; leave point where it is.
606 With arg N, push mark N/10 of the way from the true end."
607   (interactive "P")
608   (push-mark (if arg
609                  (- (1+ (buffer-size))
610                     (if (> (buffer-size) 10000)
611                         ;; Avoid overflow for large buffer sizes!
612                         (* (prefix-numeric-value arg)
613                            (/ (buffer-size) 10))
614                       (/ (* (buffer-size) (prefix-numeric-value arg)) 10)))
615                  (point-max))
616              nil
617              t))
618 (define-function 'mark-eob 'mark-end-of-buffer)
619
620 (defun mark-whole-buffer ()
621   "Put point at beginning and mark at end of buffer.
622 You probably should not use this function in Lisp programs;
623 it is usually a mistake for a Lisp function to use any subroutine
624 that uses or sets the mark."
625   (interactive)
626   (push-mark (point))
627   (push-mark (point-max) nil t)
628   (goto-char (point-min)))
629
630 ;; XEmacs
631 (defun eval-current-buffer (&optional printflag)
632   "Evaluate the current buffer as Lisp code.
633 Programs can pass argument PRINTFLAG which controls printing of output:
634 nil means discard it; anything else is stream for print."
635   (interactive)
636   (eval-buffer (current-buffer) printflag))
637
638 ;; XEmacs
639 (defun count-words-buffer (&optional buffer)
640   "Print the number of words in BUFFER.
641 If called noninteractively, the value is returned rather than printed.
642 BUFFER defaults to the current buffer."
643   (interactive)
644   (let ((words (count-words-region (point-min) (point-max) buffer)))
645     (when (interactive-p)
646       (message "Buffer has %d words" words))
647     words))
648
649 ;; XEmacs
650 (defun count-words-region (start end &optional buffer)
651   "Print the number of words in region between START and END in BUFFER.
652 If called noninteractively, the value is returned rather than printed.
653 BUFFER defaults to the current buffer."
654   (interactive "_r")
655   (save-excursion
656     (set-buffer (or buffer (current-buffer)))
657     (let ((words 0))
658       (goto-char start)
659       (while (< (point) end)
660         (when (forward-word 1)
661           (incf words)))
662       (when  (interactive-p)
663         (message "Region has %d words" words))
664       words)))
665
666 (defun count-lines-region (start end)
667   "Print number of lines and characters in the region."
668   ;; XEmacs change
669   (interactive "_r")
670   (message "Region has %d lines, %d characters"
671            (count-lines start end) (- end start)))
672
673 ;; XEmacs
674 (defun count-lines-buffer (&optional buffer)
675   "Print number of lines and characters in BUFFER."
676   (interactive)
677   (with-current-buffer (or buffer (current-buffer))
678     (let ((cnt (count-lines (point-min) (point-max))))
679       (message "Buffer has %d lines, %d characters"
680                cnt (- (point-max) (point-min)))
681       cnt)))
682
683 ;;; Modified by Bob Weiner, 8/24/95, to print narrowed line number also.
684 ;;; Expanded by Bob Weiner, BeOpen, on 02/12/1997
685 (defun what-line ()
686   "Print the following variants of the line number of point:
687      Region line     - displayed line within the active region
688      Collapsed line  - includes only selectively displayed lines;
689      Buffer line     - physical line in the buffer;
690      Narrowed line   - line number from the start of the buffer narrowing."
691   ;; XEmacs change
692   (interactive "_")
693   (let ((opoint (point)) start)
694     (save-excursion
695       (save-restriction
696         (if (region-active-p)
697             (goto-char (region-beginning))
698           (goto-char (point-min)))
699         (widen)
700         (beginning-of-line)
701         (setq start (point))
702         (goto-char opoint)
703         (beginning-of-line)
704         (let* ((buffer-line (1+ (count-lines 1 (point))))
705                (narrowed-p (or (/= start 1)
706                                (/= (point-max) (1+ (buffer-size)))))
707                (narrowed-line (if narrowed-p (1+ (count-lines start (point)))))
708                (selective-line (if selective-display
709                                    (1+ (count-lines start (point) t))))
710                (region-line (if (region-active-p)
711                                 (1+ (count-lines start (point) selective-display)))))
712           (cond (region-line
713                  (message "Region line %d; Buffer line %d"
714                           region-line buffer-line))
715                 ((and narrowed-p selective-line (/= selective-line narrowed-line))
716                  ;; buffer narrowed and some lines selectively displayed
717                  (message "Collapsed line %d; Buffer line %d; Narrowed line %d"
718                           selective-line buffer-line narrowed-line))
719                 (narrowed-p
720                  ;; buffer narrowed
721                  (message "Buffer line %d; Narrowed line %d"
722                           buffer-line narrowed-line))
723                 ((and selective-line (/= selective-line buffer-line))
724                  ;; some lines selectively displayed
725                  (message "Collapsed line %d; Buffer line %d"
726                           selective-line buffer-line))
727                 (t
728                  ;; give a basic line count
729                  (message "Line %d" buffer-line)))))))
730   (setq zmacs-region-stays t))
731
732 ;; new in XEmacs 21.2 (not in FSF).
733 (defun line-number (&optional pos respect-narrowing)
734   "Return the line number of POS (defaults to point).
735 If RESPECT-NARROWING is non-nil, then the narrowed line number is returned;
736 otherwise, the absolute line number is returned.  The returned line can always
737 be given to `goto-line' to get back to the current line."
738   (if (and pos (/= pos (point)))
739       (save-excursion
740         (goto-char pos)
741         (line-number nil respect-narrowing))
742     (1+ (count-lines (if respect-narrowing (point-min) 1) (point-at-bol)))))
743
744 (defun count-lines (start end &optional ignore-invisible-lines-flag)
745   "Return number of lines between START and END.
746 This is usually the number of newlines between them,
747 but can be one more if START is not equal to END
748 and the greater of them is not at the start of a line.
749
750 With optional IGNORE-INVISIBLE-LINES-FLAG non-nil, lines collapsed with
751 selective-display are excluded from the line count.
752
753 NOTE: The expression to return the current line number is not obvious:
754
755 (1+ (count-lines 1 (point-at-bol)))
756
757 See also `line-number'."
758   (save-excursion
759     (save-restriction
760       (narrow-to-region start end)
761       (goto-char (point-min))
762       (if (and (not ignore-invisible-lines-flag) (eq selective-display t))
763           (save-match-data
764             (let ((done 0))
765               (while (re-search-forward "[\n\C-m]" nil t 40)
766                 (setq done (+ 40 done)))
767               (while (re-search-forward "[\n\C-m]" nil t 1)
768                 (setq done (+ 1 done)))
769               (goto-char (point-max))
770               (if (and (/= start end)
771                        (not (bolp)))
772                   (1+ done)
773                 done)))
774         (- (buffer-size) (forward-line (buffer-size)))))))
775
776 (defun what-cursor-position ()
777   "Print info on cursor position (on screen and within buffer)."
778   ;; XEmacs change
779   (interactive "_")
780   (let* ((char (char-after (point))) ; XEmacs
781          (beg (point-min))
782          (end (point-max))
783          (pos (point))
784          (total (buffer-size))
785          (percent (if (> total 50000)
786                       ;; Avoid overflow from multiplying by 100!
787                       (/ (+ (/ total 200) (1- pos)) (max (/ total 100) 1))
788                     (/ (+ (/ total 2) (* 100 (1- pos))) (max total 1))))
789          (hscroll (if (= (window-hscroll) 0)
790                       ""
791                     (format " Hscroll=%d" (window-hscroll))))
792          (col (+ (current-column) (if column-number-start-at-one 1 0))))
793     (if (= pos end)
794         (if (or (/= beg 1) (/= end (1+ total)))
795             (message "point=%d of %d(%d%%) <%d - %d>  column %d %s"
796                      pos total percent beg end col hscroll)
797           (message "point=%d of %d(%d%%)  column %d %s"
798                    pos total percent col hscroll))
799       ;; XEmacs: don't use single-key-description
800       (if (or (/= beg 1) (/= end (1+ total)))
801           (message "Char: %s (0%o, %d, 0x%x)  point=%d of %d(%d%%) <%d - %d>  column %d %s"
802                    (text-char-description char) char char char pos total
803                    percent beg end col hscroll)
804         (message "Char: %s (0%o, %d, 0x%x)  point=%d of %d(%d%%)  column %d %s"
805                  (text-char-description char) char char char pos total
806                  percent col hscroll)))))
807
808 (defun fundamental-mode ()
809   "Major mode not specialized for anything in particular.
810 Other major modes are defined by comparison with this one."
811   (interactive)
812   (kill-all-local-variables))
813
814 ;; XEmacs the following are declared elsewhere
815 ;(defvar read-expression-map (cons 'keymap minibuffer-local-map)
816 ;  "Minibuffer keymap used for reading Lisp expressions.")
817 ;(define-key read-expression-map "\M-\t" 'lisp-complete-symbol)
818
819 ;(put 'eval-expression 'disabled t)
820
821 ;(defvar read-expression-history nil)
822
823 ;; We define this, rather than making `eval' interactive,
824 ;; for the sake of completion of names like eval-region, eval-current-buffer.
825 (defun eval-expression (expression &optional eval-expression-insert-value)
826   "Evaluate EXPRESSION and print value in minibuffer.
827 Value is also consed on to front of the variable `values'.
828 With prefix argument, insert the result to the current buffer."
829   ;(interactive "xEval: ")
830   (interactive
831    (list (read-from-minibuffer "Eval: "
832                                nil read-expression-map t
833                                'read-expression-history)
834          current-prefix-arg))
835   (setq values (cons (eval expression) values))
836   (prin1 (car values)
837          (if eval-expression-insert-value (current-buffer) t)))
838
839 ;; XEmacs -- extra parameter (variant, but equivalent logic)
840 (defun edit-and-eval-command (prompt form &optional history)
841   "Prompting with PROMPT, let user edit FORM and eval result.
842 FORM is a Lisp expression.  Let user edit that expression in
843 the minibuffer, then read and evaluate the result."
844   (let ((form (read-expression prompt
845                                ;; first try to format the thing readably;
846                                ;; and if that fails, print it normally.
847                                (condition-case ()
848                                    (let ((print-readably t))
849                                      (prin1-to-string form))
850                                  (error (prin1-to-string form)))
851                                (or history '(command-history . 1)))))
852     (or history (setq history 'command-history))
853     (if (consp history)
854         (setq history (car history)))
855     (if (eq history t)
856         nil
857       ;; If form was added to the history as a string,
858       ;; get rid of that.  We want only evallable expressions there.
859       (if (stringp (car (symbol-value history)))
860           (set history (cdr (symbol-value history))))
861
862       ;; If form to be redone does not match front of history,
863       ;; add it to the history.
864       (or (equal form (car (symbol-value history)))
865           (set history (cons form (symbol-value history)))))
866     (eval form)))
867
868 (defun repeat-complex-command (arg)
869   "Edit and re-evaluate last complex command, or ARGth from last.
870 A complex command is one which used the minibuffer.
871 The command is placed in the minibuffer as a Lisp form for editing.
872 The result is executed, repeating the command as changed.
873 If the command has been changed or is not the most recent previous command
874 it is added to the front of the command history.
875 You can use the minibuffer history commands \\<minibuffer-local-map>\\[next-history-element] and \\[previous-history-element]
876 to get different commands to edit and resubmit."
877   (interactive "p")
878   ;; XEmacs: It looks like our version is better -sb
879   (let ((print-level nil))
880     (edit-and-eval-command "Redo: "
881                            (or (nth (1- arg) command-history)
882                                (error ""))
883                            (cons 'command-history arg))))
884
885 ;; XEmacs: Functions moved to minibuf.el
886 ;; previous-matching-history-element
887 ;; next-matching-history-element
888 ;; next-history-element
889 ;; previous-history-element
890 ;; next-complete-history-element
891 ;; previous-complete-history-element
892 \f
893 (defun goto-line (line)
894   "Goto line LINE, counting from line 1 at beginning of buffer."
895   (interactive "NGoto line: ")
896   (setq line (prefix-numeric-value line))
897   (save-restriction
898     (widen)
899     (goto-char 1)
900     (if (eq selective-display t)
901         (re-search-forward "[\n\C-m]" nil 'end (1- line))
902       (forward-line (1- line)))))
903
904 ;Put this on C-x u, so we can force that rather than C-_ into startup msg
905 (define-function 'advertised-undo 'undo)
906
907 (defun undo (&optional count)
908   "Undo some previous changes.
909 Repeat this command to undo more changes.
910 A numeric argument serves as a repeat count."
911   (interactive "*p")
912   ;; If we don't get all the way through, make last-command indicate that
913   ;; for the following command.
914   (setq this-command t)
915   (let ((modified (buffer-modified-p))
916         (recent-save (recent-auto-save-p)))
917     (or (eq (selected-window) (minibuffer-window))
918         (display-message 'command "Undo!"))
919     (or (and (eq last-command 'undo)
920              (eq (current-buffer) last-undo-buffer)) ; XEmacs
921         (progn (undo-start)
922                (undo-more 1)))
923     (undo-more (or count 1))
924     ;; Don't specify a position in the undo record for the undo command.
925     ;; Instead, undoing this should move point to where the change is.
926     (let ((tail buffer-undo-list)
927           done)
928       (while (and tail (not done) (not (null (car tail))))
929         (if (integerp (car tail))
930             (progn
931               (setq done t)
932               (setq buffer-undo-list (delq (car tail) buffer-undo-list))))
933         (setq tail (cdr tail))))
934     (and modified (not (buffer-modified-p))
935          (delete-auto-save-file-if-necessary recent-save)))
936   ;; If we do get all the way through, make this-command indicate that.
937   (setq this-command 'undo))
938
939 (defvar pending-undo-list nil
940   "Within a run of consecutive undo commands, list remaining to be undone.")
941
942 (defvar last-undo-buffer nil)   ; XEmacs
943
944 (defun undo-start ()
945   "Set `pending-undo-list' to the front of the undo list.
946 The next call to `undo-more' will undo the most recently made change."
947   (if (eq buffer-undo-list t)
948       (error "No undo information in this buffer"))
949   (setq pending-undo-list buffer-undo-list))
950
951 (defun undo-more (count)
952   "Undo back N undo-boundaries beyond what was already undone recently.
953 Call `undo-start' to get ready to undo recent changes,
954 then call `undo-more' one or more times to undo them."
955   (or pending-undo-list
956       (error "No further undo information"))
957   (setq pending-undo-list (primitive-undo count pending-undo-list)
958         last-undo-buffer (current-buffer)))     ; XEmacs
959
960 ;; XEmacs
961 (defun call-with-transparent-undo (fn &rest args)
962   "Apply FN to ARGS, and then undo all changes made by FN to the current
963 buffer.  The undo records are processed even if FN returns non-locally.
964 There is no trace of the changes made by FN in the buffer's undo history.
965
966 You can use this in a write-file-hooks function with continue-save-buffer
967 to make the contents of a disk file differ from its in-memory buffer."
968   (let ((buffer-undo-list nil)
969         ;; Kludge to prevent undo list truncation:
970         (undo-high-threshold -1)
971         (undo-threshold -1)
972         (obuffer (current-buffer)))
973     (unwind-protect
974         (apply fn args)
975       ;; Go to the buffer we will restore and make it writable:
976       (set-buffer obuffer)
977       (save-excursion
978         (let ((buffer-read-only nil))
979           (save-restriction
980             (widen)
981             ;; Perform all undos, with further undo logging disabled:
982             (let ((tail buffer-undo-list))
983               (setq buffer-undo-list t)
984               (while tail
985                 (setq tail (primitive-undo (length tail) tail))))))))))
986
987 ;; XEmacs: The following are in other files
988 ;; shell-command-history
989 ;; shell-command-switch
990 ;; shell-command
991 ;; shell-command-sentinel
992
993 \f
994 (defconst universal-argument-map
995   (let ((map (make-sparse-keymap)))
996     (set-keymap-default-binding map 'universal-argument-other-key)
997     ;FSFmacs (define-key map [switch-frame] nil)
998     (define-key map [(t)] 'universal-argument-other-key)
999     (define-key map [(meta t)] 'universal-argument-other-key)
1000     (define-key map [(control u)] 'universal-argument-more)
1001     (define-key map [?-] 'universal-argument-minus)
1002     (define-key map [?0] 'digit-argument)
1003     (define-key map [?1] 'digit-argument)
1004     (define-key map [?2] 'digit-argument)
1005     (define-key map [?3] 'digit-argument)
1006     (define-key map [?4] 'digit-argument)
1007     (define-key map [?5] 'digit-argument)
1008     (define-key map [?6] 'digit-argument)
1009     (define-key map [?7] 'digit-argument)
1010     (define-key map [?8] 'digit-argument)
1011     (define-key map [?9] 'digit-argument)
1012     map)
1013   "Keymap used while processing \\[universal-argument].")
1014
1015 (defvar universal-argument-num-events nil
1016   "Number of argument-specifying events read by `universal-argument'.
1017 `universal-argument-other-key' uses this to discard those events
1018 from (this-command-keys), and reread only the final command.")
1019
1020 (defun universal-argument ()
1021   "Begin a numeric argument for the following command.
1022 Digits or minus sign following \\[universal-argument] make up the numeric argument.
1023 \\[universal-argument] following the digits or minus sign ends the argument.
1024 \\[universal-argument] without digits or minus sign provides 4 as argument.
1025 Repeating \\[universal-argument] without digits or minus sign
1026  multiplies the argument by 4 each time."
1027   (interactive)
1028   (setq prefix-arg (list 4))
1029   (setq zmacs-region-stays t)   ; XEmacs
1030   (setq universal-argument-num-events (length (this-command-keys)))
1031   (setq overriding-terminal-local-map universal-argument-map))
1032
1033 ;; A subsequent C-u means to multiply the factor by 4 if we've typed
1034 ;; nothing but C-u's; otherwise it means to terminate the prefix arg.
1035 (defun universal-argument-more (arg)
1036   (interactive "_P")                    ; XEmacs
1037   (if (consp arg)
1038       (setq prefix-arg (list (* 4 (car arg))))
1039     (setq prefix-arg arg)
1040     (setq overriding-terminal-local-map nil))
1041   (setq universal-argument-num-events (length (this-command-keys))))
1042
1043 (defun negative-argument (arg)
1044   "Begin a negative numeric argument for the next command.
1045 \\[universal-argument] following digits or minus sign ends the argument."
1046   (interactive "_P")                    ; XEmacs
1047   (cond ((integerp arg)
1048           (setq prefix-arg (- arg)))
1049          ((eq arg '-)
1050           (setq prefix-arg nil))
1051          (t
1052           (setq prefix-arg '-)))
1053   (setq universal-argument-num-events (length (this-command-keys)))
1054   (setq overriding-terminal-local-map universal-argument-map))
1055
1056 ;; XEmacs:  This function not synched with FSF
1057 (defun digit-argument (arg)
1058   "Part of the numeric argument for the next command.
1059 \\[universal-argument] following digits or minus sign ends the argument."
1060   (interactive "_P")                    ; XEmacs
1061   (let* ((event last-command-event)
1062          (key (and (key-press-event-p event)
1063                    (event-key event)))
1064          (digit (and key (characterp key) (>= key ?0) (<= key ?9)
1065                      (- key ?0))))
1066     (if (null digit)
1067         (universal-argument-other-key arg)
1068       (cond ((integerp arg)
1069              (setq prefix-arg (+ (* arg 10)
1070                                  (if (< arg 0) (- digit) digit))))
1071             ((eq arg '-)
1072              ;; Treat -0 as just -, so that -01 will work.
1073              (setq prefix-arg (if (zerop digit) '- (- digit))))
1074             (t
1075              (setq prefix-arg digit)))
1076       (setq universal-argument-num-events (length (this-command-keys)))
1077       (setq overriding-terminal-local-map universal-argument-map))))
1078
1079 ;; For backward compatibility, minus with no modifiers is an ordinary
1080 ;; command if digits have already been entered.
1081 (defun universal-argument-minus (arg)
1082   (interactive "_P") ; XEmacs
1083   (if (integerp arg)
1084       (universal-argument-other-key arg)
1085     (negative-argument arg)))
1086
1087 ;; Anything else terminates the argument and is left in the queue to be
1088 ;; executed as a command.
1089 (defun universal-argument-other-key (arg)
1090   (interactive "_P")                    ; XEmacs
1091   (setq prefix-arg arg)
1092   (let* ((key (this-command-keys))
1093          ;; FSF calls silly function `listify-key-sequence' here.
1094           (keylist (append key nil)))
1095     (setq unread-command-events
1096            (append (nthcdr universal-argument-num-events keylist)
1097                    unread-command-events)))
1098   (reset-this-command-lengths)
1099   (setq overriding-terminal-local-map nil))
1100
1101 \f
1102 ;; XEmacs -- keep zmacs-region active.
1103 (defun forward-to-indentation (count)
1104   "Move forward COUNT lines and position at first nonblank character."
1105   (interactive "_p")
1106   (forward-line count)
1107   (skip-chars-forward " \t"))
1108
1109 (defun backward-to-indentation (count)
1110   "Move backward COUNT lines and position at first nonblank character."
1111   (interactive "_p")
1112   (forward-line (- count))
1113   (skip-chars-forward " \t"))
1114
1115 (defcustom kill-whole-line nil
1116   "*If non-nil, kill the whole line if point is at the beginning.
1117 Otherwise, `kill-line' kills only up to the end of the line, but not
1118 the terminating newline.
1119
1120 WARNING: This is a misnamed variable!  It should be called something
1121 like `kill-whole-line-when-at-beginning'.  If you simply want
1122 \\[kill-line] to kill the entire current line, bind it to the function
1123 `kill-entire-line'.  "
1124   :type 'boolean
1125   :group 'killing)
1126
1127 (defun kill-line-1 (arg entire-line)
1128   (kill-region (if entire-line
1129                    (save-excursion
1130                      (beginning-of-line)
1131                      (point))
1132                  (point))
1133                ;; Don't shift point before doing the delete; that way,
1134                ;; undo will record the right position of point.
1135 ;; FSF
1136 ;              ;; It is better to move point to the other end of the kill
1137 ;              ;; before killing.  That way, in a read-only buffer, point
1138 ;              ;; moves across the text that is copied to the kill ring.
1139 ;              ;; The choice has no effect on undo now that undo records
1140 ;              ;; the value of point from before the command was run.
1141 ;              (progn
1142                (save-excursion
1143                  (if arg
1144                      (forward-line (prefix-numeric-value arg))
1145                    (if (eobp)
1146                        (signal 'end-of-buffer nil))
1147                    (if (or (looking-at "[ \t]*$")
1148                            (or entire-line
1149                                (and kill-whole-line (bolp))))
1150                        (forward-line 1)
1151                      (end-of-line)))
1152                  (point))))
1153
1154 (defun kill-entire-line (&optional arg)
1155   "Kill the entire line.
1156 With prefix argument, kill that many lines from point.  Negative
1157 arguments kill lines backward.
1158
1159 When calling from a program, nil means \"no arg\",
1160 a number counts as a prefix arg."
1161   (interactive "*P")
1162   (kill-line-1 arg t))
1163
1164 (defun kill-line (&optional arg)
1165   "Kill the rest of the current line, or the entire line.
1166 If no nonblanks there, kill thru newline.  If called interactively,
1167 may kill the entire line when given no argument at the beginning of a
1168 line; see `kill-whole-line'.  With prefix argument, kill that many
1169 lines from point.  Negative arguments kill lines backward.
1170
1171 WARNING: This is a misnamed function!  It should be called something
1172 like `kill-to-end-of-line'.  If you simply want to kill the entire
1173 current line, use `kill-entire-line'.
1174
1175 When calling from a program, nil means \"no arg\",
1176 a number counts as a prefix arg."
1177   (interactive "*P")
1178   (kill-line-1 arg nil))
1179
1180 ;; XEmacs
1181 (defun backward-kill-line nil
1182   "Kill back to the beginning of the line."
1183   (interactive)
1184   (let ((point (point)))
1185     (beginning-of-line nil)
1186     (kill-region (point) point)))
1187
1188 \f
1189 ;;;; Window system cut and paste hooks.
1190 ;;;
1191 ;;; I think that kill-hooks is a better name and more general mechanism
1192 ;;; than interprogram-cut-function (from FSFmacs).  I don't like the behavior
1193 ;;; of interprogram-paste-function: ^Y should always come from the kill ring,
1194 ;;; not the X selection.  But if that were provided, it should be called (and
1195 ;;; behave as) yank-hooks instead.  -- jwz
1196
1197 ;; [... code snipped ...]
1198
1199 (defcustom kill-hooks nil
1200   "*Functions run when something is added to the XEmacs kill ring.
1201 These functions are called with one argument, the string most recently
1202 cut or copied.  You can use this to, for example, make the most recent
1203 kill become the X Clipboard selection."
1204   :type 'hook
1205   :group 'killing)
1206
1207 ;;; `kill-hooks' seems not sufficient because
1208 ;;; `interprogram-cut-function' requires more variable about to rotate
1209 ;;; the cut buffers.  I'm afraid to change interface of `kill-hooks',
1210 ;;; so I add it. (1997-11-03 by MORIOKA Tomohiko)
1211
1212 (defcustom interprogram-cut-function 'own-clipboard
1213   "Function to call to make a killed region available to other programs.
1214
1215 Most window systems provide some sort of facility for cutting and
1216 pasting text between the windows of different programs.
1217 This variable holds a function that Emacs calls whenever text
1218 is put in the kill ring, to make the new kill available to other
1219 programs.
1220
1221 The function takes one or two arguments.
1222 The first argument, TEXT, is a string containing
1223 the text which should be made available.
1224 The second, PUSH, if non-nil means this is a \"new\" kill;
1225 nil means appending to an \"old\" kill.
1226
1227 One reasonable choice is `own-clipboard' (the default)."
1228   :type '(radio (function-item :tag "Send to Clipboard"
1229                                :format "%t\n"
1230                                own-clipboard)
1231                 (const :tag "None" nil)
1232                 (function :tag "Other"))
1233   :group 'killing)
1234
1235 (defcustom interprogram-paste-function 'get-clipboard-foreign
1236   "Function to call to get text cut from other programs.
1237
1238 Most window systems provide some sort of facility for cutting and
1239 pasting text between the windows of different programs.
1240 This variable holds a function that Emacs calls to obtain
1241 text that other programs have provided for pasting.
1242
1243 The function should be called with no arguments.  If the function
1244 returns nil, then no other program has provided such text, and the top
1245 of the Emacs kill ring should be used.  If the function returns a
1246 string, that string should be put in the kill ring as the latest kill.
1247
1248 Note that the function should return a string only if a program other
1249 than Emacs has provided a string for pasting; if Emacs provided the
1250 most recent string, the function should return nil.  If it is
1251 difficult to tell whether Emacs or some other program provided the
1252 current string, it is probably good enough to return nil if the string
1253 is equal (according to `string=') to the last text Emacs provided.
1254
1255 Reasonable choices include `get-clipboard-foreign' (the default), and
1256 functions calling `get-selection-foreign' (q.v.)."
1257   :type '(radio (function-item :tag "Get from Clipboard"
1258                                :format "%t\n"
1259                                get-clipboard-foreign)
1260                 (const :tag "None" nil)
1261                 (function :tag "Other"))
1262   :group 'killing)
1263
1264 \f
1265 ;;;; The kill ring data structure.
1266
1267 (defvar kill-ring nil
1268   "List of killed text sequences.
1269 Since the kill ring is supposed to interact nicely with cut-and-paste
1270 facilities offered by window systems, use of this variable should
1271 interact nicely with `interprogram-cut-function' and
1272 `interprogram-paste-function'.  The functions `kill-new',
1273 `kill-append', and `current-kill' are supposed to implement this
1274 interaction; you may want to use them instead of manipulating the kill
1275 ring directly.")
1276
1277 (defcustom kill-ring-max 30
1278   "*Maximum length of kill ring before oldest elements are thrown away."
1279   :type 'integer
1280   :group 'killing)
1281
1282 (defvar kill-ring-yank-pointer nil
1283   "The tail of the kill ring whose car is the last thing yanked.")
1284
1285 (defun kill-new (string &optional replace)
1286   "Make STRING the latest kill in the kill ring.
1287 Set `kill-ring-yank-pointer' to point to it.
1288 Run `kill-hooks'.
1289 Optional second argument REPLACE non-nil means that STRING will replace
1290 the front of the kill ring, rather than being added to the list."
1291 ;  (and (fboundp 'menu-bar-update-yank-menu)
1292 ;       (menu-bar-update-yank-menu string (and replace (car kill-ring))))
1293   (if replace
1294       (setcar kill-ring string)
1295     (setq kill-ring (cons string kill-ring))
1296     (if (> (length kill-ring) kill-ring-max)
1297         (setcdr (nthcdr (1- kill-ring-max) kill-ring) nil)))
1298   (setq kill-ring-yank-pointer kill-ring)
1299   (if interprogram-cut-function
1300       (funcall interprogram-cut-function string (not replace)))
1301   (run-hook-with-args 'kill-hooks string))
1302
1303 (defun kill-append (string before-p)
1304   "Append STRING to the end of the latest kill in the kill ring.
1305 If BEFORE-P is non-nil, prepend STRING to the kill.
1306 Run `kill-hooks'."
1307   (kill-new (if before-p
1308                 (concat string (car kill-ring))
1309               (concat (car kill-ring) string)) t))
1310
1311 (defun current-kill (n &optional do-not-move)
1312   "Rotate the yanking point by N places, and then return that kill.
1313 If N is zero, `interprogram-paste-function' is set, and calling it
1314 returns a string, then that string is added to the front of the
1315 kill ring and returned as the latest kill.
1316 If optional arg DO-NOT-MOVE is non-nil, then don't actually move the
1317 yanking point\; just return the Nth kill forward."
1318   (let ((interprogram-paste (and (= n 0)
1319                                  interprogram-paste-function
1320                                  (funcall interprogram-paste-function))))
1321     (if interprogram-paste
1322         (progn
1323           ;; Disable the interprogram cut function when we add the new
1324           ;; text to the kill ring, so Emacs doesn't try to own the
1325           ;; selection, with identical text.
1326           (let ((interprogram-cut-function nil))
1327             (kill-new interprogram-paste))
1328           interprogram-paste)
1329       (or kill-ring (error "Kill ring is empty"))
1330       (let* ((tem (nthcdr (mod (- n (length kill-ring-yank-pointer))
1331                                (length kill-ring))
1332                           kill-ring)))
1333         (or do-not-move
1334             (setq kill-ring-yank-pointer tem))
1335         (car tem)))))
1336
1337
1338 \f
1339 ;;;; Commands for manipulating the kill ring.
1340
1341 ;; In FSF killing read-only text just pastes it into kill-ring.  Which
1342 ;; is a very bad idea -- see Jamie's comment below.
1343
1344 ;(defvar kill-read-only-ok nil
1345 ;  "*Non-nil means don't signal an error for killing read-only text.")
1346
1347 (defun kill-region (start end &optional verbose) ; verbose is XEmacs addition
1348   "Kill between point and mark.
1349 The text is deleted but saved in the kill ring.
1350 The command \\[yank] can retrieve it from there.
1351 \(If you want to kill and then yank immediately, use \\[copy-region-as-kill].)
1352
1353 This is the primitive for programs to kill text (as opposed to deleting it).
1354 Supply two arguments, character numbers indicating the stretch of text
1355  to be killed.
1356 Any command that calls this function is a \"kill command\".
1357 If the previous command was also a kill command,
1358 the text killed this time appends to the text killed last time
1359 to make one entry in the kill ring."
1360   (interactive "*r\np")
1361 ;  (interactive
1362 ;   (let ((region-hack (and zmacs-regions (eq last-command 'yank))))
1363 ;     ;; This lets "^Y^W" work.  I think this is dumb, but zwei did it.
1364 ;     (if region-hack (zmacs-activate-region))
1365 ;     (prog1
1366 ;        (list (point) (mark) current-prefix-arg)
1367 ;       (if region-hack (zmacs-deactivate-region)))))
1368   ;; start and end can be markers but the rest of this function is
1369   ;; written as if they are only integers
1370   (if (markerp start) (setq start (marker-position start)))
1371   (if (markerp end) (setq end (marker-position end)))
1372   (or (and start end) (if zmacs-regions ;; rewritten for I18N3 snarfing
1373                         (error "The region is not active now")
1374                       (error "The mark is not set now")))
1375   (if verbose (if buffer-read-only
1376                   (lmessage 'command "Copying %d characters"
1377                             (- (max start end) (min start end)))
1378                 (lmessage 'command "Killing %d characters"
1379                           (- (max start end) (min start end)))))
1380   (cond
1381
1382    ;; I don't like this large change in behavior -- jwz
1383    ;; Read-Only text means it shouldn't be deleted, so I'm restoring
1384    ;; this code, but only for text-properties and not full extents. -sb
1385    ;; If the buffer is read-only, we should beep, in case the person
1386    ;; just isn't aware of this.  However, there's no harm in putting
1387    ;; the region's text in the kill ring, anyway.
1388    ((or (and buffer-read-only (not inhibit-read-only))
1389         (text-property-not-all (min start end) (max start end) 'read-only nil))
1390    ;; This is redundant.
1391    ;; (if verbose (message "Copying %d characters"
1392    ;;                    (- (max start end) (min start end))))
1393     (copy-region-as-kill start end)
1394    ;; ;; This should always barf, and give us the correct error.
1395    ;; (if kill-read-only-ok
1396    ;;     (message "Read only text copied to kill ring")
1397     (setq this-command 'kill-region)
1398     (barf-if-buffer-read-only)
1399     (signal 'buffer-read-only (list (current-buffer))))
1400
1401    ;; In certain cases, we can arrange for the undo list and the kill
1402    ;; ring to share the same string object.  This code does that.
1403    ((not (or (eq buffer-undo-list t)
1404              (eq last-command 'kill-region)
1405              ;; Use = since positions may be numbers or markers.
1406              (= start end)))
1407     ;; Don't let the undo list be truncated before we can even access it.
1408     ;; FSF calls this `undo-strong-limit'
1409     (let ((undo-high-threshold (+ (- end start) 100))
1410           ;(old-list buffer-undo-list)
1411           tail)
1412       (delete-region start end)
1413       ;; Search back in buffer-undo-list for this string,
1414       ;; in case a change hook made property changes.
1415       (setq tail buffer-undo-list)
1416       (while (and tail
1417                   (not (stringp (car-safe (car-safe tail))))) ; XEmacs
1418         (pop tail))
1419       ;; Take the same string recorded for undo
1420       ;; and put it in the kill-ring.
1421       (and tail
1422            (kill-new (car (car tail))))))
1423
1424    (t
1425     ;; if undo is not kept, grab the string then delete it (which won't
1426     ;; add another string to the undo list).
1427     (copy-region-as-kill start end)
1428     (delete-region start end)))
1429   (setq this-command 'kill-region))
1430
1431 ;; copy-region-as-kill no longer sets this-command, because it's confusing
1432 ;; to get two copies of the text when the user accidentally types M-w and
1433 ;; then corrects it with the intended C-w.
1434 (defun copy-region-as-kill (start end)
1435   "Save the region as if killed, but don't kill it.
1436 Run `kill-hooks'."
1437   (interactive "r")
1438   (if (eq last-command 'kill-region)
1439       (kill-append (buffer-substring start end) (< end start))
1440     (kill-new (buffer-substring start end)))
1441   nil)
1442
1443 (defun kill-ring-save (start end)
1444   "Save the region as if killed, but don't kill it.
1445 This command is similar to `copy-region-as-kill', except that it gives
1446 visual feedback indicating the extent of the region being copied."
1447   (interactive "r")
1448   (copy-region-as-kill start end)
1449   ;; copy before delay, for xclipboard's benefit
1450   (if (interactive-p)
1451       (let ((other-end (if (= (point) start) end start))
1452             (opoint (point))
1453             ;; Inhibit quitting so we can make a quit here
1454             ;; look like a C-g typed as a command.
1455             (inhibit-quit t))
1456         (if (pos-visible-in-window-p other-end (selected-window))
1457             (progn
1458               ;; FSF (I'm not sure what this does -sb)
1459 ;             ;; Swap point and mark.
1460 ;             (set-marker (mark-marker) (point) (current-buffer))
1461               (goto-char other-end)
1462               (sit-for 1)
1463 ;             ;; Swap back.
1464 ;             (set-marker (mark-marker) other-end (current-buffer))
1465               (goto-char opoint)
1466               ;; If user quit, deactivate the mark
1467               ;; as C-g would as a command.
1468               (and quit-flag (mark)
1469                    (zmacs-deactivate-region)))
1470           ;; too noisy. -- jwz
1471 ;         (let* ((killed-text (current-kill 0))
1472 ;                (message-len (min (length killed-text) 40)))
1473 ;           (if (= (point) start)
1474 ;               ;; Don't say "killed"; that is misleading.
1475 ;               (message "Saved text until \"%s\""
1476 ;                       (substring killed-text (- message-len)))
1477 ;             (message "Saved text from \"%s\""
1478 ;                     (substring killed-text 0 message-len))))
1479           ))))
1480
1481 (defun append-next-kill ()
1482   "Cause following command, if it kills, to append to previous kill."
1483   ;; XEmacs
1484   (interactive "_")
1485   (if (interactive-p)
1486       (progn
1487         (setq this-command 'kill-region)
1488         (display-message 'command
1489           "If the next command is a kill, it will append"))
1490     (setq last-command 'kill-region)))
1491
1492 (defun yank-pop (arg)
1493   "Replace just-yanked stretch of killed text with a different stretch.
1494 This command is allowed only immediately after a `yank' or a `yank-pop'.
1495 At such a time, the region contains a stretch of reinserted
1496 previously-killed text.  `yank-pop' deletes that text and inserts in its
1497 place a different stretch of killed text.
1498
1499 With no argument, the previous kill is inserted.
1500 With argument N, insert the Nth previous kill.
1501 If N is negative, this is a more recent kill.
1502
1503 The sequence of kills wraps around, so that after the oldest one
1504 comes the newest one."
1505   (interactive "*p")
1506   (if (not (eq last-command 'yank))
1507       (error "Previous command was not a yank"))
1508   (setq this-command 'yank)
1509   (let ((inhibit-read-only t)
1510         (before (< (point) (mark t))))
1511     (delete-region (point) (mark t))
1512     ;;(set-marker (mark-marker) (point) (current-buffer))
1513     (set-mark (point))
1514     (insert (current-kill arg))
1515     (if before
1516         ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1517         ;; It is cleaner to avoid activation, even though the command
1518         ;; loop would deactivate the mark because we inserted text.
1519         (goto-char (prog1 (mark t)
1520                      (set-marker (mark-marker t) (point) (current-buffer))))))
1521   nil)
1522
1523
1524 (defun yank (&optional arg)
1525   "Reinsert the last stretch of killed text.
1526 More precisely, reinsert the stretch of killed text most recently
1527 killed OR yanked.  Put point at end, and set mark at beginning.
1528 With just C-u as argument, same but put point at beginning (and mark at end).
1529 With argument N, reinsert the Nth most recently killed stretch of killed
1530 text.
1531 See also the command \\[yank-pop]."
1532   (interactive "*P")
1533   ;; If we don't get all the way through, make last-command indicate that
1534   ;; for the following command.
1535   (setq this-command t)
1536   (push-mark (point))
1537   (insert (current-kill (cond
1538                          ((listp arg) 0)
1539                          ((eq arg '-) -1)
1540                          (t (1- arg)))))
1541   (if (consp arg)
1542       ;; This is like exchange-point-and-mark, but doesn't activate the mark.
1543       ;; It is cleaner to avoid activation, even though the command
1544       ;; loop would deactivate the mark because we inserted text.
1545       ;; (But it's an unnecessary kludge in XEmacs.)
1546       ;(goto-char (prog1 (mark t)
1547                    ;(set-marker (mark-marker) (point) (current-buffer)))))
1548       (exchange-point-and-mark t))
1549   ;; If we do get all the way thru, make this-command indicate that.
1550   (setq this-command 'yank)
1551   nil)
1552
1553 (defun rotate-yank-pointer (arg)
1554   "Rotate the yanking point in the kill ring.
1555 With argument, rotate that many kills forward (or backward, if negative)."
1556   (interactive "p")
1557   (current-kill arg))
1558
1559 \f
1560 (defun insert-buffer (buffer)
1561   "Insert after point the contents of BUFFER.
1562 Puts mark after the inserted text.
1563 BUFFER may be a buffer or a buffer name."
1564   (interactive
1565    (list
1566     (progn
1567       (barf-if-buffer-read-only)
1568       (read-buffer "Insert buffer: "
1569                    ;; XEmacs: we have different args
1570                    (other-buffer (current-buffer) nil t)
1571                    t))))
1572   (or (bufferp buffer)
1573       (setq buffer (get-buffer buffer)))
1574   (let (start end newmark)
1575     (save-excursion
1576       (save-excursion
1577         (set-buffer buffer)
1578         (setq start (point-min) end (point-max)))
1579       (insert-buffer-substring buffer start end)
1580       (setq newmark (point)))
1581     (push-mark newmark))
1582   nil)
1583
1584 (defun append-to-buffer (buffer start end)
1585   "Append to specified buffer the text of the region.
1586 It is inserted into that buffer before its point.
1587
1588 When calling from a program, give three arguments:
1589 BUFFER (or buffer name), START and END.
1590 START and END specify the portion of the current buffer to be copied."
1591   (interactive
1592    ;; XEmacs: we have different args to other-buffer
1593    (list (read-buffer "Append to buffer: " (other-buffer (current-buffer)
1594                                                          nil t))
1595          (region-beginning) (region-end)))
1596   (let ((oldbuf (current-buffer)))
1597     (save-excursion
1598       (set-buffer (get-buffer-create buffer))
1599       (insert-buffer-substring oldbuf start end))))
1600
1601 (defun prepend-to-buffer (buffer start end)
1602   "Prepend to specified buffer the text of the region.
1603 It is inserted into that buffer after its point.
1604
1605 When calling from a program, give three arguments:
1606 BUFFER (or buffer name), START and END.
1607 START and END specify the portion of the current buffer to be copied."
1608   (interactive "BPrepend to buffer: \nr")
1609   (let ((oldbuf (current-buffer)))
1610     (save-excursion
1611       (set-buffer (get-buffer-create buffer))
1612       (save-excursion
1613         (insert-buffer-substring oldbuf start end)))))
1614
1615 (defun copy-to-buffer (buffer start end)
1616   "Copy to specified buffer the text of the region.
1617 It is inserted into that buffer, replacing existing text there.
1618
1619 When calling from a program, give three arguments:
1620 BUFFER (or buffer name), START and END.
1621 START and END specify the portion of the current buffer to be copied."
1622   (interactive "BCopy to buffer: \nr")
1623   (let ((oldbuf (current-buffer)))
1624     (save-excursion
1625       (set-buffer (get-buffer-create buffer))
1626       (erase-buffer)
1627       (save-excursion
1628         (insert-buffer-substring oldbuf start end)))))
1629 \f
1630 ;FSFmacs
1631 ;(put 'mark-inactive 'error-conditions '(mark-inactive error))
1632 ;(put 'mark-inactive 'error-message "The mark is not active now")
1633
1634 (defun mark (&optional force buffer)
1635   "Return this buffer's mark value as integer, or nil if no mark.
1636
1637 If `zmacs-regions' is true, then this returns nil unless the region is
1638 currently in the active (highlighted) state.  With an argument of t, this
1639 returns the mark (if there is one) regardless of the active-region state.
1640 You should *generally* not use the mark unless the region is active, if
1641 the user has expressed a preference for the active-region model.
1642
1643 If you are using this in an editing command, you are most likely making
1644 a mistake; see the documentation of `set-mark'."
1645   (setq buffer (decode-buffer buffer))
1646 ;FSFmacs version:
1647 ;  (if (or force (not transient-mark-mode) mark-active mark-even-if-inactive)
1648 ;      (marker-position (mark-marker))
1649 ;    (signal 'mark-inactive nil)))
1650   (let ((m (mark-marker force buffer)))
1651     (and m (marker-position m))))
1652
1653 ;;;#### FSFmacs
1654 ;;; Many places set mark-active directly, and several of them failed to also
1655 ;;; run deactivate-mark-hook.  This shorthand should simplify.
1656 ;(defsubst deactivate-mark ()
1657 ;  "Deactivate the mark by setting `mark-active' to nil.
1658 ;\(That makes a difference only in Transient Mark mode.)
1659 ;Also runs the hook `deactivate-mark-hook'."
1660 ;  (if transient-mark-mode
1661 ;      (progn
1662 ;       (setq mark-active nil)
1663 ;       (run-hooks 'deactivate-mark-hook))))
1664
1665 (defun set-mark (pos &optional buffer)
1666   "Set this buffer's mark to POS.  Don't use this function!
1667 That is to say, don't use this function unless you want
1668 the user to see that the mark has moved, and you want the previous
1669 mark position to be lost.
1670
1671 Normally, when a new mark is set, the old one should go on the stack.
1672 This is why most applications should use `push-mark', not `set-mark'.
1673
1674 Novice Emacs Lisp programmers often try to use the mark for the wrong
1675 purposes.  The mark saves a location for the user's convenience.
1676 Most editing commands should not alter the mark.
1677 To remember a location for internal use in the Lisp program,
1678 store it in a Lisp variable.  Example:
1679
1680    (let ((start (point))) (forward-line 1) (delete-region start (point)))."
1681
1682   (setq buffer (decode-buffer buffer))
1683   (set-marker (mark-marker t buffer) pos buffer))
1684 ;; FSF
1685 ;  (if pos
1686 ;     (progn
1687 ;       (setq mark-active t)
1688 ;       (run-hooks 'activate-mark-hook)
1689 ;       (set-marker (mark-marker) pos (current-buffer)))
1690 ;    ;; Normally we never clear mark-active except in Transient Mark mode.
1691 ;    ;; But when we actually clear out the mark value too,
1692 ;    ;; we must clear mark-active in any mode.
1693 ;    (setq mark-active nil)
1694 ;    (run-hooks 'deactivate-mark-hook)
1695 ;    (set-marker (mark-marker) nil)))
1696
1697 (defvar mark-ring nil
1698   "The list of former marks of the current buffer, most recent first.
1699 This variable is automatically buffer-local.")
1700 (make-variable-buffer-local 'mark-ring)
1701 (put 'mark-ring 'permanent-local t)
1702
1703 (defvar dont-record-current-mark nil
1704   "If set to t, the current mark value should not be recorded on the mark ring.
1705 This is set by commands that manipulate the mark incidentally, to avoid
1706 cluttering the mark ring unnecessarily.  Under most circumstances, you do
1707 not need to set this directly; it is automatically reset each time
1708 `push-mark' is called, according to `mark-ring-unrecorded-commands'.  This
1709 variable is automatically buffer-local.")
1710 (make-variable-buffer-local 'dont-record-current-mark)
1711 (put 'dont-record-current-mark 'permanent-local t)
1712
1713 ;; a conspiracy between push-mark and handle-pre-motion-command
1714 (defvar in-shifted-motion-command nil)
1715
1716 (defcustom mark-ring-unrecorded-commands '(shifted-motion-commands
1717                                            yank
1718                                            mark-beginning-of-buffer
1719                                            mark-bob
1720                                            mark-defun
1721                                            mark-end-of-buffer
1722                                            mark-end-of-line
1723                                            mark-end-of-sentence
1724                                            mark-eob
1725                                            mark-marker
1726                                            mark-page
1727                                            mark-paragraph
1728                                            mark-sexp
1729                                            mark-whole-buffer
1730                                            mark-word)
1731   "*List of commands whose marks should not be recorded on the mark stack.
1732 Many commands set the mark as part of their action.  Normally, all such
1733 marks get recorded onto the mark stack.  However, this tends to clutter up
1734 the mark stack unnecessarily.  You can control this by putting a command
1735 onto this list.  Then, any marks set by the function will not be recorded.
1736
1737 The special value `shifted-motion-commands' causes marks set as a result
1738 of selection using any shifted motion commands to not be recorded.
1739
1740 The value `yank' affects all yank-like commands, as well as just `yank'."
1741   :type '(repeat (choice (const :tag "shifted motion commands"
1742                                 shifted-motion-commands)
1743                          (const :tag "functions that select text"
1744                                 :inline t
1745                                 (mark-beginning-of-buffer
1746                                  mark-bob
1747                                  mark-defun
1748                                  mark-end-of-buffer
1749                                  mark-end-of-line
1750                                  mark-end-of-sentence
1751                                  mark-eob
1752                                  mark-marker
1753                                  mark-page
1754                                  mark-paragraph
1755                                  mark-sexp
1756                                  mark-whole-buffer
1757                                  mark-word))
1758                          (const :tag "functions that paste text"
1759                                 yank)
1760                          function))
1761   :group 'killing)
1762
1763 (defcustom mark-ring-max 16
1764   "*Maximum size of mark ring.  Start discarding off end if gets this big."
1765   :type 'integer
1766   :group 'killing)
1767
1768 (defvar global-mark-ring nil
1769   "The list of saved global marks, most recent first.")
1770
1771 (defcustom global-mark-ring-max 16
1772   "*Maximum size of global mark ring.  \
1773 Start discarding off end if gets this big."
1774   :type 'integer
1775   :group 'killing)
1776
1777 (defun set-mark-command (arg)
1778   "Set mark at where point is, or jump to mark.
1779 With no prefix argument, set mark, push old mark position on local mark
1780 ring, and push mark on global mark ring.
1781 With argument, jump to mark, and pop a new position for mark off the ring
1782 \(does not affect global mark ring\).
1783
1784 The mark ring is a per-buffer stack of marks, most recent first.  Its
1785 maximum length is controlled by `mark-ring-max'.  Generally, when new
1786 marks are set, the current mark is pushed onto the stack.  You can pop
1787 marks off the stack using \\[universal-argument] \\[set-mark-command].  The term \"ring\" is used because when
1788 you pop a mark off the stack, the current mark value is pushed onto the
1789 far end of the stack.  If this is confusing, just think of the mark ring
1790 as a stack.
1791
1792 Novice Emacs Lisp programmers often try to use the mark for the wrong
1793 purposes.  See the documentation of `set-mark' for more information."
1794   (interactive "P")
1795   (if (null arg)
1796       (push-mark nil nil t)
1797     (if (null (mark t))
1798         (error "No mark set in this buffer")
1799       (if dont-record-current-mark (pop-mark))
1800       (goto-char (mark t))
1801       (pop-mark))))
1802
1803 ;; XEmacs: Extra parameter
1804 (defun push-mark (&optional location nomsg activate-region buffer)
1805   "Set mark at LOCATION (point, by default) and push old mark on mark ring.
1806 If the last global mark pushed was not in the current buffer,
1807 also push LOCATION on the global mark ring.
1808 Display `Mark set' unless the optional second arg NOMSG is non-nil.
1809 Activate mark if optional third arg ACTIVATE-REGION non-nil.
1810
1811 Novice Emacs Lisp programmers often try to use the mark for the wrong
1812 purposes.  See the documentation of `set-mark' for more information."
1813   (setq buffer (decode-buffer buffer)) ; XEmacs
1814   (if (or dont-record-current-mark (null (mark t buffer))) ; XEmacs
1815       nil
1816     ;; The save-excursion / set-buffer is necessary because mark-ring
1817     ;; is a buffer local variable
1818     (save-excursion
1819       (set-buffer buffer)
1820       (setq mark-ring (cons (copy-marker (mark-marker t buffer)) mark-ring))
1821       (if (> (length mark-ring) mark-ring-max)
1822           (progn
1823             (move-marker (car (nthcdr mark-ring-max mark-ring)) nil buffer)
1824             (setcdr (nthcdr (1- mark-ring-max) mark-ring) nil)))))
1825   (set-mark (or location (point buffer)) buffer)
1826 ; (set-marker (mark-marker) (or location (point)) (current-buffer)) ; FSF
1827   ;; Now push the mark on the global mark ring.
1828   (if (and (not dont-record-current-mark)
1829            (or (null global-mark-ring)
1830                (not (eq (marker-buffer (car global-mark-ring)) buffer))))
1831       ;; The last global mark pushed wasn't in this same buffer.
1832       (progn
1833         (setq global-mark-ring (cons (copy-marker (mark-marker t buffer))
1834                                      global-mark-ring))
1835         (if (> (length global-mark-ring) global-mark-ring-max)
1836             (progn
1837               (move-marker (car (nthcdr global-mark-ring-max global-mark-ring))
1838                            nil buffer)
1839               (setcdr (nthcdr (1- global-mark-ring-max) global-mark-ring) nil)))))
1840   (setq dont-record-current-mark
1841         (not (not (or (and in-shifted-motion-command
1842                            (memq 'shifted-motion-commands
1843                                  mark-ring-unrecorded-commands))
1844                       (memq this-command mark-ring-unrecorded-commands)))))
1845   (or dont-record-current-mark nomsg executing-kbd-macro
1846       (> (minibuffer-depth) 0)
1847       (display-message 'command "Mark set"))
1848   (if activate-region
1849       (progn
1850         (setq zmacs-region-stays t)
1851         (zmacs-activate-region)))
1852 ; (if (or activate (not transient-mark-mode)) ; FSF
1853 ;     (set-mark (mark t))) ; FSF
1854   nil)
1855
1856 (defun pop-mark ()
1857   "Pop off mark ring into the buffer's actual mark.
1858 Does not set point.  Does nothing if mark ring is empty."
1859   (if mark-ring
1860       (progn
1861         (setq mark-ring (nconc mark-ring (list (copy-marker (mark-marker t)))))
1862         (set-mark (car mark-ring))
1863         (move-marker (car mark-ring) nil)
1864         (if (null (mark t)) (ding))
1865         (setq mark-ring (cdr mark-ring)))))
1866
1867 (define-function 'exchange-dot-and-mark 'exchange-point-and-mark)
1868 (defun exchange-point-and-mark (&optional dont-activate-region)
1869   "Put the mark where point is now, and point where the mark is now.
1870 The mark is activated unless DONT-ACTIVATE-REGION is non-nil."
1871   (interactive nil)
1872   (let ((omark (mark t)))
1873     (if (null omark)
1874         (error "No mark set in this buffer"))
1875     (set-mark (point))
1876     (goto-char omark)
1877     (or dont-activate-region (zmacs-activate-region)) ; XEmacs
1878     nil))
1879
1880 ;; XEmacs
1881 (defun mark-something (mark-fn movement-fn arg)
1882   "internal function used by mark-sexp, mark-word, etc."
1883   (let (newmark (pushp t))
1884     (save-excursion
1885       (if (and (eq last-command mark-fn) (mark))
1886           ;; Extend the previous state in the same direction:
1887           (progn
1888             (if (< (mark) (point)) (setq arg (- arg)))
1889             (goto-char (mark))
1890             (setq pushp nil)))
1891       (funcall movement-fn arg)
1892       (setq newmark (point)))
1893     (if pushp
1894         (push-mark newmark nil t)
1895       ;; Do not mess with the mark stack, but merely adjust the previous state:
1896       (set-mark newmark)
1897       (activate-region))))
1898
1899 ;(defun transient-mark-mode (arg)
1900 ;  "Toggle Transient Mark mode.
1901 ;With arg, turn Transient Mark mode on if arg is positive, off otherwise.
1902 ;
1903 ;In Transient Mark mode, when the mark is active, the region is highlighted.
1904 ;Changing the buffer \"deactivates\" the mark.
1905 ;So do certain other operations that set the mark
1906 ;but whose main purpose is something else--for example,
1907 ;incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]."
1908 ;  (interactive "P")
1909 ;  (setq transient-mark-mode
1910 ;       (if (null arg)
1911 ;           (not transient-mark-mode)
1912 ;         (> (prefix-numeric-value arg) 0))))
1913
1914 (defun pop-global-mark ()
1915   "Pop off global mark ring and jump to the top location."
1916   (interactive)
1917   ;; Pop entries which refer to non-existent buffers.
1918   (while (and global-mark-ring (not (marker-buffer (car global-mark-ring))))
1919     (setq global-mark-ring (cdr global-mark-ring)))
1920   (or global-mark-ring
1921       (error "No global mark set"))
1922   (let* ((marker (car global-mark-ring))
1923          (buffer (marker-buffer marker))
1924          (position (marker-position marker)))
1925     (setq global-mark-ring (nconc (cdr global-mark-ring)
1926                                   (list (car global-mark-ring))))
1927     (set-buffer buffer)
1928     (or (and (>= position (point-min))
1929              (<= position (point-max)))
1930         (widen))
1931     (goto-char position)
1932     (switch-to-buffer buffer)))
1933
1934 \f
1935 (defcustom signal-error-on-buffer-boundary t
1936   "*If Non-nil, beep or signal an error when moving past buffer boundary.
1937 The commands that honor this variable are
1938
1939 forward-char-command
1940 backward-char-command
1941 next-line
1942 previous-line
1943 scroll-up-command
1944 scroll-down-command"
1945   :type 'boolean
1946   :group 'editing-basics)
1947
1948 ;;; After 8 years of waiting ... -sb
1949 (defcustom next-line-add-newlines nil  ; XEmacs
1950   "*If non-nil, `next-line' inserts newline when the point is at end of buffer.
1951 This behavior used to be the default, and is still default in FSF Emacs.
1952 We think it is an unnecessary and unwanted side-effect."
1953   :type 'boolean
1954   :group 'editing-basics)
1955
1956 (defcustom shifted-motion-keys-select-region t
1957   "*If non-nil, shifted motion keys select text, like in MS Windows.
1958
1959 More specifically, if a keystroke that matches one of the key
1960 specifications in `motion-keys-for-shifted-motion' is pressed along
1961 with the Shift key, and the command invoked moves the cursor and
1962 preserves the active region (see `zmacs-region-stays'), the
1963 intervening text will be added to the active region.
1964
1965 When the region has been enabled or augmented as a result of a shifted
1966 motion key, an unshifted motion key will normally deselect the region.
1967 However, if `unshifted-motion-keys-deselect-region' is t, the region
1968 will remain active, augmented by the characters moved over by this
1969 motion key.
1970
1971 This functionality is specifically interpreted in terms of keys, and
1972 *NOT* in terms of particular commands, because that produces the most
1973 intuitive behavior: `forward-char' will work with shifted motion
1974 when invoked by `right' but not `C-f', and user-written motion commands
1975 bound to motion keys will automatically work with shifted motion."
1976   :type 'boolean
1977   :group 'editing-basics)
1978
1979 (defcustom unshifted-motion-keys-deselect-region t
1980   "*If non-nil, unshifted motion keys deselect a shifted-motion region.
1981 This only occurs after a region has been selected or augmented using
1982 shifted motion keys (not when using the traditional set-mark-then-move
1983 method), and has no effect if `shifted-motion-keys-select-region' is
1984 nil."
1985   :type 'boolean
1986   :group 'editing-basics)
1987
1988 (defcustom motion-keys-for-shifted-motion
1989   '(left right up down home end prior next
1990          kp-left kp-right kp-up kp-down kp-home kp-end kp-prior kp-next)
1991   "*List of keys considered motion keys for the purpose of shifted selection.
1992 When one of these keys is pressed along with the Shift key, and the
1993 command invoked moves the cursor and preserves the active region (see
1994 `zmacs-region-stays'), the intervening text will be added to the active
1995 region.  See `shifted-motion-keys-select-region' for more details.
1996
1997 Each entry should be a keysym or a list (MODIFIERS ... KEYSYM),
1998 i.e. zero or more modifiers followed by a keysym.  When a keysym alone
1999 is given, a keystroke consisting of that keysym, with or without any
2000 modifiers, is considered a motion key.  When the list form is given,
2001 only a keystroke with exactly those modifiers and no others (with the
2002 exception of the Shift key) is considered a motion key.
2003
2004 NOTE: Currently, the keysym cannot be a non-alphabetic character key
2005 such as the `=/+' key.  In any case, the shifted-motion paradigm does
2006 not make much sense with those keys.  The keysym can, however, be an
2007 alphabetic key without problem, and you can specify the key using
2008 either a character or a symbol, uppercase or lowercase."
2009   :type '(repeat (choice (const :tag "normal cursor-pad (\"gray\") keys"
2010                                 :inline t
2011                                 (left right up down home end prior next))
2012                          (const :tag "keypad motion keys"
2013                                 :inline t
2014                                 (kp-left kp-right kp-up kp-down
2015                                          kp-home kp-end kp-prior kp-next))
2016                          (const :tag "alphabetic motion keys"
2017                                 :inline t
2018                                 ((control b) (control f)
2019                                  (control p) (control n)
2020                                  (control a) (control e)
2021                                  (control v) (meta v)
2022                                  (meta b) (meta f)
2023                                  (meta a) (meta e)
2024                                  (meta m) ; back-to-indentation
2025                                  (meta r) ; move-to-window-line
2026                                  (meta control b) (meta control f)
2027                                  (meta control p) (meta control n)
2028                                  (meta control a) (meta control e)
2029                                  (meta control d) ;; down-list
2030                                  (meta control u) ;; backward-up-list
2031                                  ))
2032                          symbol))
2033   :group 'editing-basics)
2034
2035 (defun handle-pre-motion-command-current-command-is-motion ()
2036   (and (key-press-event-p last-input-event)
2037        (let ((key (event-key last-input-event))
2038              (mods (delq 'shift (event-modifiers last-input-event))))
2039          ;(princ (format "key: %s mods: %s\n" key mods) 'external-debugging-output)
2040          (catch 'handle-pre-motion-command-current-command-is-motion
2041            (flet ((keysyms-equal (a b)
2042                     (if (characterp a)
2043                         (setq a (intern (char-to-string (downcase a)))))
2044                     (if (characterp b)
2045                         (setq b (intern (char-to-string (downcase b)))))
2046                     (eq a b)))
2047              (mapc #'(lambda (keysym)
2048                        (when (if (listp keysym)
2049                                  (and (equal mods (butlast keysym))
2050                                       (keysyms-equal key (car (last keysym))))
2051                                (keysyms-equal key keysym))
2052                          (throw
2053                           'handle-pre-motion-command-current-command-is-motion
2054                           t)))
2055                    motion-keys-for-shifted-motion)
2056              nil)))))
2057
2058 (defun handle-pre-motion-command ()
2059   (if (and
2060        (handle-pre-motion-command-current-command-is-motion)
2061        zmacs-regions
2062        shifted-motion-keys-select-region
2063        (not (region-active-p))
2064        ;; Special-case alphabetic keysyms, because the `shift'
2065        ;; modifier does not appear on them. (Unfortunately, we have no
2066        ;; way of determining Shift-key status on non-alphabetic ASCII
2067        ;; keysyms.  However, in this case, using Shift will invoke a
2068        ;; separate command from the non-shifted version, so the
2069        ;; "shifted motion" paradigm makes no sense.)
2070        (or (memq 'shift (event-modifiers last-input-event))
2071            (let ((key (event-key last-input-event)))
2072              (and (characterp key)
2073                   (not (eq key (downcase key)))))))
2074       (let ((in-shifted-motion-command t))
2075         (push-mark nil nil t))))
2076
2077 (defun handle-post-motion-command ()
2078   (if
2079       (and
2080        (handle-pre-motion-command-current-command-is-motion)
2081        zmacs-regions
2082        (region-active-p))
2083       ;; Special-case alphabetic keysyms, because the `shift'
2084       ;; modifier does not appear on them.  See above.
2085       (cond ((or (memq 'shift (event-modifiers last-input-event))
2086                  (let ((key (event-key last-input-event)))
2087                    (and (characterp key)
2088                         (not (eq key (downcase key))))))
2089              (if shifted-motion-keys-select-region
2090                  (putf this-command-properties 'shifted-motion-command t))
2091              (setq zmacs-region-stays t))
2092             ((and (getf last-command-properties 'shifted-motion-command)
2093                   unshifted-motion-keys-deselect-region)
2094              (setq zmacs-region-stays nil)))))
2095
2096 (defun forward-char-command (&optional arg buffer)
2097   "Move point right ARG characters (left if ARG negative) in BUFFER.
2098 On attempt to pass end of buffer, stop and signal `end-of-buffer'.
2099 On attempt to pass beginning of buffer, stop and signal `beginning-of-buffer'.
2100 Error signaling is suppressed if `signal-error-on-buffer-boundary'
2101 is nil.  If BUFFER is nil, the current buffer is assumed.
2102
2103 The characters that are moved over may be added to the current selection
2104 \(i.e. active region) if the Shift key is held down, a motion key is used
2105 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2106 the documentation for this variable for more details."
2107   (interactive "_p")
2108   (if signal-error-on-buffer-boundary
2109       (forward-char arg buffer)
2110     (condition-case nil
2111         (forward-char arg buffer)
2112       (beginning-of-buffer nil)
2113       (end-of-buffer nil))))
2114
2115 (defun backward-char-command (&optional arg buffer)
2116   "Move point left ARG characters (right if ARG negative) in BUFFER.
2117 On attempt to pass end of buffer, stop and signal `end-of-buffer'.
2118 On attempt to pass beginning of buffer, stop and signal `beginning-of-buffer'.
2119 Error signaling is suppressed if `signal-error-on-buffer-boundary'
2120 is nil.  If BUFFER is nil, the current buffer is assumed.
2121
2122 The characters that are moved over may be added to the current selection
2123 \(i.e. active region) if the Shift key is held down, a motion key is used
2124 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2125 the documentation for this variable for more details."
2126   (interactive "_p")
2127   (if signal-error-on-buffer-boundary
2128       (backward-char arg buffer)
2129     (condition-case nil
2130         (backward-char arg buffer)
2131       (beginning-of-buffer nil)
2132       (end-of-buffer nil))))
2133
2134 (defun scroll-up-one ()
2135   "Scroll text of current window upward one line.
2136 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2137 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2138 signaled.
2139
2140 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2141 boundaries do not cause an error to be signaled."
2142   (interactive "_")
2143   (scroll-up-command 1))
2144
2145 (defun scroll-up-command (&optional n)
2146   "Scroll current window upward N lines; or near full screen if N is nil.
2147 A near full screen is `next-screen-context-lines' less than a full screen.
2148 Negative N means scroll downward.
2149 When calling from a program, supply a number as argument or nil.
2150 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2151 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2152 signaled.
2153
2154 The characters that are moved over may be added to the current selection
2155 \(i.e. active region) if the Shift key is held down, a motion key is used
2156 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2157 the documentation for this variable for more details.
2158
2159 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2160 boundaries do not cause an error to be signaled."
2161   (interactive "_P")
2162   (if signal-error-on-buffer-boundary
2163       (scroll-up n)
2164     (condition-case nil
2165         (scroll-up n)
2166       (beginning-of-buffer nil)
2167       (end-of-buffer nil))))
2168
2169 (defun scroll-down-one ()
2170   "Scroll text of current window downward one line.
2171 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2172 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2173 signaled.
2174
2175 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2176 boundaries do not cause an error to be signaled."
2177   (interactive "_")
2178   (scroll-down-command 1))
2179
2180 (defun scroll-down-command (&optional n)
2181   "Scroll current window downward N lines; or near full screen if N is nil.
2182 A near full screen is `next-screen-context-lines' less than a full screen.
2183 Negative N means scroll upward.
2184 When calling from a program, supply a number as argument or nil.
2185 On attempt to scroll past end of buffer, `end-of-buffer' is signaled.
2186 On attempt to scroll past beginning of buffer, `beginning-of-buffer' is
2187 signaled.
2188
2189 If `signal-error-on-buffer-boundary' is nil, attempts to scroll past buffer
2190 boundaries do not cause an error to be signaled.
2191
2192 The characters that are moved over may be added to the current selection
2193 \(i.e. active region) if the Shift key is held down, a motion key is used
2194 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2195 the documentation for this variable for more details."
2196   (interactive "_P")
2197   (if signal-error-on-buffer-boundary
2198       (scroll-down n)
2199     (condition-case nil
2200         (scroll-down n)
2201       (beginning-of-buffer nil)
2202       (end-of-buffer nil))))
2203
2204 (defun next-line (count)
2205   "Move cursor vertically down COUNT lines.
2206 If there is no character in the target line exactly under the current column,
2207 the cursor is positioned after the character in that line which spans this
2208 column, or at the end of the line if it is not long enough.
2209
2210 If there is no line in the buffer after this one, behavior depends on the
2211 value of `next-line-add-newlines'.  If non-nil, it inserts a newline character
2212 to create a line, and moves the cursor to that line.  Otherwise it moves the
2213 cursor to the end of the buffer.
2214
2215 The command \\[set-goal-column] can be used to create
2216 a semipermanent goal column to which this command always moves.
2217 Then it does not try to move vertically.  This goal column is stored
2218 in `goal-column', which is nil when there is none.
2219
2220 The characters that are moved over may be added to the current selection
2221 \(i.e. active region) if the Shift key is held down, a motion key is used
2222 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2223 the documentation for this variable for more details.
2224
2225 If you are thinking of using this in a Lisp program, consider
2226 using `forward-line' instead.  It is usually easier to use
2227 and more reliable (no dependence on goal column, etc.)."
2228   (interactive "_p")
2229   (if (and next-line-add-newlines (= count 1))
2230       (let ((opoint (point)))
2231         (end-of-line)
2232         (if (eobp)
2233             (newline 1)
2234           (goto-char opoint)
2235           (line-move count)))
2236     (if (interactive-p)
2237         ;; XEmacs:  Not sure what to do about this.  It's inconsistent. -sb
2238         (condition-case nil
2239             (line-move count)
2240           ((beginning-of-buffer end-of-buffer)
2241            (when signal-error-on-buffer-boundary
2242              (ding nil 'buffer-bound))))
2243       (line-move count)))
2244   nil)
2245
2246 (defun previous-line (count)
2247   "Move cursor vertically up COUNT lines.
2248 If there is no character in the target line exactly over the current column,
2249 the cursor is positioned after the character in that line which spans this
2250 column, or at the end of the line if it is not long enough.
2251
2252 The command \\[set-goal-column] can be used to create
2253 a semipermanent goal column to which this command always moves.
2254 Then it does not try to move vertically.
2255
2256 The characters that are moved over may be added to the current selection
2257 \(i.e. active region) if the Shift key is held down, a motion key is used
2258 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2259 the documentation for this variable for more details.
2260
2261 If you are thinking of using this in a Lisp program, consider using
2262 `forward-line' with a negative argument instead.  It is usually easier
2263 to use and more reliable (no dependence on goal column, etc.)."
2264   (interactive "_p")
2265   (if (interactive-p)
2266       (condition-case nil
2267           (line-move (- count))
2268         ((beginning-of-buffer end-of-buffer)
2269          (when signal-error-on-buffer-boundary ; XEmacs
2270            (ding nil 'buffer-bound))))
2271     (line-move (- count)))
2272   nil)
2273
2274 (defcustom block-movement-size 6
2275   "*Number of lines that \"block movement\" commands (\\[forward-block-of-lines], \\[backward-block-of-lines]) move by."
2276   :type 'integer
2277   :group 'editing-basics)
2278
2279 (defun backward-block-of-lines ()
2280   "Move backward by one \"block\" of lines.
2281 The number of lines that make up a block is controlled by
2282 `block-movement-size', which defaults to 6.
2283
2284 The characters that are moved over may be added to the current selection
2285 \(i.e. active region) if the Shift key is held down, a motion key is used
2286 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2287 the documentation for this variable for more details."
2288   (interactive "_")
2289   (forward-line (- block-movement-size)))
2290
2291 (defun forward-block-of-lines ()
2292   "Move forward by one \"block\" of lines.
2293 The number of lines that make up a block is controlled by
2294 `block-movement-size', which defaults to 6.
2295
2296 The characters that are moved over may be added to the current selection
2297 \(i.e. active region) if the Shift key is held down, a motion key is used
2298 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2299 the documentation for this variable for more details."
2300   (interactive "_")
2301   (forward-line block-movement-size))
2302
2303 (defcustom track-eol nil
2304   "*Non-nil means vertical motion starting at end of line keeps to ends of lines.
2305 This means moving to the end of each line moved onto.
2306 The beginning of a blank line does not count as the end of a line."
2307   :type 'boolean
2308   :group 'editing-basics)
2309
2310 (defcustom goal-column nil
2311   "*Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil."
2312   :type '(choice integer (const :tag "None" nil))
2313   :group 'editing-basics)
2314 (make-variable-buffer-local 'goal-column)
2315
2316 (defvar temporary-goal-column 0
2317   "Current goal column for vertical motion.
2318 It is the column where point was
2319 at the start of current run of vertical motion commands.
2320 When the `track-eol' feature is doing its job, the value is 9999.")
2321 (make-variable-buffer-local 'temporary-goal-column)
2322
2323 ;XEmacs: not yet ported, so avoid compiler warnings
2324 (eval-when-compile
2325   (defvar inhibit-point-motion-hooks))
2326
2327 (defcustom line-move-ignore-invisible nil
2328   "*Non-nil means \\[next-line] and \\[previous-line] ignore invisible lines.
2329 Use with care, as it slows down movement significantly.  Outline mode sets this."
2330   :type 'boolean
2331   :group 'editing-basics)
2332
2333 ;; This is the guts of next-line and previous-line.
2334 ;; Count says how many lines to move.
2335 (defun line-move (count)
2336   ;; Don't run any point-motion hooks, and disregard intangibility,
2337   ;; for intermediate positions.
2338   (let ((inhibit-point-motion-hooks t)
2339         (opoint (point))
2340         new)
2341     (unwind-protect
2342         (progn
2343           (if (not (or (eq last-command 'next-line)
2344                        (eq last-command 'previous-line)))
2345               (setq temporary-goal-column
2346                     (if (and track-eol (eolp)
2347                              ;; Don't count start of empty line as end of line
2348                              ;; unless we just did explicit end-of-line.
2349                              (or (not (bolp)) (eq last-command 'end-of-line)))
2350                         9999
2351                       (current-column))))
2352           (if (and (not (integerp selective-display))
2353                    (not line-move-ignore-invisible))
2354               ;; Use just newline characters.
2355               (or (if (> count 0)
2356                       (progn (if (> count 1) (forward-line (1- count)))
2357                              ;; This way of moving forward COUNT lines
2358                              ;; verifies that we have a newline after the last one.
2359                              ;; It doesn't get confused by intangible text.
2360                              (end-of-line)
2361                              (zerop (forward-line 1)))
2362                     (and (zerop (forward-line count))
2363                          (bolp)))
2364                   (signal (if (< count 0)
2365                               'beginning-of-buffer
2366                             'end-of-buffer)
2367                           nil))
2368             ;; Move by count lines, but ignore invisible ones.
2369             (while (> count 0)
2370               (end-of-line)
2371               (and (zerop (vertical-motion 1))
2372                    (signal 'end-of-buffer nil))
2373               ;; If the following character is currently invisible,
2374               ;; skip all characters with that same `invisible' property value.
2375               (while (and (not (eobp))
2376                           (let ((prop
2377                                  (get-char-property (point) 'invisible)))
2378                             (if (eq buffer-invisibility-spec t)
2379                                 prop
2380                               (or (memq prop buffer-invisibility-spec)
2381                                   (assq prop buffer-invisibility-spec)))))
2382                 (if (get-text-property (point) 'invisible)
2383                     (goto-char (next-single-property-change (point) 'invisible))
2384                   (goto-char (next-extent-change (point))))) ; XEmacs
2385               (setq count (1- count)))
2386             (while (< count 0)
2387               (beginning-of-line)
2388               (and (zerop (vertical-motion -1))
2389                    (signal 'beginning-of-buffer nil))
2390               (while (and (not (bobp))
2391                           (let ((prop
2392                                  (get-char-property (1- (point)) 'invisible)))
2393                             (if (eq buffer-invisibility-spec t)
2394                                 prop
2395                               (or (memq prop buffer-invisibility-spec)
2396                                   (assq prop buffer-invisibility-spec)))))
2397                 (if (get-text-property (1- (point)) 'invisible)
2398                     (goto-char (previous-single-property-change (point) 'invisible))
2399                   (goto-char (previous-extent-change (point))))) ; XEmacs
2400               (setq count (1+ count))))
2401           (move-to-column (or goal-column temporary-goal-column)))
2402       ;; Remember where we moved to, go back home,
2403       ;; then do the motion over again
2404       ;; in just one step, with intangibility and point-motion hooks
2405       ;; enabled this time.
2406       (setq new (point))
2407       (goto-char opoint)
2408       (setq inhibit-point-motion-hooks nil)
2409       (goto-char new)))
2410   nil)
2411
2412 ;;; Many people have said they rarely use this feature, and often type
2413 ;;; it by accident.  Maybe it shouldn't even be on a key.
2414 ;; It's not on a key, as of 20.2.  So no need for this.
2415 ;(put 'set-goal-column 'disabled t)
2416
2417 (defun set-goal-column (column)
2418   "Set the current horizontal position as a goal for \\[next-line] and \\[previous-line].
2419 Those commands will move to this position in the line moved to
2420 rather than trying to keep the same horizontal position.
2421 With a non-nil argument, clears out the goal column
2422 so that \\[next-line] and \\[previous-line] resume vertical motion.
2423 The goal column is stored in the variable `goal-column'."
2424   (interactive "_P") ; XEmacs
2425   (if column
2426       (progn
2427         (setq goal-column nil)
2428         (display-message 'command "No goal column"))
2429     (setq goal-column (current-column))
2430     (lmessage 'command
2431         "Goal column %d (use %s with a prefix arg to unset it)"
2432       goal-column
2433       (substitute-command-keys "\\[set-goal-column]")))
2434   nil)
2435 \f
2436 ;; deleted FSFmacs terminal randomness hscroll-point-visible stuff.
2437 ;; hscroll-step
2438 ;; hscroll-point-visible
2439 ;; hscroll-window-column
2440 ;; right-arrow
2441 ;; left-arrow
2442
2443 (defun scroll-other-window-down (lines)
2444   "Scroll the \"other window\" down.
2445 For more details, see the documentation for `scroll-other-window'."
2446   (interactive "P")
2447   (scroll-other-window
2448    ;; Just invert the argument's meaning.
2449    ;; We can do that without knowing which window it will be.
2450    (if (eq lines '-) nil
2451      (if (null lines) '-
2452        (- (prefix-numeric-value lines))))))
2453 ;(define-key esc-map [?\C-\S-v] 'scroll-other-window-down)
2454
2455 (defun beginning-of-buffer-other-window (arg)
2456   "Move point to the beginning of the buffer in the other window.
2457 Leave mark at previous position.
2458 With arg N, put point N/10 of the way from the true beginning."
2459   (interactive "P")
2460   (let ((orig-window (selected-window))
2461         (window (other-window-for-scrolling)))
2462     ;; We use unwind-protect rather than save-window-excursion
2463     ;; because the latter would preserve the things we want to change.
2464     (unwind-protect
2465         (progn
2466           (select-window window)
2467           ;; Set point and mark in that window's buffer.
2468           (beginning-of-buffer arg)
2469           ;; Set point accordingly.
2470           (recenter '(t)))
2471       (select-window orig-window))))
2472
2473 (defun end-of-buffer-other-window (arg)
2474   "Move point to the end of the buffer in the other window.
2475 Leave mark at previous position.
2476 With arg N, put point N/10 of the way from the true end."
2477   (interactive "P")
2478   ;; See beginning-of-buffer-other-window for comments.
2479   (let ((orig-window (selected-window))
2480         (window (other-window-for-scrolling)))
2481     (unwind-protect
2482         (progn
2483           (select-window window)
2484           (end-of-buffer arg)
2485           (recenter '(t)))
2486       (select-window orig-window))))
2487 \f
2488 (defun transpose-chars (arg)
2489   "Interchange characters around point, moving forward one character.
2490 With prefix arg ARG, effect is to take character before point
2491 and drag it forward past ARG other characters (backward if ARG negative).
2492 If no argument and at end of line, the previous two chars are exchanged."
2493   (interactive "*P")
2494   (and (null arg) (eolp) (backward-char 1))
2495   (transpose-subr 'forward-char (prefix-numeric-value arg)))
2496
2497 ;;; A very old implementation of transpose-chars from the old days ...
2498 (defun transpose-preceding-chars (arg)
2499   "Interchange characters before point.
2500 With prefix arg ARG, effect is to take character before point
2501 and drag it forward past ARG other characters (backward if ARG negative).
2502 If no argument and not at start of line, the previous two chars are exchanged."
2503   (interactive "*P")
2504   (and (null arg) (not (bolp)) (backward-char 1))
2505   (transpose-subr 'forward-char (prefix-numeric-value arg)))
2506
2507
2508 (defun transpose-words (arg)
2509   "Interchange words around point, leaving point at end of them.
2510 With prefix arg ARG, effect is to take word before or around point
2511 and drag it forward past ARG other words (backward if ARG negative).
2512 If ARG is zero, the words around or after point and around or after mark
2513 are interchanged."
2514   (interactive "*p")
2515   (transpose-subr 'forward-word arg))
2516
2517 (defun transpose-sexps (arg)
2518   "Like \\[transpose-words] but applies to sexps.
2519 Does not work on a sexp that point is in the middle of
2520 if it is a list or string."
2521   (interactive "*p")
2522   (transpose-subr 'forward-sexp arg))
2523
2524 (defun transpose-lines (arg)
2525   "Exchange current line and previous line, leaving point after both.
2526 With argument ARG, takes previous line and moves it past ARG lines.
2527 With argument 0, interchanges line point is in with line mark is in."
2528   (interactive "*p")
2529   (transpose-subr #'(lambda (arg)
2530                      (if (= arg 1)
2531                          (progn
2532                            ;; Move forward over a line,
2533                            ;; but create a newline if none exists yet.
2534                            (end-of-line)
2535                            (if (eobp)
2536                                (newline)
2537                              (forward-char 1)))
2538                        (forward-line arg)))
2539                   arg))
2540
2541 (defun transpose-line-up (arg)
2542   "Move current line one line up, leaving point at beginning of that line.
2543 This can be run repeatedly to move the current line up a number of lines."
2544   (interactive "*p")
2545   ;; Move forward over a line,
2546   ;; but create a newline if none exists yet.
2547   (end-of-line)
2548   (if (eobp)
2549       (newline)
2550     (forward-char 1))
2551   (transpose-lines (- arg))
2552   (forward-line -1))
2553
2554 (defun transpose-line-down (arg)
2555   "Move current line one line down, leaving point at beginning of that line.
2556 This can be run repeatedly to move the current line down a number of lines."
2557   (interactive "*p")
2558   ;; Move forward over a line,
2559   ;; but create a newline if none exists yet.
2560   (end-of-line)
2561   (if (eobp)
2562       (newline)
2563     (forward-char 1))
2564   (transpose-lines arg)
2565   (forward-line -1))
2566
2567 (defun transpose-subr (mover arg)
2568   (let (start1 end1 start2 end2)
2569     ;; XEmacs -- use flet instead of defining a separate function and
2570     ;; relying on dynamic scope!!!
2571     (flet ((transpose-subr-1 ()
2572              (if (> (min end1 end2) (max start1 start2))
2573                  (error "Don't have two things to transpose"))
2574              (let ((word1 (buffer-substring start1 end1))
2575                    (word2 (buffer-substring start2 end2)))
2576                (delete-region start2 end2)
2577                (goto-char start2)
2578                (insert word1)
2579                (goto-char (if (< start1 start2) start1
2580                             (+ start1 (- (length word1) (length word2)))))
2581                (delete-char (length word1))
2582                (insert word2))))
2583       (if (= arg 0)
2584           (progn
2585             (save-excursion
2586               (funcall mover 1)
2587               (setq end2 (point))
2588               (funcall mover -1)
2589               (setq start2 (point))
2590               (goto-char (mark t)) ; XEmacs
2591               (funcall mover 1)
2592               (setq end1 (point))
2593               (funcall mover -1)
2594               (setq start1 (point))
2595               (transpose-subr-1))
2596             (exchange-point-and-mark t))) ; XEmacs
2597       (while (> arg 0)
2598         (funcall mover -1)
2599         (setq start1 (point))
2600         (funcall mover 1)
2601         (setq end1 (point))
2602         (funcall mover 1)
2603         (setq end2 (point))
2604         (funcall mover -1)
2605         (setq start2 (point))
2606         (transpose-subr-1)
2607         (goto-char end2)
2608         (setq arg (1- arg)))
2609       (while (< arg 0)
2610         (funcall mover -1)
2611         (setq start2 (point))
2612         (funcall mover -1)
2613         (setq start1 (point))
2614         (funcall mover 1)
2615         (setq end1 (point))
2616         (funcall mover 1)
2617         (setq end2 (point))
2618         (transpose-subr-1)
2619         (setq arg (1+ arg))))))
2620
2621 \f
2622 (defcustom comment-column 32
2623   "*Column to indent right-margin comments to.
2624 Setting this variable automatically makes it local to the current buffer.
2625 Each mode establishes a different default value for this variable; you
2626 can set the value for a particular mode using that mode's hook."
2627   :type 'integer
2628   :group 'fill-comments)
2629 (make-variable-buffer-local 'comment-column)
2630
2631 (defcustom comment-start nil
2632   "*String to insert to start a new comment, or nil if no comment syntax."
2633   :type '(choice (const :tag "None" nil)
2634                  string)
2635   :group 'fill-comments)
2636
2637 (defcustom comment-start-skip nil
2638   "*Regexp to match the start of a comment plus everything up to its body.
2639 If there are any \\(...\\) pairs, the comment delimiter text is held to begin
2640 at the place matched by the close of the first pair."
2641   :type '(choice (const :tag "None" nil)
2642                  regexp)
2643   :group 'fill-comments)
2644
2645 (defcustom comment-end ""
2646   "*String to insert to end a new comment.
2647 Should be an empty string if comments are terminated by end-of-line."
2648   :type 'string
2649   :group 'fill-comments)
2650
2651 (defconst comment-indent-hook nil
2652   "Obsolete variable for function to compute desired indentation for a comment.
2653 Use `comment-indent-function' instead.
2654 This function is called with no args with point at the beginning of
2655 the comment's starting delimiter.")
2656
2657 (defconst comment-indent-function
2658   ;; XEmacs - add at least one space after the end of the text on the
2659   ;; current line...
2660   (lambda ()
2661     (save-excursion
2662       (beginning-of-line)
2663       (let ((eol (save-excursion (end-of-line) (point))))
2664         (and comment-start-skip
2665              (re-search-forward comment-start-skip eol t)
2666              (setq eol (match-beginning 0)))
2667         (goto-char eol)
2668         (skip-chars-backward " \t")
2669         (max comment-column (1+ (current-column))))))
2670   "Function to compute desired indentation for a comment.
2671 This function is called with no args with point at the beginning of
2672 the comment's starting delimiter.")
2673
2674 (defcustom block-comment-start nil
2675   "*String to insert to start a new comment on a line by itself.
2676 If nil, use `comment-start' instead.
2677 Note that the regular expression `comment-start-skip' should skip this string
2678 as well as the `comment-start' string."
2679   :type '(choice (const :tag "Use `comment-start'" nil)
2680                  string)
2681   :group 'fill-comments)
2682
2683 (defcustom block-comment-end nil
2684   "*String to insert to end a new comment on a line by itself.
2685 Should be an empty string if comments are terminated by end-of-line.
2686 If nil, use `comment-end' instead."
2687   :type '(choice (const :tag "Use `comment-end'" nil)
2688                  string)
2689   :group 'fill-comments)
2690
2691 (defun indent-for-comment ()
2692   "Indent this line's comment to comment column, or insert an empty
2693 comment.  Comments starting in column 0 are not moved."
2694   (interactive "*")
2695   (let* ((empty (save-excursion (beginning-of-line)
2696                                 (looking-at "[ \t]*$")))
2697          (starter (or (and empty block-comment-start) comment-start))
2698          (ender (or (and empty block-comment-end) comment-end)))
2699     (if (null starter)
2700         (error "No comment syntax defined")
2701       (let* ((eolpos (save-excursion (end-of-line) (point)))
2702              cpos indent begpos)
2703         (beginning-of-line)
2704         (if (re-search-forward comment-start-skip eolpos 'move)
2705             (progn (setq cpos (point-marker))
2706                    ;; Find the start of the comment delimiter.
2707                    ;; If there were paren-pairs in comment-start-skip,
2708                    ;; position at the end of the first pair.
2709                    (if (match-end 1)
2710                        (goto-char (match-end 1))
2711                      ;; If comment-start-skip matched a string with
2712                      ;; internal whitespace (not final whitespace) then
2713                      ;; the delimiter start at the end of that
2714                      ;; whitespace.  Otherwise, it starts at the
2715                      ;; beginning of what was matched.
2716                      (skip-syntax-backward " " (match-beginning 0))
2717                      (skip-syntax-backward "^ " (match-beginning 0)))))
2718         (setq begpos (point))
2719         ;; Compute desired indent.
2720         ;; XEmacs change: Preserve indentation of comments starting in
2721         ;; column 0, as documented.
2722         (cond
2723          ((= (current-column) 0)
2724           (goto-char begpos))
2725          ((= (current-column)
2726              (setq indent (funcall comment-indent-function)))
2727           (goto-char begpos))
2728          (t
2729           ;; If that's different from current, change it.
2730           (skip-chars-backward " \t")
2731           (delete-region (point) begpos)
2732           (indent-to indent)))
2733         ;; An existing comment?
2734         (if cpos
2735             (progn (goto-char cpos)
2736                    (set-marker cpos nil))
2737           ;; No, insert one.
2738           (insert starter)
2739           (save-excursion
2740             (insert ender)))))))
2741
2742 (defun set-comment-column (arg)
2743   "Set the comment column based on point.
2744 With no arg, set the comment column to the current column.
2745 With just minus as arg, kill any comment on this line.
2746 With any other arg, set comment column to indentation of the previous comment
2747  and then align or create a comment on this line at that column."
2748   (interactive "P")
2749   (if (eq arg '-)
2750       (kill-comment nil)
2751     (if arg
2752         (progn
2753           (save-excursion
2754             (beginning-of-line)
2755             (re-search-backward comment-start-skip)
2756             (beginning-of-line)
2757             (re-search-forward comment-start-skip)
2758             (goto-char (match-beginning 0))
2759             (setq comment-column (current-column))
2760             (lmessage 'command "Comment column set to %d" comment-column))
2761           (indent-for-comment))
2762       (setq comment-column (current-column))
2763       (lmessage 'command "Comment column set to %d" comment-column))))
2764
2765 (defun kill-comment (arg)
2766   "Kill the comment on this line, if any.
2767 With argument, kill comments on that many lines starting with this one."
2768   ;; this function loses in a lot of situations.  it incorrectly recognizes
2769   ;; comment delimiters sometimes (ergo, inside a string), doesn't work
2770   ;; with multi-line comments, can kill extra whitespace if comment wasn't
2771   ;; through end-of-line, et cetera.
2772   (interactive "*P")
2773   (or comment-start-skip (error "No comment syntax defined"))
2774   (let ((count (prefix-numeric-value arg)) endc)
2775     (while (> count 0)
2776       (save-excursion
2777         (end-of-line)
2778         (setq endc (point))
2779         (beginning-of-line)
2780         (and (string< "" comment-end)
2781              (setq endc
2782                    (progn
2783                      (re-search-forward (regexp-quote comment-end) endc 'move)
2784                      (skip-chars-forward " \t")
2785                      (point))))
2786         (beginning-of-line)
2787         (if (re-search-forward comment-start-skip endc t)
2788             (progn
2789               (goto-char (match-beginning 0))
2790               (skip-chars-backward " \t")
2791               (kill-region (point) endc)
2792               ;; to catch comments a line beginnings
2793               (indent-according-to-mode))))
2794       (if arg (forward-line 1))
2795       (setq count (1- count)))))
2796
2797 (defun comment-region (start end &optional arg)
2798   "Comment or uncomment each line in the region.
2799 With just C-u prefix arg, uncomment each line in region.
2800 Numeric prefix arg ARG means use ARG comment characters.
2801 If ARG is negative, delete that many comment characters instead.
2802 Comments are terminated on each line, even for syntax in which newline does
2803 not end the comment.  Blank lines do not get comments."
2804   ;; if someone wants it to only put a comment-start at the beginning and
2805   ;; comment-end at the end then typing it, C-x C-x, closing it, C-x C-x
2806   ;; is easy enough.  No option is made here for other than commenting
2807   ;; every line.
2808   (interactive "r\nP")
2809   (or comment-start (error "No comment syntax is defined"))
2810   (if (> start end) (let (mid) (setq mid start start end end mid)))
2811   (save-excursion
2812     (save-restriction
2813       (let ((cs comment-start) (ce comment-end)
2814             numarg)
2815         (if (consp arg) (setq numarg t)
2816           (setq numarg (prefix-numeric-value arg))
2817           ;; For positive arg > 1, replicate the comment delims now,
2818           ;; then insert the replicated strings just once.
2819           (while (> numarg 1)
2820             (setq cs (concat cs comment-start)
2821                   ce (concat ce comment-end))
2822             (setq numarg (1- numarg))))
2823         ;; Loop over all lines from START to END.
2824         (narrow-to-region start end)
2825         (goto-char start)
2826         (while (not (eobp))
2827           (if (or (eq numarg t) (< numarg 0))
2828               (progn
2829                 ;; Delete comment start from beginning of line.
2830                 (if (eq numarg t)
2831                     (while (looking-at (regexp-quote cs))
2832                       (delete-char (length cs)))
2833                   (let ((count numarg))
2834                     (while (and (> 1 (setq count (1+ count)))
2835                                 (looking-at (regexp-quote cs)))
2836                       (delete-char (length cs)))))
2837                 ;; Delete comment end from end of line.
2838                 (if (string= "" ce)
2839                     nil
2840                   (if (eq numarg t)
2841                       (progn
2842                         (end-of-line)
2843                         ;; This is questionable if comment-end ends in
2844                         ;; whitespace.  That is pretty brain-damaged,
2845                         ;; though.
2846                         (skip-chars-backward " \t")
2847                         (if (and (>= (- (point) (point-min)) (length ce))
2848                                  (save-excursion
2849                                    (backward-char (length ce))
2850                                    (looking-at (regexp-quote ce))))
2851                             (delete-char (- (length ce)))))
2852                     (let ((count numarg))
2853                       (while (> 1 (setq count (1+ count)))
2854                         (end-of-line)
2855                         ;; This is questionable if comment-end ends in
2856                         ;; whitespace.  That is pretty brain-damaged though
2857                         (skip-chars-backward " \t")
2858                         (save-excursion
2859                           (backward-char (length ce))
2860                           (if (looking-at (regexp-quote ce))
2861                               (delete-char (length ce))))))))
2862                 (forward-line 1))
2863             ;; Insert at beginning and at end.
2864             (if (looking-at "[ \t]*$") ()
2865               (insert cs)
2866               (if (string= "" ce) ()
2867                 (end-of-line)
2868                 (insert ce)))
2869             (search-forward "\n" nil 'move)))))))
2870
2871 ;; XEmacs
2872 (defun prefix-region (prefix)
2873   "Add a prefix string to each line between mark and point."
2874   (interactive "sPrefix string: ")
2875   (if prefix
2876       (let ((count (count-lines (mark) (point))))
2877         (goto-char (min (mark) (point)))
2878         (while (> count 0)
2879           (setq count (1- count))
2880           (beginning-of-line 1)
2881           (insert prefix)
2882           (end-of-line 1)
2883           (forward-char 1)))))
2884
2885 \f
2886 (defun backward-word (&optional count buffer)
2887   "Move point backward COUNT words (forward if COUNT is negative).
2888 Normally t is returned, but if an edge of the buffer is reached,
2889 point is left there and nil is returned.
2890
2891 COUNT defaults to 1, and BUFFER defaults to the current buffer.
2892
2893 The characters that are moved over may be added to the current selection
2894 \(i.e. active region) if the Shift key is held down, a motion key is used
2895 to invoke this command, and `shifted-motion-keys-select-region' is t; see
2896 the documentation for this variable for more details."
2897   (interactive "_p")
2898   (forward-word (- (or count 1)) buffer))
2899
2900 (defun mark-word (&optional count)
2901   "Mark the text from point until encountering the end of a word.
2902 With optional argument COUNT, mark COUNT words."
2903   (interactive "p")
2904   (mark-something 'mark-word 'forward-word count))
2905
2906 (defun kill-word (&optional count)
2907   "Kill characters forward until encountering the end of a word.
2908 With optional argument COUNT, do this that many times."
2909   (interactive "*p")
2910   (kill-region (point) (save-excursion (forward-word count) (point))))
2911
2912 (defun backward-kill-word (&optional count)
2913   "Kill characters backward until encountering the end of a word.
2914 With argument, do this that many times."
2915   (interactive "*p")
2916   (kill-word (- (or count 1))))
2917
2918 (defun current-word (&optional strict)
2919   "Return the word point is on (or a nearby word) as a string.
2920 If optional arg STRICT is non-nil, return nil unless point is within
2921 or adjacent to a word.
2922 If point is not between two word-constituent characters, but immediately
2923 follows one, move back first.
2924 Otherwise, if point precedes a word constituent, move forward first.
2925 Otherwise, move backwards until a word constituent is found and get that word;
2926 if you a newlines is reached first, move forward instead."
2927   (save-excursion
2928     (let ((oldpoint (point)) (start (point)) (end (point)))
2929       (skip-syntax-backward "w_") (setq start (point))
2930       (goto-char oldpoint)
2931       (skip-syntax-forward "w_") (setq end (point))
2932       (if (and (eq start oldpoint) (eq end oldpoint))
2933           ;; Point is neither within nor adjacent to a word.
2934           (and (not strict)
2935                (progn
2936                  ;; Look for preceding word in same line.
2937                  (skip-syntax-backward "^w_"
2938                                        (save-excursion
2939                                          (beginning-of-line) (point)))
2940                  (if (bolp)
2941                      ;; No preceding word in same line.
2942                      ;; Look for following word in same line.
2943                      (progn
2944                        (skip-syntax-forward "^w_"
2945                                             (save-excursion
2946                                               (end-of-line) (point)))
2947                        (setq start (point))
2948                        (skip-syntax-forward "w_")
2949                        (setq end (point)))
2950                      (setq end (point))
2951                      (skip-syntax-backward "w_")
2952                      (setq start (point)))
2953                  (buffer-substring start end)))
2954           (buffer-substring start end)))))
2955 \f
2956 (defcustom fill-prefix nil
2957   "*String for filling to insert at front of new line, or nil for none.
2958 Setting this variable automatically makes it local to the current buffer."
2959   :type '(choice (const :tag "None" nil)
2960                  string)
2961   :group 'fill)
2962 (make-variable-buffer-local 'fill-prefix)
2963
2964 (defcustom auto-fill-inhibit-regexp nil
2965   "*Regexp to match lines which should not be auto-filled."
2966   :type '(choice (const :tag "None" nil)
2967                  regexp)
2968   :group 'fill)
2969
2970 (defvar comment-line-break-function 'indent-new-comment-line
2971   "*Mode-specific function which line breaks and continues a comment.
2972
2973 This function is only called during auto-filling of a comment section.
2974 The function should take a single optional argument which is a flag
2975 indicating whether soft newlines should be inserted.")
2976
2977 ;; defined in mule-base/mule-category.el
2978 (defvar word-across-newline)
2979
2980 ;; This function is the auto-fill-function of a buffer
2981 ;; when Auto-Fill mode is enabled.
2982 ;; It returns t if it really did any work.
2983 ;; XEmacs:  This function is totally different.
2984 (defun do-auto-fill ()
2985   (let (give-up)
2986     (or (and auto-fill-inhibit-regexp
2987              (save-excursion (beginning-of-line)
2988                              (looking-at auto-fill-inhibit-regexp)))
2989         (while (and (not give-up) (> (current-column) fill-column))
2990           ;; Determine where to split the line.
2991           (let ((fill-prefix fill-prefix)
2992                 (fill-point
2993                  (let ((opoint (point))
2994                        bounce
2995                        ;; 97/3/14 jhod: Kinsoku
2996                        (re-break-point (if (featurep 'mule)
2997                                             (concat "[ \t\n]\\|" word-across-newline
2998                                                     ".\\|." word-across-newline)
2999                                         "[ \t\n]"))
3000                        ;; end patch
3001                        (first t))
3002                    (save-excursion
3003                      (move-to-column (1+ fill-column))
3004                      ;; Move back to a word boundary.
3005                      (while (or first
3006                                 ;; If this is after period and a single space,
3007                                 ;; move back once more--we don't want to break
3008                                 ;; the line there and make it look like a
3009                                 ;; sentence end.
3010                                 (and (not (bobp))
3011                                      (not bounce)
3012                                      sentence-end-double-space
3013                                      (save-excursion (backward-char 1)
3014                                                      (and (looking-at "\\. ")
3015                                                           (not (looking-at "\\.  "))))))
3016                        (setq first nil)
3017                        ;; 97/3/14 jhod: Kinsoku
3018                        ; (skip-chars-backward "^ \t\n"))
3019                        (fill-move-backward-to-break-point re-break-point)
3020                        ;; end patch
3021                        ;; If we find nowhere on the line to break it,
3022                        ;; break after one word.  Set bounce to t
3023                        ;; so we will not keep going in this while loop.
3024                        (if (bolp)
3025                            (progn
3026                              ;; 97/3/14 jhod: Kinsoku
3027                              ; (re-search-forward "[ \t]" opoint t)
3028                              (fill-move-forward-to-break-point re-break-point
3029                                                                opoint)
3030                              ;; end patch
3031                              (setq bounce t)))
3032                        (skip-chars-backward " \t"))
3033                      (if (and (featurep 'mule)
3034                               (or bounce (bolp))) (kinsoku-process)) ;; 97/3/14 jhod: Kinsoku
3035                      ;; Let fill-point be set to the place where we end up.
3036                      (point)))))
3037
3038             ;; I'm not sure why Stig made this change but it breaks
3039             ;; auto filling in at least C mode so I'm taking it back
3040             ;; out.  --cet
3041             ;; XEmacs - adaptive fill.
3042             ;;(maybe-adapt-fill-prefix
3043             ;; (or from (setq from (save-excursion (beginning-of-line)
3044             ;;                                   (point))))
3045             ;; (or to   (setq to (save-excursion (beginning-of-line 2)
3046             ;;                                 (point))))
3047             ;; t)
3048
3049             ;; If that place is not the beginning of the line,
3050             ;; break the line there.
3051             (if (save-excursion
3052                   (goto-char fill-point)
3053                   (not (or (bolp) (eolp)))) ; 97/3/14 jhod: during kinsoku processing it is possible to move beyond
3054                 (let ((prev-column (current-column)))
3055                   ;; If point is at the fill-point, do not `save-excursion'.
3056                   ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3057                   ;; point will end up before it rather than after it.
3058                   (if (save-excursion
3059                         (skip-chars-backward " \t")
3060                         (= (point) fill-point))
3061                       ;; 1999-09-17 hniksic: turn off Kinsoku until
3062                       ;; it's debugged.
3063                       (funcall comment-line-break-function)
3064                       ;; 97/3/14 jhod: Kinsoku processing
3065 ;                     ;(indent-new-comment-line)
3066 ;                     (let ((spacep (memq (char-before (point)) '(?\  ?\t))))
3067 ;                       (funcall comment-line-break-function)
3068 ;                       ;; if user type space explicitly, leave SPC
3069 ;                       ;; even if there is no WAN.
3070 ;                       (if spacep
3071 ;                           (save-excursion
3072 ;                             (goto-char fill-point)
3073 ;                             ;; put SPC except that there is SPC
3074 ;                             ;; already or there is sentence end.
3075 ;                             (or (memq (char-after (point)) '(?\  ?\t))
3076 ;                                 (fill-end-of-sentence-p)
3077 ;                                 (insert ?\ )))))
3078                     (save-excursion
3079                       (goto-char fill-point)
3080                       (funcall comment-line-break-function)))
3081                   ;; If making the new line didn't reduce the hpos of
3082                   ;; the end of the line, then give up now;
3083                   ;; trying again will not help.
3084                   (if (>= (current-column) prev-column)
3085                       (setq give-up t)))
3086               ;; No place to break => stop trying.
3087               (setq give-up t)))))))
3088
3089 ;; Put FSF one in until I can one or the other working properly, then the
3090 ;; other one is history.
3091 ;(defun fsf:do-auto-fill ()
3092 ;  (let (fc justify
3093 ;          ;; bol
3094 ;          give-up
3095 ;          (fill-prefix fill-prefix))
3096 ;    (if (or (not (setq justify (current-justification)))
3097 ;           (null (setq fc (current-fill-column)))
3098 ;           (and (eq justify 'left)
3099 ;                (<= (current-column) fc))
3100 ;           (save-excursion (beginning-of-line)
3101 ;                           ;; (setq bol (point))
3102 ;                           (and auto-fill-inhibit-regexp
3103 ;                                (looking-at auto-fill-inhibit-regexp))))
3104 ;       nil ;; Auto-filling not required
3105 ;      (if (memq justify '(full center right))
3106 ;         (save-excursion (unjustify-current-line)))
3107
3108 ;      ;; Choose a fill-prefix automatically.
3109 ;      (if (and adaptive-fill-mode
3110 ;              (or (null fill-prefix) (string= fill-prefix "")))
3111 ;         (let ((prefix
3112 ;                (fill-context-prefix
3113 ;                 (save-excursion (backward-paragraph 1) (point))
3114 ;                 (save-excursion (forward-paragraph 1) (point))
3115 ;                 ;; Don't accept a non-whitespace fill prefix
3116 ;                 ;; from the first line of a paragraph.
3117 ;                 "^[ \t]*$")))
3118 ;           (and prefix (not (equal prefix ""))
3119 ;                (setq fill-prefix prefix))))
3120
3121 ;      (while (and (not give-up) (> (current-column) fc))
3122 ;       ;; Determine where to split the line.
3123 ;       (let ((fill-point
3124 ;              (let ((opoint (point))
3125 ;                    bounce
3126 ;                    (first t))
3127 ;                (save-excursion
3128 ;                  (move-to-column (1+ fc))
3129 ;                  ;; Move back to a word boundary.
3130 ;                  (while (or first
3131 ;                             ;; If this is after period and a single space,
3132 ;                             ;; move back once more--we don't want to break
3133 ;                             ;; the line there and make it look like a
3134 ;                             ;; sentence end.
3135 ;                             (and (not (bobp))
3136 ;                                  (not bounce)
3137 ;                                  sentence-end-double-space
3138 ;                                  (save-excursion (backward-char 1)
3139 ;                                                  (and (looking-at "\\. ")
3140 ;                                                       (not (looking-at "\\.  "))))))
3141 ;                    (setq first nil)
3142 ;                    (skip-chars-backward "^ \t\n")
3143 ;                    ;; If we find nowhere on the line to break it,
3144 ;                    ;; break after one word.  Set bounce to t
3145 ;                    ;; so we will not keep going in this while loop.
3146 ;                    (if (bolp)
3147 ;                        (progn
3148 ;                          (re-search-forward "[ \t]" opoint t)
3149 ;                          (setq bounce t)))
3150 ;                    (skip-chars-backward " \t"))
3151 ;                  ;; Let fill-point be set to the place where we end up.
3152 ;                  (point)))))
3153 ;         ;; If that place is not the beginning of the line,
3154 ;         ;; break the line there.
3155 ;         (if (save-excursion
3156 ;               (goto-char fill-point)
3157 ;               (not (bolp)))
3158 ;             (let ((prev-column (current-column)))
3159 ;               ;; If point is at the fill-point, do not `save-excursion'.
3160 ;               ;; Otherwise, if a comment prefix or fill-prefix is inserted,
3161 ;               ;; point will end up before it rather than after it.
3162 ;               (if (save-excursion
3163 ;                     (skip-chars-backward " \t")
3164 ;                     (= (point) fill-point))
3165 ;                   (funcall comment-line-break-function t)
3166 ;                 (save-excursion
3167 ;                   (goto-char fill-point)
3168 ;                   (funcall comment-line-break-function t)))
3169 ;               ;; Now do justification, if required
3170 ;               (if (not (eq justify 'left))
3171 ;                   (save-excursion
3172 ;                     (end-of-line 0)
3173 ;                     (justify-current-line justify nil t)))
3174 ;               ;; If making the new line didn't reduce the hpos of
3175 ;               ;; the end of the line, then give up now;
3176 ;               ;; trying again will not help.
3177 ;               (if (>= (current-column) prev-column)
3178 ;                   (setq give-up t)))
3179 ;           ;; No place to break => stop trying.
3180 ;           (setq give-up t))))
3181 ;      ;; Justify last line.
3182 ;      (justify-current-line justify t t)
3183 ;      t)))
3184
3185 (defvar normal-auto-fill-function 'do-auto-fill
3186   "The function to use for `auto-fill-function' if Auto Fill mode is turned on.
3187 Some major modes set this.")
3188
3189 (defun auto-fill-mode (&optional arg)
3190   "Toggle auto-fill mode.
3191 With arg, turn auto-fill mode on if and only if arg is positive.
3192 In Auto-Fill mode, inserting a space at a column beyond `current-fill-column'
3193 automatically breaks the line at a previous space.
3194
3195 The value of `normal-auto-fill-function' specifies the function to use
3196 for `auto-fill-function' when turning Auto Fill mode on."
3197   (interactive "P")
3198   (prog1 (setq auto-fill-function
3199                (if (if (null arg)
3200                        (not auto-fill-function)
3201                        (> (prefix-numeric-value arg) 0))
3202                    normal-auto-fill-function
3203                    nil))
3204     (redraw-modeline)))
3205
3206 ;; This holds a document string used to document auto-fill-mode.
3207 (defun auto-fill-function ()
3208   "Automatically break line at a previous space, in insertion of text."
3209   nil)
3210
3211 (defun turn-on-auto-fill ()
3212   "Unconditionally turn on Auto Fill mode."
3213   (interactive)
3214   (auto-fill-mode 1))
3215
3216 (defun set-fill-column (arg)
3217   "Set `fill-column' to specified argument.
3218 Just \\[universal-argument] as argument means to use the current column
3219 The variable `fill-column' has a separate value for each buffer."
3220   (interactive "_P") ; XEmacs
3221   (cond ((integerp arg)
3222          (setq fill-column arg))
3223         ((consp arg)
3224          (setq fill-column (current-column)))
3225         ;; Disallow missing argument; it's probably a typo for C-x C-f.
3226         (t
3227          (error "set-fill-column requires an explicit argument")))
3228   (lmessage 'command "fill-column set to %d" fill-column))
3229 \f
3230 (defcustom comment-multi-line t ; XEmacs - this works well with adaptive fill
3231   "*Non-nil means \\[indent-new-comment-line] should continue same comment
3232 on new line, with no new terminator or starter.
3233 This is obsolete because you might as well use \\[newline-and-indent]."
3234   :type 'boolean
3235   :group 'fill-comments)
3236
3237 (defun indent-new-comment-line (&optional soft)
3238   "Break line at point and indent, continuing comment if within one.
3239 This indents the body of the continued comment
3240 under the previous comment line.
3241
3242 This command is intended for styles where you write a comment per line,
3243 starting a new comment (and terminating it if necessary) on each line.
3244 If you want to continue one comment across several lines, use \\[newline-and-indent].
3245
3246 If a fill column is specified, it overrides the use of the comment column
3247 or comment indentation.
3248
3249 The inserted newline is marked hard if `use-hard-newlines' is true,
3250 unless optional argument SOFT is non-nil."
3251   (interactive)
3252   (let (comcol comstart)
3253     (skip-chars-backward " \t")
3254     ;; 97/3/14 jhod: Kinsoku processing
3255     (if (featurep 'mule)
3256         (kinsoku-process))
3257     (delete-region (point)
3258                    (progn (skip-chars-forward " \t")
3259                           (point)))
3260     (if soft (insert ?\n) (newline 1))
3261     (if fill-prefix
3262         (progn
3263           (indent-to-left-margin)
3264           (insert fill-prefix))
3265     ;; #### - Eric Eide reverts to v18 semantics for this function in
3266     ;; fa-extras, which I'm not gonna do.  His changes are to (1) execute
3267     ;; the save-excursion below unconditionally, and (2) uncomment the check
3268     ;; for (not comment-multi-line) further below.  --Stig
3269       ;;#### jhod: probably need to fix this for kinsoku processing
3270       (if (not comment-multi-line)
3271           (save-excursion
3272             (if (and comment-start-skip
3273                      (let ((opoint (point)))
3274                        (forward-line -1)
3275                        (re-search-forward comment-start-skip opoint t)))
3276                 ;; The old line is a comment.
3277                 ;; Set WIN to the pos of the comment-start.
3278                 ;; But if the comment is empty, look at preceding lines
3279                 ;; to find one that has a nonempty comment.
3280
3281                 ;; If comment-start-skip contains a \(...\) pair,
3282                 ;; the real comment delimiter starts at the end of that pair.
3283                 (let ((win (or (match-end 1) (match-beginning 0))))
3284                   (while (and (eolp) (not (bobp))
3285                               (let (opoint)
3286                                 (beginning-of-line)
3287                                 (setq opoint (point))
3288                                 (forward-line -1)
3289                                 (re-search-forward comment-start-skip opoint t)))
3290                     (setq win (or (match-end 1) (match-beginning 0))))
3291                   ;; Indent this line like what we found.
3292                   (goto-char win)
3293                   (setq comcol (current-column))
3294                   (setq comstart
3295                         (buffer-substring (point) (match-end 0)))))))
3296       (if (and comcol (not fill-prefix))  ; XEmacs - (ENE) from fa-extras.
3297           (let ((comment-column comcol)
3298                 (comment-start comstart)
3299                 (block-comment-start comstart)
3300                 (comment-end comment-end))
3301             (and comment-end (not (equal comment-end ""))
3302   ;            (if (not comment-multi-line)
3303                      (progn
3304                        (backward-char 1)
3305                        (insert comment-end)
3306                        (forward-char 1))
3307   ;              (setq comment-column (+ comment-column (length comment-start))
3308   ;                    comment-start "")
3309   ;                )
3310                  )
3311             (if (not (eolp))
3312                 (setq comment-end ""))
3313             (insert ?\n)
3314             (backward-char 1)
3315             (indent-for-comment)
3316             (save-excursion
3317               ;; Make sure we delete the newline inserted above.
3318               (end-of-line)
3319               (delete-char 1)))
3320         (indent-according-to-mode)))))
3321
3322 \f
3323 (defun set-selective-display (arg)
3324   "Set `selective-display' to ARG; clear it if no arg.
3325 When the value of `selective-display' is a number > 0,
3326 lines whose indentation is >= that value are not displayed.
3327 The variable `selective-display' has a separate value for each buffer."
3328   (interactive "P")
3329   (if (eq selective-display t)
3330       (error "selective-display already in use for marked lines"))
3331   (let ((current-vpos
3332          (save-restriction
3333            (narrow-to-region (point-min) (point))
3334            (goto-char (window-start))
3335            (vertical-motion (window-height)))))
3336     (setq selective-display
3337           (and arg (prefix-numeric-value arg)))
3338     (recenter current-vpos))
3339   (set-window-start (selected-window) (window-start (selected-window)))
3340   ;; #### doesn't localize properly:
3341   (princ "selective-display set to " t)
3342   (prin1 selective-display t)
3343   (princ "." t))
3344
3345 ;; XEmacs
3346 (defun nuke-selective-display ()
3347   "Ensure that the buffer is not in selective-display mode.
3348 If `selective-display' is t, then restore the buffer text to its original
3349 state before disabling selective display."
3350   ;; by Stig@hackvan.com
3351   (interactive)
3352   (and (eq t selective-display)
3353        (save-excursion
3354          (save-restriction
3355            (widen)
3356            (goto-char (point-min))
3357            (let ((mod-p (buffer-modified-p))
3358                  (buffer-read-only nil))
3359              (while (search-forward "\r" nil t)
3360                (delete-char -1)
3361                (insert "\n"))
3362              (set-buffer-modified-p mod-p)
3363              ))))
3364   (setq selective-display nil))
3365
3366 (add-hook 'change-major-mode-hook 'nuke-selective-display)
3367
3368 (defconst overwrite-mode-textual " Ovwrt"
3369   "The string displayed in the mode line when in overwrite mode.")
3370 (defconst overwrite-mode-binary " Bin Ovwrt"
3371   "The string displayed in the mode line when in binary overwrite mode.")
3372
3373 (defun overwrite-mode (arg)
3374   "Toggle overwrite mode.
3375 With arg, enable overwrite mode if arg is positive, else disable.
3376 In overwrite mode, printing characters typed in replace existing text
3377 on a one-for-one basis, rather than pushing it to the right.  At the
3378 end of a line, such characters extend the line.  Before a tab,
3379 such characters insert until the tab is filled in.
3380 \\[quoted-insert] still inserts characters in overwrite mode; this
3381 is supposed to make it easier to insert characters when necessary."
3382   (interactive "P")
3383   (setq overwrite-mode
3384         (if (if (null arg) (not overwrite-mode)
3385               (> (prefix-numeric-value arg) 0))
3386             'overwrite-mode-textual))
3387   (redraw-modeline))
3388
3389 (defun binary-overwrite-mode (arg)
3390   "Toggle binary overwrite mode.
3391 With arg, enable binary overwrite mode if arg is positive, else disable.
3392 In binary overwrite mode, printing characters typed in replace
3393 existing text.  Newlines are not treated specially, so typing at the
3394 end of a line joins the line to the next, with the typed character
3395 between them.  Typing before a tab character simply replaces the tab
3396 with the character typed.
3397 \\[quoted-insert] replaces the text at the cursor, just as ordinary
3398 typing characters do.
3399
3400 Note that binary overwrite mode is not its own minor mode; it is a
3401 specialization of overwrite-mode, entered by setting the
3402 `overwrite-mode' variable to `overwrite-mode-binary'."
3403   (interactive "P")
3404   (setq overwrite-mode
3405         (if (if (null arg)
3406                 (not (eq overwrite-mode 'overwrite-mode-binary))
3407               (> (prefix-numeric-value arg) 0))
3408             'overwrite-mode-binary))
3409   (redraw-modeline))
3410 \f
3411 (defcustom line-number-mode nil
3412   "*Non-nil means display line number in modeline."
3413   :type 'boolean
3414   :group 'editing-basics)
3415
3416 (defun line-number-mode (arg)
3417   "Toggle Line Number mode.
3418 With arg, enable Line Number mode if arg is positive, else disable.
3419 When Line Number mode is enabled, the line number appears
3420 in the mode line."
3421   (interactive "P")
3422   (setq line-number-mode
3423         (if (null arg) (not line-number-mode)
3424           (> (prefix-numeric-value arg) 0)))
3425   (redraw-modeline))
3426
3427 (defcustom column-number-mode nil
3428   "*Non-nil means display column number in mode line."
3429   :type 'boolean
3430   :group 'editing-basics)
3431
3432 (defun column-number-mode (arg)
3433   "Toggle Column Number mode.
3434 With arg, enable Column Number mode if arg is positive, else disable.
3435 When Column Number mode is enabled, the column number appears
3436 in the mode line."
3437   (interactive "P")
3438   (setq column-number-mode
3439         (if (null arg) (not column-number-mode)
3440           (> (prefix-numeric-value arg) 0)))
3441   (redraw-modeline))
3442
3443 \f
3444 (defcustom blink-matching-paren t
3445   "*Non-nil means show matching open-paren when close-paren is inserted."
3446   :type 'boolean
3447   :group 'paren-blinking)
3448
3449 (defcustom blink-matching-paren-on-screen t
3450   "*Non-nil means show matching open-paren when it is on screen.
3451 nil means don't show it (but the open-paren can still be shown
3452 when it is off screen."
3453   :type 'boolean
3454   :group 'paren-blinking)
3455
3456 (defcustom blink-matching-paren-distance 12000
3457   "*If non-nil, is maximum distance to search for matching open-paren."
3458   :type '(choice integer (const nil))
3459   :group 'paren-blinking)
3460
3461 (defcustom blink-matching-delay 1
3462   "*The number of seconds that `blink-matching-open' will delay at a match."
3463   :type 'number
3464   :group 'paren-blinking)
3465
3466 (defcustom blink-matching-paren-dont-ignore-comments nil
3467   "*Non-nil means `blink-matching-paren' should not ignore comments."
3468   :type 'boolean
3469   :group 'paren-blinking)
3470
3471 (defun blink-matching-open ()
3472   "Move cursor momentarily to the beginning of the sexp before point."
3473   (interactive "_") ; XEmacs
3474   (and (> (point) (1+ (point-min)))
3475        blink-matching-paren
3476        ;; Verify an even number of quoting characters precede the close.
3477        (= 1 (logand 1 (- (point)
3478                          (save-excursion
3479                            (backward-char 1)
3480                            (skip-syntax-backward "/\\")
3481                            (point)))))
3482        (let* ((oldpos (point))
3483               (blinkpos)
3484               (mismatch))
3485          (save-excursion
3486            (save-restriction
3487              (if blink-matching-paren-distance
3488                  (narrow-to-region (max (point-min)
3489                                         (- (point) blink-matching-paren-distance))
3490                                    oldpos))
3491              (condition-case ()
3492                  (let ((parse-sexp-ignore-comments
3493                         (and parse-sexp-ignore-comments
3494                              (not blink-matching-paren-dont-ignore-comments))))
3495                    (setq blinkpos (scan-sexps oldpos -1)))
3496                (error nil)))
3497            (and blinkpos
3498                 (/= (char-syntax (char-after blinkpos))
3499                     ?\$)
3500                 (setq mismatch
3501                       (or (null (matching-paren (char-after blinkpos)))
3502                           (/= (char-after (1- oldpos))
3503                               (matching-paren (char-after blinkpos))))))
3504            (if mismatch (setq blinkpos nil))
3505            (if blinkpos
3506                (progn
3507                 (goto-char blinkpos)
3508                 (if (pos-visible-in-window-p)
3509                     (and blink-matching-paren-on-screen
3510                          (progn
3511                            (auto-show-make-point-visible)
3512                            (sit-for blink-matching-delay)))
3513                   (goto-char blinkpos)
3514                   (lmessage 'command "Matches %s"
3515                     ;; Show what precedes the open in its line, if anything.
3516                     (if (save-excursion
3517                           (skip-chars-backward " \t")
3518                           (not (bolp)))
3519                         (buffer-substring (progn (beginning-of-line) (point))
3520                                           (1+ blinkpos))
3521                       ;; Show what follows the open in its line, if anything.
3522                       (if (save-excursion
3523                             (forward-char 1)
3524                             (skip-chars-forward " \t")
3525                             (not (eolp)))
3526                           (buffer-substring blinkpos
3527                                             (progn (end-of-line) (point)))
3528                         ;; Otherwise show the previous nonblank line,
3529                         ;; if there is one.
3530                         (if (save-excursion
3531                               (skip-chars-backward "\n \t")
3532                               (not (bobp)))
3533                             (concat
3534                              (buffer-substring (progn
3535                                                  (skip-chars-backward "\n \t")
3536                                                  (beginning-of-line)
3537                                                  (point))
3538                                                (progn (end-of-line)
3539                                                       (skip-chars-backward " \t")
3540                                                       (point)))
3541                              ;; Replace the newline and other whitespace with `...'.
3542                              "..."
3543                              (buffer-substring blinkpos (1+ blinkpos)))
3544                           ;; There is nothing to show except the char itself.
3545                           (buffer-substring blinkpos (1+ blinkpos))))))))
3546              (cond (mismatch
3547                     (display-message 'no-log "Mismatched parentheses"))
3548                    ((not blink-matching-paren-distance)
3549                     (display-message 'no-log "Unmatched parenthesis"))))))))
3550
3551 ;Turned off because it makes dbx bomb out.
3552 (setq blink-paren-function 'blink-matching-open)
3553 \f
3554
3555 ;; XEmacs: Some functions moved to cmdloop.el:
3556 ;; keyboard-quit
3557 ;; buffer-quit-function
3558 ;; keyboard-escape-quit
3559
3560 (defun assoc-ignore-case (key alist)
3561   "Like `assoc', but assumes KEY is a string and ignores case when comparing."
3562   (setq key (downcase key))
3563   (let (element)
3564     (while (and alist (not element))
3565       (if (equal key (downcase (car (car alist))))
3566           (setq element (car alist)))
3567       (setq alist (cdr alist)))
3568     element))
3569
3570 \f
3571 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3572 ;;                          mail composition code                        ;;
3573 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3574
3575 (defcustom mail-user-agent 'sendmail-user-agent
3576   "*Your preference for a mail composition package.
3577 Various Emacs Lisp packages (e.g. reporter) require you to compose an
3578 outgoing email message.  This variable lets you specify which
3579 mail-sending package you prefer.
3580
3581 Valid values include:
3582
3583     sendmail-user-agent -- use the default Emacs Mail package
3584     mh-e-user-agent     -- use the Emacs interface to the MH mail system
3585     message-user-agent  -- use the GNUS mail sending package
3586
3587 Additional valid symbols may be available; check with the author of
3588 your package for details."
3589   :type '(radio (function-item :tag "Default Emacs mail"
3590                                :format "%t\n"
3591                                sendmail-user-agent)
3592                 (function-item :tag "Gnus mail sending package"
3593                                :format "%t\n"
3594                                message-user-agent)
3595                 (function :tag "Other"))
3596   :group 'mail)
3597
3598 (defun define-mail-user-agent (symbol composefunc sendfunc
3599                                       &optional abortfunc hookvar)
3600   "Define a symbol to identify a mail-sending package for `mail-user-agent'.
3601
3602 SYMBOL can be any Lisp symbol.  Its function definition and/or
3603 value as a variable do not matter for this usage; we use only certain
3604 properties on its property list, to encode the rest of the arguments.
3605
3606 COMPOSEFUNC is program callable function that composes an outgoing
3607 mail message buffer.  This function should set up the basics of the
3608 buffer without requiring user interaction.  It should populate the
3609 standard mail headers, leaving the `to:' and `subject:' headers blank
3610 by default.
3611
3612 COMPOSEFUNC should accept several optional arguments--the same
3613 arguments that `compose-mail' takes.  See that function's documentation.
3614
3615 SENDFUNC is the command a user would run to send the message.
3616
3617 Optional ABORTFUNC is the command a user would run to abort the
3618 message.  For mail packages that don't have a separate abort function,
3619 this can be `kill-buffer' (the equivalent of omitting this argument).
3620
3621 Optional HOOKVAR is a hook variable that gets run before the message
3622 is actually sent.  Callers that use the `mail-user-agent' may
3623 install a hook function temporarily on this hook variable.
3624 If HOOKVAR is nil, `mail-send-hook' is used.
3625
3626 The properties used on SYMBOL are `composefunc', `sendfunc',
3627 `abortfunc', and `hookvar'."
3628   (put symbol 'composefunc composefunc)
3629   (put symbol 'sendfunc sendfunc)
3630   (put symbol 'abortfunc (or abortfunc 'kill-buffer))
3631   (put symbol 'hookvar (or hookvar 'mail-send-hook)))
3632
3633 (define-mail-user-agent 'sendmail-user-agent
3634   'sendmail-user-agent-compose 'mail-send-and-exit)
3635
3636 (define-mail-user-agent 'message-user-agent
3637   'message-mail 'message-send-and-exit
3638   'message-kill-buffer 'message-send-hook)
3639
3640 (defun sendmail-user-agent-compose (&optional to subject other-headers continue
3641                                               switch-function yank-action
3642                                               send-actions)
3643   (if switch-function
3644       (let ((special-display-buffer-names nil)
3645             (special-display-regexps nil)
3646             (same-window-buffer-names nil)
3647             (same-window-regexps nil))
3648         (funcall switch-function "*mail*")))
3649   (let ((cc (cdr (assoc-ignore-case "cc" other-headers)))
3650         (in-reply-to (cdr (assoc-ignore-case "in-reply-to" other-headers))))
3651     (or (mail continue to subject in-reply-to cc yank-action send-actions)
3652         continue
3653         (error "Message aborted"))
3654     (save-excursion
3655       (goto-char (point-min))
3656       (search-forward mail-header-separator)
3657       (beginning-of-line)
3658       (while other-headers
3659         (if (not (member (car (car other-headers)) '("in-reply-to" "cc")))
3660             (insert (car (car other-headers)) ": "
3661                     (cdr (car other-headers)) "\n"))
3662         (setq other-headers (cdr other-headers)))
3663       t)))
3664
3665 (define-mail-user-agent 'mh-e-user-agent
3666   'mh-user-agent-compose 'mh-send-letter 'mh-fully-kill-draft
3667   'mh-before-send-letter-hook)
3668
3669 (defun compose-mail (&optional to subject other-headers continue
3670                                switch-function yank-action send-actions)
3671   "Start composing a mail message to send.
3672 This uses the user's chosen mail composition package
3673 as selected with the variable `mail-user-agent'.
3674 The optional arguments TO and SUBJECT specify recipients
3675 and the initial Subject field, respectively.
3676
3677 OTHER-HEADERS is an alist specifying additional
3678 header fields.  Elements look like (HEADER . VALUE) where both
3679 HEADER and VALUE are strings.
3680
3681 CONTINUE, if non-nil, says to continue editing a message already
3682 being composed.
3683
3684 SWITCH-FUNCTION, if non-nil, is a function to use to
3685 switch to and display the buffer used for mail composition.
3686
3687 YANK-ACTION, if non-nil, is an action to perform, if and when necessary,
3688 to insert the raw text of the message being replied to.
3689 It has the form (FUNCTION . ARGS).  The user agent will apply
3690 FUNCTION to ARGS, to insert the raw text of the original message.
3691 \(The user agent will also run `mail-citation-hook', *after* the
3692 original text has been inserted in this way.)
3693
3694 SEND-ACTIONS is a list of actions to call when the message is sent.
3695 Each action has the form (FUNCTION . ARGS)."
3696   (interactive
3697    (list nil nil nil current-prefix-arg))
3698   (let ((function (get mail-user-agent 'composefunc)))
3699     (funcall function to subject other-headers continue
3700              switch-function yank-action send-actions)))
3701
3702 (defun compose-mail-other-window (&optional to subject other-headers continue
3703                                             yank-action send-actions)
3704   "Like \\[compose-mail], but edit the outgoing message in another window."
3705   (interactive
3706    (list nil nil nil current-prefix-arg))
3707   (compose-mail to subject other-headers continue
3708                 'switch-to-buffer-other-window yank-action send-actions))
3709
3710
3711 (defun compose-mail-other-frame (&optional to subject other-headers continue
3712                                             yank-action send-actions)
3713   "Like \\[compose-mail], but edit the outgoing message in another frame."
3714   (interactive
3715    (list nil nil nil current-prefix-arg))
3716   (compose-mail to subject other-headers continue
3717                 'switch-to-buffer-other-frame yank-action send-actions))
3718
3719 \f
3720 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3721 ;;                             set variable                              ;;
3722 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3723
3724 (defun set-variable (var val)
3725   "Set VARIABLE to VALUE.  VALUE is a Lisp object.
3726 When using this interactively, supply a Lisp expression for VALUE.
3727 If you want VALUE to be a string, you must surround it with doublequotes.
3728 If VARIABLE is a specifier, VALUE is added to it as an instantiator in
3729 the 'global locale with nil tag set (see `set-specifier').
3730
3731 If VARIABLE has a `variable-interactive' property, that is used as if
3732 it were the arg to `interactive' (which see) to interactively read the value."
3733   (interactive
3734    (let* ((var (read-variable "Set variable: "))
3735           ;; #### - yucky code replication here.  This should use something
3736           ;; from help.el or hyper-apropos.el
3737           (myhelp
3738            #'(lambda ()
3739               (with-output-to-temp-buffer "*Help*"
3740                 (prin1 var)
3741                 (princ "\nDocumentation:\n")
3742                 (princ (substring (documentation-property var 'variable-documentation)
3743                                   1))
3744                 (if (boundp var)
3745                     (let ((print-length 20))
3746                       (princ "\n\nCurrent value: ")
3747                       (prin1 (symbol-value var))))
3748                 (save-excursion
3749                   (set-buffer standard-output)
3750                   (help-mode))
3751                 nil)))
3752           (minibuffer-help-form
3753            '(funcall myhelp)))
3754      (list var
3755            (let ((prop (get var 'variable-interactive)))
3756              (if prop
3757                  ;; Use VAR's `variable-interactive' property
3758                  ;; as an interactive spec for prompting.
3759                  (call-interactively (list 'lambda '(arg)
3760                                            (list 'interactive prop)
3761                                            'arg))
3762                (eval-minibuffer (format "Set %s to value: " var)))))))
3763   (if (and (boundp var) (specifierp (symbol-value var)))
3764       (set-specifier (symbol-value var) val)
3765     (set var val)))
3766
3767 \f
3768 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3769 ;;                           case changing code                          ;;
3770 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3771
3772 ;; A bunch of stuff was moved elsewhere:
3773 ;; completion-list-mode-map
3774 ;; completion-reference-buffer
3775 ;; completion-base-size
3776 ;; delete-completion-window
3777 ;; previous-completion
3778 ;; next-completion
3779 ;; choose-completion
3780 ;; choose-completion-delete-max-match
3781 ;; choose-completion-string
3782 ;; completion-list-mode
3783 ;; completion-fixup-function
3784 ;; completion-setup-function
3785 ;; switch-to-completions
3786 ;; event stuffs
3787 ;; keypad stuffs
3788
3789 ;; The rest of this file is not in Lisp in FSF
3790 (defun capitalize-region-or-word (arg)
3791   "Capitalize the selected region or the following word (or ARG words)."
3792   (interactive "p")
3793   (if (region-active-p)
3794       (capitalize-region (region-beginning) (region-end))
3795     (capitalize-word arg)))
3796
3797 (defun upcase-region-or-word (arg)
3798   "Upcase the selected region or the following word (or ARG words)."
3799   (interactive "p")
3800   (if (region-active-p)
3801       (upcase-region (region-beginning) (region-end))
3802     (upcase-word arg)))
3803
3804 (defun downcase-region-or-word (arg)
3805   "Downcase the selected region or the following word (or ARG words)."
3806   (interactive "p")
3807   (if (region-active-p)
3808       (downcase-region (region-beginning) (region-end))
3809     (downcase-word arg)))
3810
3811 ;; #### not localized
3812 (defvar uncapitalized-title-words
3813   '("the" "a" "an" "in" "of" "for" "to" "and" "but" "at" "on" "as" "by"))
3814
3815 (defvar uncapitalized-title-word-regexp
3816   (concat "[ \t]*\\(" (mapconcat #'identity uncapitalized-title-words "\\|")
3817           "\\)\\>"))
3818
3819 (defun capitalize-string-as-title (string)
3820   "Capitalize the words in the string, except for small words (as in titles).
3821 The words not capitalized are specified in `uncapitalized-title-words'."
3822   (let ((buffer (get-buffer-create " *capitalize-string-as-title*")))
3823     (unwind-protect
3824         (progn
3825           (insert-string string buffer)
3826           (capitalize-region-as-title 1 (point-max buffer) buffer)
3827           (buffer-string buffer))
3828       (kill-buffer buffer))))
3829
3830 (defun capitalize-region-as-title (b e &optional buffer)
3831   "Capitalize the words in the region, except for small words (as in titles).
3832 The words not capitalized are specified in `uncapitalized-title-words'."
3833   (interactive "r")
3834   (save-excursion
3835     (and buffer
3836          (set-buffer buffer))
3837     (save-restriction
3838       (narrow-to-region b e)
3839       (goto-char (point-min))
3840       (let ((first t))
3841         (while (< (point) (point-max))
3842           (if (or first
3843                   (not (looking-at uncapitalized-title-word-regexp)))
3844               (capitalize-word 1)
3845             (forward-word 1))
3846           (setq first nil))))))
3847
3848 \f
3849 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3850 ;;                          zmacs active region code                     ;;
3851 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3852
3853 ;; Most of the zmacs code is now in elisp.  The only thing left in C
3854 ;; are the variables zmacs-regions, zmacs-region-active-p and
3855 ;; zmacs-region-stays plus the function zmacs_update_region which
3856 ;; simply calls the lisp level zmacs-update-region.  It must remain
3857 ;; for convenience, since it is called by core C code.
3858
3859 ;; XEmacs
3860 (defun activate-region ()
3861   "Activate the region, if `zmacs-regions' is true.
3862 Setting `zmacs-regions' to true causes LISPM-style active regions to be used.
3863 This function has no effect if `zmacs-regions' is false."
3864   (interactive)
3865   (and zmacs-regions (zmacs-activate-region)))
3866
3867 ;; XEmacs
3868 (defsubst region-exists-p ()
3869   "Return t if the region exists.
3870 If active regions are in use (i.e. `zmacs-regions' is true), this means that
3871  the region is active.  Otherwise, this means that the user has pushed
3872  a mark in this buffer at some point in the past.
3873 The functions `region-beginning' and `region-end' can be used to find the
3874  limits of the region.
3875
3876 You should use this, *NOT* `region-active-p', in a menu item
3877 specification that you want grayed out when the region is not active:
3878
3879   [ ... ... :active (region-exists-p)]
3880
3881 This correctly caters to the user's setting of `zmacs-regions'."
3882   (not (null (mark))))
3883
3884 ;; XEmacs
3885 (defun region-active-p ()
3886   "Return non-nil if the region is active.
3887 If `zmacs-regions' is true, this is equivalent to `region-exists-p'.
3888 Otherwise, this function always returns false.
3889
3890 You should generally *NOT* use this in a menu item specification that you
3891 want grayed out when the region is not active.  Instead, use this:
3892
3893   [ ... ... :active (region-exists-p)]
3894
3895 Which correctly caters to the user's setting of `zmacs-regions'."
3896   (and zmacs-regions zmacs-region-extent))
3897
3898 (defvar zmacs-activate-region-hook nil
3899   "Function or functions called when the region becomes active;
3900 see the variable `zmacs-regions'.")
3901
3902 (defvar zmacs-deactivate-region-hook nil
3903   "Function or functions called when the region becomes inactive;
3904 see the variable `zmacs-regions'.")
3905
3906 (defvar zmacs-update-region-hook nil
3907   "Function or functions called when the active region changes.
3908 This is called after each command that sets `zmacs-region-stays' to t.
3909 See the variable `zmacs-regions'.")
3910
3911 (defvar zmacs-region-extent nil
3912   "The extent of the zmacs region; don't use this.")
3913
3914 (defvar zmacs-region-rectangular-p nil
3915   "Whether the zmacs region is a rectangle; don't use this.")
3916
3917 (defun zmacs-make-extent-for-region (region)
3918   ;; Given a region, this makes an extent in the buffer which holds that
3919   ;; region, for highlighting purposes.  If the region isn't associated
3920   ;; with a buffer, this does nothing.
3921   (let ((buffer nil)
3922         (valid (and (extentp zmacs-region-extent)
3923                     (extent-object zmacs-region-extent)
3924                     (buffer-live-p (extent-object zmacs-region-extent))))
3925         start end)
3926     (cond ((consp region)
3927            (setq start (min (car region) (cdr region))
3928                  end (max (car region) (cdr region))
3929                  valid (and valid
3930                             (eq (marker-buffer (car region))
3931                                 (extent-object zmacs-region-extent)))
3932                  buffer (marker-buffer (car region))))
3933           (t
3934            (signal 'error (list "Invalid region" region))))
3935
3936     (if valid
3937         nil
3938       ;; The condition case is in case any of the extents are dead or
3939       ;; otherwise incapacitated.
3940       (condition-case ()
3941           (if (listp zmacs-region-extent)
3942               (mapc 'delete-extent zmacs-region-extent)
3943             (delete-extent zmacs-region-extent))
3944         (error nil)))
3945
3946     (if valid
3947         (set-extent-endpoints zmacs-region-extent start end)
3948       (setq zmacs-region-extent (make-extent start end buffer))
3949
3950       ;; Make the extent be closed on the right, which means that if
3951       ;; characters are inserted exactly at the end of the extent, the
3952       ;; extent will grow to cover them.  This is important for shell
3953       ;; buffers - suppose one makes a region, and one end is at point-max.
3954       ;; If the shell produces output, that marker will remain at point-max
3955       ;; (its position will increase).  So it's important that the extent
3956       ;; exhibit the same behavior, lest the region covered by the extent
3957       ;; (the visual indication), and the region between point and mark
3958       ;; (the actual region value) become different!
3959       (set-extent-property zmacs-region-extent 'end-open nil)
3960
3961       ;; use same priority as mouse-highlighting so that conflicts between
3962       ;; the region extent and a mouse-highlighted extent are resolved by
3963       ;; the usual size-and-endpoint-comparison method.
3964       (set-extent-priority zmacs-region-extent mouse-highlight-priority)
3965       (set-extent-face zmacs-region-extent 'zmacs-region)
3966
3967       ;; #### It might be better to actually break
3968       ;; default-mouse-track-next-move-rect out of mouse.el so that we
3969       ;; can use its logic here.
3970       (cond
3971        (zmacs-region-rectangular-p
3972         (setq zmacs-region-extent (list zmacs-region-extent))
3973         (default-mouse-track-next-move-rect start end zmacs-region-extent)
3974         ))
3975
3976       zmacs-region-extent)))
3977
3978 (defun zmacs-region-buffer ()
3979   "Return the buffer containing the zmacs region, or nil."
3980   ;; #### this is horrible and kludgy!  This stuff needs to be rethought.
3981   (and zmacs-regions zmacs-region-active-p
3982        (or (marker-buffer (mark-marker t))
3983            (and (extent-live-p zmacs-region-extent)
3984                 (buffer-live-p (extent-object zmacs-region-extent))
3985                 (extent-object zmacs-region-extent)))))
3986
3987 (defun zmacs-activate-region ()
3988   "Make the region between `point' and `mark' be active (highlighted),
3989 if `zmacs-regions' is true.  Only a very small number of commands
3990 should ever do this.  Calling this function will call the hook
3991 `zmacs-activate-region-hook', if the region was previously inactive.
3992 Calling this function ensures that the region stays active after the
3993 current command terminates, even if `zmacs-region-stays' is not set.
3994 Returns t if the region was activated (i.e. if `zmacs-regions' if t)."
3995   (if (not zmacs-regions)
3996       nil
3997     (setq zmacs-region-active-p t
3998           zmacs-region-stays t
3999           zmacs-region-rectangular-p (and (boundp 'mouse-track-rectangle-p)
4000                                           mouse-track-rectangle-p))
4001     (if (marker-buffer (mark-marker t))
4002         (zmacs-make-extent-for-region (cons (point-marker t) (mark-marker t))))
4003     (run-hooks 'zmacs-activate-region-hook)
4004     t))
4005
4006 (defun zmacs-deactivate-region ()
4007   "Make the region between `point' and `mark' no longer be active,
4008 if `zmacs-regions' is true.  You shouldn't need to call this; the
4009 command loop calls it when appropriate.  Calling this function will
4010 call the hook `zmacs-deactivate-region-hook', if the region was
4011 previously active.  Returns t if the region had been active, nil
4012 otherwise."
4013   (if (not zmacs-region-active-p)
4014       nil
4015     (setq zmacs-region-active-p nil
4016           zmacs-region-stays nil
4017           zmacs-region-rectangular-p nil)
4018     (if zmacs-region-extent
4019         (let ((inhibit-quit t))
4020           (if (listp zmacs-region-extent)
4021               (mapc 'delete-extent zmacs-region-extent)
4022             (delete-extent zmacs-region-extent))
4023           (setq zmacs-region-extent nil)))
4024     (run-hooks 'zmacs-deactivate-region-hook)
4025     t))
4026
4027 (defun zmacs-update-region ()
4028   "Update the highlighted region between `point' and `mark'.
4029 You shouldn't need to call this; the command loop calls it
4030 when appropriate.  Calling this function will call the hook
4031 `zmacs-update-region-hook', if the region is active."
4032   (when zmacs-region-active-p
4033     (when (marker-buffer (mark-marker t))
4034       (zmacs-make-extent-for-region (cons (point-marker t)
4035                                           (mark-marker t))))
4036     (run-hooks 'zmacs-update-region-hook)))
4037
4038 \f
4039 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4040 ;;                           message logging code                        ;;
4041 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4042
4043 ;;; #### Should this be moved to a separate file, for clarity?
4044 ;;; -hniksic
4045
4046 ;;; The `message-stack' is an alist of labels with messages; the first
4047 ;;; message in this list is always in the echo area.  A call to
4048 ;;; `display-message' inserts a label/message pair at the head of the
4049 ;;; list, and removes any other pairs with that label.  Calling
4050 ;;; `clear-message' causes any pair with matching label to be removed,
4051 ;;; and this may cause the displayed message to change or vanish.  If
4052 ;;; the label arg is nil, the entire message stack is cleared.
4053 ;;;
4054 ;;; Message/error filtering will be a little tricker to implement than
4055 ;;; logging, since messages can be built up incrementally
4056 ;;; using clear-message followed by repeated calls to append-message
4057 ;;; (this happens with error messages).  For messages which aren't
4058 ;;; created this way, filtering could be implemented at display-message
4059 ;;; very easily.
4060 ;;;
4061 ;;; Bits of the logging code are borrowed from log-messages.el by
4062 ;;; Robert Potter (rpotter@grip.cis.upenn.edu).
4063
4064 ;; need this to terminate the currently-displayed message
4065 ;; ("Loading simple ...")
4066 (when (and
4067        (not (fboundp 'display-message))
4068        (not (featurep 'debug)))
4069   (send-string-to-terminal "\n"))
4070
4071 (defvar message-stack nil
4072   "An alist of label/string pairs representing active echo-area messages.
4073 The first element in the list is currently displayed in the echo area.
4074 Do not modify this directly--use the `message' or
4075 `display-message'/`clear-message' functions.")
4076
4077 (defvar remove-message-hook 'log-message
4078   "A function or list of functions to be called when a message is removed
4079 from the echo area at the bottom of the frame.  The label of the removed
4080 message is passed as the first argument, and the text of the message
4081 as the second argument.")
4082
4083 (defcustom log-message-max-size 50000
4084   "Maximum size of the \" *Message-Log*\" buffer.  See `log-message'."
4085   :type 'integer
4086   :group 'log-message)
4087 (make-compatible-variable 'message-log-max 'log-message-max-size)
4088
4089 ;; We used to reject quite a lot of stuff here, but it was a bad idea,
4090 ;; for two reasons:
4091 ;;
4092 ;; a) In most circumstances, you *want* to see the message in the log.
4093 ;;    The explicitly non-loggable messages should be marked as such by
4094 ;;    the issuer.  Gratuitous non-displaying of random regexps made
4095 ;;    debugging harder, too (because various reasonable debugging
4096 ;;    messages would get eaten).
4097 ;;
4098 ;; b) It slowed things down.  Yes, visibly.
4099 ;;
4100 ;; So, I left only a few of the really useless ones on this kill-list.
4101 ;;
4102 ;;                                            --hniksic
4103 (defcustom log-message-ignore-regexps
4104   '(;; Note: adding entries to this list slows down messaging
4105     ;; significantly.  Wherever possible, use message labels.
4106
4107     ;; Often-seen messages
4108     "\\`\\'"                            ; empty message
4109     "\\`\\(Beginning\\|End\\) of buffer\\'"
4110     ;;"^Quit$"
4111     ;; completions
4112     ;; Many packages print this -- impossible to categorize
4113     ;;"^Making completion list"
4114     ;; Gnus
4115     ;; "^No news is no news$"
4116     ;; "^No more\\( unread\\)? newsgroups$"
4117     ;; "^Opening [^ ]+ server\\.\\.\\."
4118     ;; "^[^:]+: Reading incoming mail"
4119     ;; "^Getting mail from "
4120     ;; "^\\(Generating Summary\\|Sorting threads\\|Making sparse threads\\|Scoring\\|Checking new news\\|Expiring articles\\|Sending\\)\\.\\.\\."
4121     ;; "^\\(Fetching headers for\\|Retrieving newsgroup\\|Reading active file\\)"
4122     ;; "^No more\\( unread\\)? articles"
4123     ;; "^Deleting article "
4124     ;; W3
4125     ;; "^Parsed [0-9]+ of [0-9]+ ([0-9]+%)"
4126     )
4127   "List of regular expressions matching messages which shouldn't be logged.
4128 See `log-message'.
4129
4130 Ideally, packages which generate messages which might need to be ignored
4131 should label them with 'progress, 'prompt, or 'no-log, so they can be
4132 filtered by the log-message-ignore-labels."
4133   :type '(repeat regexp)
4134   :group 'log-message)
4135
4136 (defcustom log-message-ignore-labels
4137   '(help-echo command progress prompt no-log garbage-collecting auto-saving)
4138   "List of symbols indicating labels of messages which shouldn't be logged.
4139 See `display-message' for some common labels.  See also `log-message'."
4140   :type '(repeat (symbol :tag "Label"))
4141   :group 'log-message)
4142
4143 ;;Subsumed by view-lossage
4144 ;; Not really, I'm adding it back by popular demand. -slb
4145 (defun show-message-log ()
4146   "Show the \" *Message-Log*\" buffer, which contains old messages and errors."
4147   (interactive)
4148   (pop-to-buffer (get-buffer-create " *Message-Log*")))
4149
4150 (defvar log-message-filter-function 'log-message-filter
4151   "Value must be a function of two arguments: a symbol (label) and
4152 a string (message).  It should return non-nil to indicate a message
4153 should be logged.  Possible values include 'log-message-filter and
4154 'log-message-filter-errors-only.")
4155
4156 (defun log-message-filter (label message)
4157   "Default value of `log-message-filter-function'.
4158 Messages whose text matches one of the `log-message-ignore-regexps'
4159 or whose label appears in `log-message-ignore-labels' are not saved."
4160   (let ((r  log-message-ignore-regexps)
4161         (ok (not (memq label log-message-ignore-labels))))
4162     (save-match-data
4163       (while (and r ok)
4164         (when (string-match (car r) message)
4165           (setq ok nil))
4166         (setq r (cdr r))))
4167     ok))
4168
4169 (defun log-message-filter-errors-only (label message)
4170   "For use as the `log-message-filter-function'.  Only logs error messages."
4171   (eq label 'error))
4172
4173 (defun log-message (label message)
4174   "Stuff a copy of the message into the \" *Message-Log*\" buffer,
4175 if it satisfies the `log-message-filter-function'.
4176
4177 For use on `remove-message-hook'."
4178   (when (and (not noninteractive)
4179              (funcall log-message-filter-function label message))
4180     ;; Use save-excursion rather than save-current-buffer because we
4181     ;; change the value of point.
4182     (save-excursion
4183       (set-buffer (get-buffer-create " *Message-Log*"))
4184       (goto-char (point-max))
4185       ;(insert (concat (upcase (symbol-name label)) ": "  message "\n"))
4186       (let (extent)
4187         ;; Mark multiline message with an extent, which `view-lossage'
4188         ;; will recognize.
4189         (when (string-match "\n" message)
4190           (setq extent (make-extent (point) (point)))
4191           (set-extent-properties extent '(end-open nil message-multiline t)))
4192         (insert message "\n")
4193         (when extent
4194           (set-extent-property extent 'end-open t)))
4195       (when (> (point-max) (max log-message-max-size (point-min)))
4196         ;; Trim log to ~90% of max size.
4197         (goto-char (max (- (point-max)
4198                            (truncate (* 0.9 log-message-max-size)))
4199                         (point-min)))
4200         (forward-line 1)
4201         (delete-region (point-min) (point))))))
4202
4203 (defun message-displayed-p (&optional return-string frame)
4204   "Return a non-nil value if a message is presently displayed in the\n\
4205 minibuffer's echo area.  If optional argument RETURN-STRING is non-nil,\n\
4206 return a string containing the message, otherwise just return t."
4207   ;; by definition, a message is displayed if the echo area buffer is
4208   ;; non-empty (see also echo_area_active()).  It had better also
4209   ;; be the case that message-stack is nil exactly when the echo area
4210   ;; is non-empty.
4211   (let ((buffer (get-buffer " *Echo Area*")))
4212     (and (< (point-min buffer) (point-max buffer))
4213          (if return-string
4214              (buffer-substring nil nil buffer)
4215            t))))
4216
4217 ;;; Returns the string which remains in the echo area, or nil if none.
4218 ;;; If label is nil, the whole message stack is cleared.
4219 (defun clear-message (&optional label frame stdout-p no-restore)
4220   "Remove any message with the given LABEL from the message-stack,
4221 erasing it from the echo area if it's currently displayed there.
4222 If a message remains at the head of the message-stack and NO-RESTORE
4223 is nil, it will be displayed.  The string which remains in the echo
4224 area will be returned, or nil if the message-stack is now empty.
4225 If LABEL is nil, the entire message-stack is cleared.
4226
4227 Unless you need the return value or you need to specify a label,
4228 you should just use (message nil)."
4229   (or frame (setq frame (selected-frame)))
4230   (let ((clear-stream (and message-stack (eq 'stream (frame-type frame)))))
4231     (remove-message label frame)
4232     (let ((inhibit-read-only t)
4233           (zmacs-region-stays zmacs-region-stays)) ; preserve from change
4234       (erase-buffer " *Echo Area*"))
4235     (if clear-stream
4236         (send-string-to-terminal ?\n stdout-p))
4237     (if no-restore
4238         nil                     ; just preparing to put another msg up
4239       (if message-stack
4240           (let ((oldmsg (cdr (car message-stack))))
4241             (raw-append-message oldmsg frame stdout-p)
4242             oldmsg)
4243         ;; #### Should we (redisplay-echo-area) here?  Messes some
4244         ;; things up.
4245         nil))))
4246
4247 (defun remove-message (&optional label frame)
4248   ;; If label is nil, we want to remove all matching messages.
4249   ;; Must reverse the stack first to log them in the right order.
4250   (let ((log nil))
4251     (while (and message-stack
4252                 (or (null label)        ; null label means clear whole stack
4253                     (eq label (car (car message-stack)))))
4254       (push (car message-stack) log)
4255       (setq message-stack (cdr message-stack)))
4256     (let ((s  message-stack))
4257       (while (cdr s)
4258         (let ((msg (car (cdr s))))
4259           (if (eq label (car msg))
4260               (progn
4261                 (push msg log)
4262                 (setcdr s (cdr (cdr s))))
4263             (setq s (cdr s))))))
4264     ;; (possibly) log each removed message
4265     (while log
4266       (condition-case e
4267           (run-hook-with-args 'remove-message-hook
4268                               (car (car log)) (cdr (car log)))
4269         (error (setq remove-message-hook nil)
4270                (lwarn 'message-log 'warning
4271                  "Error caught in `remove-message-hook': %s"
4272                  (error-message-string e))
4273                (let ((inhibit-read-only t))
4274                  (erase-buffer " *Echo Area*"))
4275                (signal (car e) (cdr e))))
4276       (setq log (cdr log)))))
4277
4278 (defun append-message (label message &optional frame stdout-p)
4279   (or frame (setq frame (selected-frame)))
4280   ;; Add a new entry to the message-stack, or modify an existing one
4281   (let ((top (car message-stack)))
4282     (if (eq label (car top))
4283         (setcdr top (concat (cdr top) message))
4284       (push (cons label message) message-stack)))
4285   (raw-append-message message frame stdout-p))
4286
4287 ;; Really append the message to the echo area.  no fiddling with
4288 ;; message-stack.
4289 (defun raw-append-message (message &optional frame stdout-p)
4290   (unless (equal message "")
4291     (let ((inhibit-read-only t)
4292           (zmacs-region-stays zmacs-region-stays)) ; preserve from change
4293       (insert-string message " *Echo Area*")
4294       ;; Conditionalizing on the device type in this way is not that clean,
4295       ;; but neither is having a device method, as I originally implemented
4296       ;; it: all non-stream devices behave in the same way.  Perhaps
4297       ;; the cleanest way is to make the concept of a "redisplayable"
4298       ;; device, which stream devices are not.  Look into this more if
4299       ;; we ever create another non-redisplayable device type (e.g.
4300       ;; processes?  printers?).
4301
4302       ;; Don't redisplay the echo area if we are executing a macro.
4303       (if (not executing-kbd-macro)
4304           (if (eq 'stream (frame-type frame))
4305               (send-string-to-terminal message stdout-p (frame-device frame))
4306             (redisplay-echo-area))))))
4307
4308 (defun display-message (label message &optional frame stdout-p)
4309   "Print a one-line message at the bottom of the frame.  First argument
4310 LABEL is an identifier for this message.  MESSAGE is the string to display.
4311 Use `clear-message' to remove a labelled message.
4312
4313 Here are some standard labels (those marked with `*' are not logged
4314 by default--see the `log-message-ignore-labels' variable):
4315     message       default label used by the `message' function
4316     error         default label used for reporting errors
4317   * progress      progress indicators like \"Converting... 45%\"
4318   * prompt        prompt-like messages like \"I-search: foo\"
4319   * command       helper command messages like \"Mark set\"
4320   * no-log        messages that should never be logged"
4321   (clear-message label frame stdout-p t)
4322   (append-message label message frame stdout-p))
4323
4324 (defun current-message (&optional frame)
4325   "Return the current message in the echo area, or nil.
4326 The FRAME argument is currently unused."
4327   (cdr (car message-stack)))
4328
4329 ;;; may eventually be frame-dependent
4330 (defun current-message-label (&optional frame)
4331   (car (car message-stack)))
4332
4333 (defun message (fmt &rest args)
4334   "Print a one-line message at the bottom of the frame.
4335 The arguments are the same as to `format'.
4336
4337 If the only argument is nil, clear any existing message; let the
4338 minibuffer contents show."
4339   ;; questionable junk in the C code
4340   ;; (if (framep default-minibuffer-frame)
4341   ;;     (make-frame-visible default-minibuffer-frame))
4342   (if (and (null fmt) (null args))
4343       (prog1 nil
4344         (clear-message nil))
4345     (let ((str (apply 'format fmt args)))
4346       (display-message 'message str)
4347       str)))
4348
4349 (defun lmessage (label fmt &rest args)
4350   "Print a one-line message at the bottom of the frame.
4351 First argument LABEL is an identifier for this message.  The rest of the
4352 arguments are the same as to `format'.
4353
4354 See `display-message' for a list of standard labels."
4355   (if (and (null fmt) (null args))
4356       (prog1 nil
4357         (clear-message label nil))
4358     (let ((str (apply 'format fmt args)))
4359       (display-message label str)
4360       str)))
4361
4362 \f
4363 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4364 ;;                              warning code                             ;;
4365 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4366
4367 (defcustom log-warning-minimum-level 'info
4368   "Minimum level of warnings that should be logged.
4369 The warnings in levels below this are completely ignored, as if they never
4370 happened.
4371
4372 The recognized warning levels, in decreasing order of priority, are
4373 'emergency, 'alert, 'critical, 'error, 'warning, 'notice, 'info, and
4374 'debug.
4375
4376 See also `display-warning-minimum-level'.
4377
4378 You can also control which warnings are displayed on a class-by-class
4379 basis.  See `display-warning-suppressed-classes' and
4380 `log-warning-suppressed-classes'."
4381   :type '(choice (const emergency) (const alert) (const critical)
4382                  (const error) (const warning) (const notice)
4383                  (const info) (const debug))
4384   :group 'warnings)
4385
4386 (defcustom display-warning-minimum-level 'info
4387   "Minimum level of warnings that should be displayed.
4388 The warnings in levels below this will be generated, but not
4389 displayed.
4390
4391 The recognized warning levels, in decreasing order of priority, are
4392 'emergency, 'alert, 'critical, 'error, 'warning, 'notice, 'info, and
4393 'debug.
4394
4395 See also `log-warning-minimum-level'.
4396
4397 You can also control which warnings are displayed on a class-by-class
4398 basis.  See `display-warning-suppressed-classes' and
4399 `log-warning-suppressed-classes'."
4400   :type '(choice (const emergency) (const alert) (const critical)
4401                  (const error) (const warning) (const notice)
4402                  (const info) (const debug))
4403   :group 'warnings)
4404
4405 (defvar log-warning-suppressed-classes nil
4406   "List of classes of warnings that shouldn't be logged or displayed.
4407 If any of the CLASS symbols associated with a warning is the same as
4408 any of the symbols listed here, the warning will be completely ignored,
4409 as it they never happened.
4410
4411 NOTE: In most circumstances, you should *not* set this variable.
4412 Set `display-warning-suppressed-classes' instead.  That way the suppressed
4413 warnings are not displayed but are still unobtrusively logged.
4414
4415 See also `log-warning-minimum-level' and `display-warning-minimum-level'.")
4416
4417 (defcustom display-warning-suppressed-classes nil
4418   "List of classes of warnings that shouldn't be displayed.
4419 If any of the CLASS symbols associated with a warning is the same as
4420 any of the symbols listed here, the warning will not be displayed.
4421 The warning will still logged in the *Warnings* buffer (unless also
4422 contained in `log-warning-suppressed-classes'), but the buffer will
4423 not be automatically popped up.
4424
4425 See also `log-warning-minimum-level' and `display-warning-minimum-level'."
4426   :type '(repeat symbol)
4427   :group 'warnings)
4428
4429 (defvar warning-count 0
4430   "Count of the number of warning messages displayed so far.")
4431
4432 (defconst warning-level-alist '((emergency . 8)
4433                                 (alert . 7)
4434                                 (critical . 6)
4435                                 (error . 5)
4436                                 (warning . 4)
4437                                 (notice . 3)
4438                                 (info . 2)
4439                                 (debug . 1)))
4440
4441 (defun warning-level-p (level)
4442   "Non-nil if LEVEL specifies a warning level."
4443   (and (symbolp level) (assq level warning-level-alist)))
4444
4445 ;; If you're interested in rewriting this function, be aware that it
4446 ;; could be called at arbitrary points in a Lisp program (when a
4447 ;; built-in function wants to issue a warning, it will call out to
4448 ;; this function the next time some Lisp code is evaluated).  Therefore,
4449 ;; this function *must* not permanently modify any global variables
4450 ;; (e.g. the current buffer) except those that specifically apply
4451 ;; to the warning system.
4452
4453 (defvar before-init-deferred-warnings nil)
4454
4455 (defun after-init-display-warnings ()
4456   "Display warnings deferred till after the init file is run.
4457 Warnings that occur before then are deferred so that warning
4458 suppression in the .emacs file will be honored."
4459   (while before-init-deferred-warnings
4460     (apply 'display-warning (car before-init-deferred-warnings))
4461     (setq before-init-deferred-warnings
4462           (cdr before-init-deferred-warnings))))
4463
4464 (add-hook 'after-init-hook 'after-init-display-warnings)
4465
4466 (defun display-warning (class message &optional level)
4467   "Display a warning message.
4468 CLASS should be a symbol describing what sort of warning this is, such
4469 as `resource' or `key-mapping'.  A list of such symbols is also
4470 accepted. (Individual classes can be suppressed; see
4471 `display-warning-suppressed-classes'.)  Optional argument LEVEL can
4472 be used to specify a priority for the warning, other than default priority
4473 `warning'. (See `display-warning-minimum-level').  The message is
4474 inserted into the *Warnings* buffer, which is made visible at appropriate
4475 times."
4476   (or level (setq level 'warning))
4477   (or (listp class) (setq class (list class)))
4478   (check-argument-type 'warning-level-p level)
4479   (if (and (not (featurep 'infodock))
4480            (not init-file-loaded))
4481       (push (list class message level) before-init-deferred-warnings)
4482     (catch 'ignored
4483       (let ((display-p t)
4484             (level-num (cdr (assq level warning-level-alist))))
4485         (if (< level-num (cdr (assq log-warning-minimum-level
4486                                     warning-level-alist)))
4487             (throw 'ignored nil))
4488         (if (intersection class log-warning-suppressed-classes)
4489             (throw 'ignored nil))
4490
4491         (if (< level-num (cdr (assq display-warning-minimum-level
4492                                     warning-level-alist)))
4493             (setq display-p nil))
4494         (if (and display-p
4495                  (intersection class display-warning-suppressed-classes))
4496             (setq display-p nil))
4497         (let ((buffer (get-buffer-create "*Warnings*")))
4498           (when display-p
4499             ;; The C code looks at display-warning-tick to determine
4500             ;; when it should call `display-warning-buffer'.  Change it
4501             ;; to get the C code's attention.
4502             (incf display-warning-tick))
4503           (with-current-buffer buffer
4504             (goto-char (point-max))
4505             (incf warning-count)
4506             (princ (format "(%d) (%s/%s) "
4507                            warning-count
4508                            (mapconcat 'symbol-name class ",")
4509                            level)
4510                    buffer)
4511             (princ message buffer)
4512             (terpri buffer)
4513             (terpri buffer)))))))
4514
4515 (defun warn (&rest args)
4516   "Display a warning message.
4517 The message is constructed by passing all args to `format'.  The message
4518 is placed in the *Warnings* buffer, which will be popped up at the next
4519 redisplay.  The class of the warning is `warning'.  See also
4520 `display-warning'."
4521   (display-warning 'warning (apply 'format args)))
4522
4523 (defun lwarn (class level &rest args)
4524   "Display a labeled warning message.
4525 CLASS should be a symbol describing what sort of warning this is, such
4526 as `resource' or `key-mapping'.  A list of such symbols is also
4527 accepted. (Individual classes can be suppressed; see
4528 `display-warning-suppressed-classes'.)  If non-nil, LEVEL can be used
4529 to specify a priority for the warning, other than default priority
4530 `warning'. (See `display-warning-minimum-level').  The message is
4531 inserted into the *Warnings* buffer, which is made visible at appropriate
4532 times.
4533
4534 The rest of the arguments are passed to `format'."
4535   (display-warning class (apply 'format args)
4536                    (or level 'warning)))
4537
4538 (defvar warning-marker nil)
4539
4540 ;; When this function is called by the C code, all non-local exits are
4541 ;; trapped and C-g is inhibited; therefore, it would be a very, very
4542 ;; bad idea for this function to get into an infinite loop.
4543
4544 (defun display-warning-buffer ()
4545   "Make the buffer that contains the warnings be visible.
4546 The C code calls this periodically, right before redisplay."
4547   (let ((buffer (get-buffer-create "*Warnings*")))
4548     (when (or (not warning-marker)
4549               (not (eq (marker-buffer warning-marker) buffer)))
4550       (setq warning-marker (make-marker))
4551       (set-marker warning-marker 1 buffer))
4552     (if temp-buffer-show-function
4553         (progn
4554           (funcall temp-buffer-show-function buffer)
4555           (mapc #'(lambda (win) (set-window-start win warning-marker))
4556                 (windows-of-buffer buffer nil t)))
4557       (set-window-start (display-buffer buffer) warning-marker))
4558     (set-marker warning-marker (point-max buffer) buffer)))
4559
4560 \f
4561 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4562 ;;                                misc junk                              ;;
4563 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
4564
4565 (defun emacs-name ()
4566   "Return the printable name of this instance of Emacs."
4567   (cond ((featurep 'infodock) "InfoDock")
4568         ((featurep 'xemacs) "XEmacs")
4569         (t "Emacs")))
4570
4571 (defun debug-print (format &rest args)
4572   "Send a string to the debugging output.
4573 The string is formatted using (apply #'format FORMAT ARGS)."
4574   (princ (apply #'format format args) 'external-debugging-output))
4575
4576 ;;; simple.el ends here