Mercurial > emacs
annotate lisp/textmodes/paragraphs.el @ 6782:5b07647ec8f7
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 10 Apr 1994 00:23:58 +0000 |
parents | db6bea4e5345 |
children | 19a84bb30e9e |
rev | line source |
---|---|
659
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
1 ;;; paragraphs.el --- paragraph and sentence parsing. |
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
2 |
845 | 3 ;; Copyright (C) 1985, 86, 87, 1991 Free Software Foundation, Inc. |
4 | |
789
71d052f72ac1
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
5 ;; Maintainer: FSF |
814
38b2499cb3e9
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
804
diff
changeset
|
6 ;; Keywords: wp |
789
71d052f72ac1
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
7 |
36 | 8 ;; This file is part of GNU Emacs. |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it under the terms of the GNU General Public License as published by | |
804 | 12 ;; the Free Software Foundation; either version 2, or (at your option) |
36 | 13 ;; any later version. |
14 | |
15 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
23 | |
2308
f287613dfc28
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1462
diff
changeset
|
24 ;;; Commentary: |
f287613dfc28
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1462
diff
changeset
|
25 |
f287613dfc28
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1462
diff
changeset
|
26 ;; This package provides the paragraph-oriented commands documented in the |
f287613dfc28
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1462
diff
changeset
|
27 ;; Emacs manual. |
f287613dfc28
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1462
diff
changeset
|
28 |
789
71d052f72ac1
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
732
diff
changeset
|
29 ;;; Code: |
36 | 30 |
269 | 31 (defconst paragraph-start "^[ \t\n\f]" "\ |
4585
04e78c728252
(paragraph-start): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
2828
diff
changeset
|
32 *Regexp for beginning of a line that starts OR separates paragraphs. |
04e78c728252
(paragraph-start): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
2828
diff
changeset
|
33 This regexp should match lines that separate paragraphs |
04e78c728252
(paragraph-start): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
2828
diff
changeset
|
34 and should also match lines that start a paragraph |
04e78c728252
(paragraph-start): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
2828
diff
changeset
|
35 \(and are part of that paragraph). |
04e78c728252
(paragraph-start): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
2828
diff
changeset
|
36 The variable `paragraph-separate' specifies how to distinguish |
04e78c728252
(paragraph-start): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
2828
diff
changeset
|
37 lines that start paragraphs from lines that separate them.") |
264 | 38 |
269 | 39 (defconst paragraph-separate "^[ \t\f]*$" "\ |
40 *Regexp for beginning of a line that separates paragraphs. | |
41 If you change this, you may have to change paragraph-start also.") | |
264 | 42 |
269 | 43 (defconst sentence-end (purecopy "[.?!][]\"')}]*\\($\\| $\\|\t\\| \\)[ \t\n]*") "\ |
44 *Regexp describing the end of a sentence. | |
2503
fb3509fdf8b7
Sat Apr 10 00:39:29 1993 Jim Blandy (jimb@totoro.cs.oberlin.edu)
Jim Blandy <jimb@redhat.com>
parents:
2308
diff
changeset
|
45 All paragraph boundaries also end sentences, regardless. |
fb3509fdf8b7
Sat Apr 10 00:39:29 1993 Jim Blandy (jimb@totoro.cs.oberlin.edu)
Jim Blandy <jimb@redhat.com>
parents:
2308
diff
changeset
|
46 |
fb3509fdf8b7
Sat Apr 10 00:39:29 1993 Jim Blandy (jimb@totoro.cs.oberlin.edu)
Jim Blandy <jimb@redhat.com>
parents:
2308
diff
changeset
|
47 In order to be recognized as the end of a sentence, the ending period, |
fb3509fdf8b7
Sat Apr 10 00:39:29 1993 Jim Blandy (jimb@totoro.cs.oberlin.edu)
Jim Blandy <jimb@redhat.com>
parents:
2308
diff
changeset
|
48 question mark, or exclamation point must be followed by two spaces, |
fb3509fdf8b7
Sat Apr 10 00:39:29 1993 Jim Blandy (jimb@totoro.cs.oberlin.edu)
Jim Blandy <jimb@redhat.com>
parents:
2308
diff
changeset
|
49 unless it's inside some sort of quotes or parenthesis.") |
264 | 50 |
269 | 51 (defconst page-delimiter "^\014" "\ |
52 *Regexp describing line-beginnings that separate pages.") | |
264 | 53 |
269 | 54 (defvar paragraph-ignore-fill-prefix nil "\ |
55 Non-nil means the paragraph commands are not affected by `fill-prefix'. | |
56 This is desirable in modes where blank lines are the paragraph delimiters.") | |
264 | 57 |
36 | 58 |
59 (defun forward-paragraph (&optional arg) | |
60 "Move forward to end of paragraph. | |
5653
db6bea4e5345
(forward-paragraph): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
5608
diff
changeset
|
61 With arg N, do it N times; negative arg -N means move backward N paragraphs. |
36 | 62 |
63 A line which `paragraph-start' matches either separates paragraphs | |
64 \(if `paragraph-separate' matches it also) or is the first line of a paragraph. | |
65 A paragraph end is the beginning of a line which is not part of the paragraph | |
66 to which the end of the previous line belongs, or the end of the buffer." | |
67 (interactive "p") | |
68 (or arg (setq arg 1)) | |
69 (let* ((fill-prefix-regexp | |
70 (and fill-prefix (not (equal fill-prefix "")) | |
71 (not paragraph-ignore-fill-prefix) | |
72 (regexp-quote fill-prefix))) | |
73 (paragraph-separate | |
74 (if fill-prefix-regexp | |
75 (concat paragraph-separate "\\|^" | |
76 fill-prefix-regexp "[ \t]*$") | |
77 paragraph-separate))) | |
5608
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
78 (while (and (< arg 0) (not (bobp))) |
36 | 79 (if (and (not (looking-at paragraph-separate)) |
80 (re-search-backward "^\n" (max (1- (point)) (point-min)) t)) | |
81 nil | |
5608
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
82 ;; Move back over paragraph-separating lines. |
36 | 83 (forward-char -1) (beginning-of-line) |
84 (while (and (not (bobp)) (looking-at paragraph-separate)) | |
85 (forward-line -1)) | |
5608
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
86 (if (bobp) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
87 nil |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
88 ;; Go to end of the previous (non-separating) line. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
89 (end-of-line) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
90 ;; Search back for line that starts or separates paragraphs. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
91 (if (if fill-prefix-regexp |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
92 ;; There is a fill prefix; it overrides paragraph-start. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
93 (progn |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
94 (while (progn (beginning-of-line) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
95 (and (not (bobp)) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
96 (not (looking-at paragraph-separate)) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
97 (looking-at fill-prefix-regexp))) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
98 (forward-line -1)) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
99 (not (bobp))) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
100 (re-search-backward paragraph-start nil t)) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
101 ;; Found one. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
102 (progn |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
103 ;; Move forward over paragraph separators. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
104 ;; We know this cannot reach the place we started |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
105 ;; because we know we moved back over a non-separator. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
106 (while (and (not (eobp)) (looking-at paragraph-separate)) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
107 (forward-line 1)) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
108 (if (eq (char-after (- (point) 2)) ?\n) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
109 (forward-line -1))) |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
110 ;; No starter or separator line => use buffer beg. |
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
111 (goto-char (point-min))))) |
36 | 112 (setq arg (1+ arg))) |
5608
c4c662362d39
(forward-paragraph): If moving back we find nothing
Richard M. Stallman <rms@gnu.org>
parents:
4585
diff
changeset
|
113 (while (and (> arg 0) (not (eobp))) |
36 | 114 (beginning-of-line) |
115 (while (prog1 (and (not (eobp)) | |
116 (looking-at paragraph-separate)) | |
117 (forward-line 1))) | |
118 (if fill-prefix-regexp | |
119 ;; There is a fill prefix; it overrides paragraph-start. | |
120 (while (and (not (eobp)) | |
121 (not (looking-at paragraph-separate)) | |
122 (looking-at fill-prefix-regexp)) | |
123 (forward-line 1)) | |
124 (if (re-search-forward paragraph-start nil t) | |
125 (goto-char (match-beginning 0)) | |
126 (goto-char (point-max)))) | |
127 (setq arg (1- arg))))) | |
128 | |
129 (defun backward-paragraph (&optional arg) | |
130 "Move backward to start of paragraph. | |
131 With arg N, do it N times; negative arg -N means move forward N paragraphs. | |
132 | |
237 | 133 A paragraph start is the beginning of a line which is a |
134 `first-line-of-paragraph' or which is ordinary text and follows a | |
135 paragraph-separating line; except: if the first real line of a | |
136 paragraph is preceded by a blank line, the paragraph starts at that | |
137 blank line. | |
138 | |
139 See `forward-paragraph' for more information." | |
36 | 140 (interactive "p") |
141 (or arg (setq arg 1)) | |
142 (forward-paragraph (- arg))) | |
143 | |
144 (defun mark-paragraph () | |
145 "Put point at beginning of this paragraph, mark at end. | |
146 The paragraph marked is the one that contains point or follows point." | |
147 (interactive) | |
148 (forward-paragraph 1) | |
2827
0daa9d777306
(mark-paragraph): Activate the mark.
Richard M. Stallman <rms@gnu.org>
parents:
2503
diff
changeset
|
149 (push-mark nil t t) |
36 | 150 (backward-paragraph 1)) |
151 | |
152 (defun kill-paragraph (arg) | |
153 "Kill forward to end of paragraph. | |
154 With arg N, kill forward to Nth end of paragraph; | |
155 negative arg -N means kill backward to Nth start of paragraph." | |
237 | 156 (interactive "p") |
1435
4fef92b213f6
(kill-sentence, backward-kill-sentence):
Richard M. Stallman <rms@gnu.org>
parents:
845
diff
changeset
|
157 (kill-region (point) (save-excursion (forward-paragraph arg) (point)))) |
36 | 158 |
159 (defun backward-kill-paragraph (arg) | |
160 "Kill back to start of paragraph. | |
161 With arg N, kill back to Nth start of paragraph; | |
162 negative arg -N means kill forward to Nth end of paragraph." | |
237 | 163 (interactive "p") |
1435
4fef92b213f6
(kill-sentence, backward-kill-sentence):
Richard M. Stallman <rms@gnu.org>
parents:
845
diff
changeset
|
164 (kill-region (point) (save-excursion (backward-paragraph arg) (point)))) |
36 | 165 |
166 (defun transpose-paragraphs (arg) | |
167 "Interchange this (or next) paragraph with previous one." | |
168 (interactive "*p") | |
169 (transpose-subr 'forward-paragraph arg)) | |
170 | |
171 (defun start-of-paragraph-text () | |
172 (let ((opoint (point)) npoint) | |
173 (forward-paragraph -1) | |
174 (setq npoint (point)) | |
175 (skip-chars-forward " \t\n") | |
68 | 176 ;; If the range of blank lines found spans the original start point, |
177 ;; try again from the beginning of it. | |
178 ;; Must be careful to avoid infinite loop | |
179 ;; when following a single return at start of buffer. | |
180 (if (and (>= (point) opoint) (< npoint opoint)) | |
36 | 181 (progn |
182 (goto-char npoint) | |
183 (if (> npoint (point-min)) | |
184 (start-of-paragraph-text)))))) | |
185 | |
186 (defun end-of-paragraph-text () | |
187 (let ((opoint (point))) | |
188 (forward-paragraph 1) | |
189 (if (eq (preceding-char) ?\n) (forward-char -1)) | |
190 (if (<= (point) opoint) | |
191 (progn | |
192 (forward-char 1) | |
193 (if (< (point) (point-max)) | |
194 (end-of-paragraph-text)))))) | |
195 | |
196 (defun forward-sentence (&optional arg) | |
2503
fb3509fdf8b7
Sat Apr 10 00:39:29 1993 Jim Blandy (jimb@totoro.cs.oberlin.edu)
Jim Blandy <jimb@redhat.com>
parents:
2308
diff
changeset
|
197 "Move forward to next `sentence-end'. With argument, repeat. |
237 | 198 With negative argument, move backward repeatedly to `sentence-beginning'. |
36 | 199 |
237 | 200 The variable `sentence-end' is a regular expression that matches ends of |
201 sentences. Also, every paragraph boundary terminates sentences as well." | |
36 | 202 (interactive "p") |
203 (or arg (setq arg 1)) | |
204 (while (< arg 0) | |
205 (let ((par-beg (save-excursion (start-of-paragraph-text) (point)))) | |
206 (if (re-search-backward (concat sentence-end "[^ \t\n]") par-beg t) | |
207 (goto-char (1- (match-end 0))) | |
208 (goto-char par-beg))) | |
209 (setq arg (1+ arg))) | |
210 (while (> arg 0) | |
211 (let ((par-end (save-excursion (end-of-paragraph-text) (point)))) | |
212 (if (re-search-forward sentence-end par-end t) | |
213 (skip-chars-backward " \t\n") | |
214 (goto-char par-end))) | |
215 (setq arg (1- arg)))) | |
216 | |
217 (defun backward-sentence (&optional arg) | |
218 "Move backward to start of sentence. With arg, do it arg times. | |
237 | 219 See `forward-sentence' for more information." |
36 | 220 (interactive "p") |
221 (or arg (setq arg 1)) | |
222 (forward-sentence (- arg))) | |
223 | |
224 (defun kill-sentence (&optional arg) | |
225 "Kill from point to end of sentence. | |
226 With arg, repeat; negative arg -N means kill back to Nth start of sentence." | |
227 (interactive "*p") | |
1435
4fef92b213f6
(kill-sentence, backward-kill-sentence):
Richard M. Stallman <rms@gnu.org>
parents:
845
diff
changeset
|
228 (kill-region (point) (save-excursion (forward-sentence arg) (point)))) |
36 | 229 |
230 (defun backward-kill-sentence (&optional arg) | |
231 "Kill back from point to start of sentence. | |
232 With arg, repeat, or kill forward to Nth end of sentence if negative arg -N." | |
233 (interactive "*p") | |
1462
876e54ad6936
(backward-kill-sentence): Fix typo in last change.
Richard M. Stallman <rms@gnu.org>
parents:
1435
diff
changeset
|
234 (kill-region (point) (save-excursion (backward-sentence arg) (point)))) |
36 | 235 |
236 (defun mark-end-of-sentence (arg) | |
237 | 237 "Put mark at end of sentence. Arg works as in `forward-sentence'." |
36 | 238 (interactive "p") |
239 (push-mark | |
240 (save-excursion | |
241 (forward-sentence arg) | |
2828
abc6df78588f
(mark-end-of-sentence): Activate the mark.
Richard M. Stallman <rms@gnu.org>
parents:
2827
diff
changeset
|
242 (point)) |
abc6df78588f
(mark-end-of-sentence): Activate the mark.
Richard M. Stallman <rms@gnu.org>
parents:
2827
diff
changeset
|
243 nil t)) |
36 | 244 |
245 (defun transpose-sentences (arg) | |
246 "Interchange this (next) and previous sentence." | |
247 (interactive "*p") | |
248 (transpose-subr 'forward-sentence arg)) | |
659
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
249 |
505130d1ddf8
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
250 ;;; paragraphs.el ends here |