annotate lisp/page.el @ 931:3508e2f71814

[xemacs-hg @ 2002-07-24 04:46:29 by andyp] gutter enhancement
author andyp
date Wed, 24 Jul 2002 04:46:29 +0000
parents 1ccc32a20af4
children 6f72d9a709c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; page.el --- page motion commands for emacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1985, 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5 ;; Maintainer: FSF
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6 ;; Keywords: extensions, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
7
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25 ;;; Synched up with: FSF 19.34.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29 ;; This file is dumped with XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31 ;; This code provides the page-oriented movement and selection commands
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32 ;; documented in the XEmacs Reference Manual.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36 (defun forward-page (&optional count)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 "Move forward to page boundary. With arg, repeat, or go back if negative.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38 A page boundary is any line whose beginning matches the regexp
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39 `page-delimiter'."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40 (interactive "_p") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41 (or count (setq count 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 (while (and (> count 0) (not (eobp)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43 ;; In case the page-delimiter matches the null string,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 ;; don't find a match without moving.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45 (if (bolp) (forward-char 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 (if (re-search-forward page-delimiter nil t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 nil
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48 (goto-char (point-max)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 (setq count (1- count)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50 (while (and (< count 0) (not (bobp)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51 ;; In case the page-delimiter matches the null string,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 ;; don't find a match without moving.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53 (and (save-excursion (re-search-backward page-delimiter nil t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 (= (match-end 0) (point))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 (goto-char (match-beginning 0)))
446
1ccc32a20af4 Import from CVS: tag r21-2-38
cvs
parents: 209
diff changeset
56 (backward-char 1)
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57 (if (re-search-backward page-delimiter nil t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 ;; We found one--move to the end of it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59 (goto-char (match-end 0))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60 ;; We found nothing--go to beg of buffer.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 (goto-char (point-min)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 (setq count (1+ count))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64 (defun backward-page (&optional count)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 "Move backward to page boundary. With arg, repeat, or go fwd if negative.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 A page boundary is any line whose beginning matches the regexp
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 `page-delimiter'."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68 (interactive "_p") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 (or count (setq count 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 (forward-page (- count)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72 (defun mark-page (&optional arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73 "Put mark at end of page, point at beginning.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 A numeric arg specifies to move forward or backward by that many pages,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 thus marking a page other than the one point was originally in."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 (interactive "P")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 (setq arg (if arg (prefix-numeric-value arg) 0))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78 (if (> arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (forward-page arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 (if (< arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (forward-page (1- arg))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82 (forward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83 (push-mark nil t t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 (forward-page -1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86 (defun narrow-to-page (&optional arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 "Make text outside current page invisible.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88 A numeric arg specifies to move forward or backward by that many pages,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 thus showing a page other than the one point was originally in."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 (interactive "P")
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 (setq arg (if arg (prefix-numeric-value arg) 0))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 (widen)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94 (if (> arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 (forward-page arg)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96 (if (< arg 0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97 (forward-page (1- arg))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
98 ;; Find the end of the page.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
99 (forward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
100 ;; If we stopped due to end of buffer, stay there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
101 ;; If we stopped after a page delimiter, put end of restriction
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102 ;; at the beginning of that line.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
103 (if (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
104 (goto-char (match-beginning 0)) ; was (beginning-of-line)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
105 (looking-at page-delimiter))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
106 (beginning-of-line))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
107 (narrow-to-region (point)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 (progn
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
109 ;; Find the top of the page.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 (forward-page -1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 ;; If we found beginning of buffer, stay there.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112 ;; If extra text follows page delimiter on same line,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113 ;; include it.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
114 ;; Otherwise, show text starting with following line.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
115 (if (and (eolp) (not (bobp)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
116 (forward-line 1))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
117 (point)))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
118 (put 'narrow-to-page 'disabled t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
119
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
120 (defun count-lines-page ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
121 "Report number of lines on current page, and how many are before or after point."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
122 (interactive "_") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
123 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
124 (let ((opoint (point)) beg end
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
125 total before after)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
126 (forward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
127 (beginning-of-line)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
128 (or (looking-at page-delimiter)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
129 (end-of-line))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
130 (setq end (point))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
131 (backward-page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
132 (setq beg (point))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
133 (setq total (count-lines beg end)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
134 before (count-lines beg opoint)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
135 after (count-lines opoint end))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
136 (message "Page has %d lines (%d + %d)" total before after))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
137
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
138 (defun what-page ()
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
139 "Print page and line number of point."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
140 (interactive "_") ; XEmacs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
141 (save-restriction
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
142 (widen)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
143 (save-excursion
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
144 (beginning-of-line)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
145 (let ((count 1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
146 (opoint (point)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
147 (goto-char 1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
148 (while (re-search-forward page-delimiter opoint t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
149 (setq count (1+ count)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
150 (message "Page %d, line %d"
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
151 count
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
152 (1+ (count-lines (point) opoint)))))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
153
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
154 ;;; Place `provide' at end of file.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
155 (provide 'page)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
156
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
157 ;;; page.el ends here