1 ;;; page.el --- page motion commands for Emacs
3 ;; Copyright (C) 1985, 2001-2013 Free Software Foundation, Inc.
6 ;; Keywords: wp convenience
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; This code provides the page-oriented movement and selection commands
27 ;; documented in the Emacs manual.
31 (defun forward-page (&optional count)
32 "Move forward to page boundary. With arg, repeat, or go back if negative.
33 A page boundary is any line whose beginning matches the regexp
36 (or count (setq count 1))
37 (while (and (> count 0) (not (eobp)))
38 ;; In case the page-delimiter matches the null string,
39 ;; don't find a match without moving.
40 (if (bolp) (forward-char 1))
41 (if (re-search-forward page-delimiter nil t)
43 (goto-char (point-max)))
44 (setq count (1- count)))
45 (while (and (< count 0) (not (bobp)))
46 ;; In case the page-delimiter matches the null string,
47 ;; don't find a match without moving.
48 (and (save-excursion (re-search-backward page-delimiter nil t))
49 (= (match-end 0) (point))
50 (goto-char (match-beginning 0)))
52 (if (re-search-backward page-delimiter nil t)
53 ;; We found one--move to the end of it.
54 (goto-char (match-end 0))
55 ;; We found nothing--go to beg of buffer.
56 (goto-char (point-min)))
57 (setq count (1+ count))))
59 (defun backward-page (&optional count)
60 "Move backward to page boundary. With arg, repeat, or go fwd if negative.
61 A page boundary is any line whose beginning matches the regexp
64 (or count (setq count 1))
65 (forward-page (- count)))
67 (defun mark-page (&optional arg)
68 "Put mark at end of page, point at beginning.
69 A numeric arg specifies to move forward or backward by that many pages,
70 thus marking a page other than the one point was originally in."
72 (setq arg (if arg (prefix-numeric-value arg) 0))
76 (forward-page (1- arg))))
81 (defun narrow-to-page (&optional arg)
82 "Make text outside current page invisible.
83 A numeric arg specifies to move forward or backward by that many pages,
84 thus showing a page other than the one point was originally in."
86 (setq arg (if arg (prefix-numeric-value arg) 0))
94 ;; If we are not now at the beginning of a page,
95 ;; move back one extra time, to get to the start of this page.
98 (or (and (looking-at page-delimiter)
99 (eq (match-end 0) opoint))
101 (forward-page (- arg adjust)))))
102 ;; Find the end of the page.
105 ;; If we stopped due to end of buffer, stay there.
106 ;; If we stopped after a page delimiter, put end of restriction
107 ;; at the beginning of that line.
108 ;; Before checking the match that was found,
109 ;; verify that forward-page actually set the match data.
110 (if (and (match-beginning 0)
112 (goto-char (match-beginning 0)) ; was (beginning-of-line)
113 (looking-at page-delimiter)))
114 (goto-char (match-beginning 0))) ; was (beginning-of-line)
115 (narrow-to-region (point)
117 ;; Find the top of the page.
119 ;; If we found beginning of buffer, stay there.
120 ;; If extra text follows page delimiter on same line,
122 ;; Otherwise, show text starting with following line.
123 (if (and (eolp) (not (bobp)))
126 (put 'narrow-to-page 'disabled t)
128 (defun count-lines-page ()
129 "Report number of lines on current page, and how many are before or after point."
132 (let ((opoint (point)) beg end
136 (or (looking-at page-delimiter)
141 (setq total (count-lines beg end)
142 before (count-lines beg opoint)
143 after (count-lines opoint end))
144 (message "Page has %d lines (%d + %d)" total before after))))
147 "Print page and line number of point."
154 (goto-char (point-min))
155 (while (re-search-forward page-delimiter opoint t)
156 (if (= (match-beginning 0) (match-end 0))
158 (setq count (1+ count)))
159 (message "Page %d, line %d" count (line-number-at-pos opoint))))))
163 ;;; Place `provide' at end of file.
166 ;;; page.el ends here