Commit | Line | Data |
---|---|---|
6594deb0 ER |
1 | ;;; paragraphs.el --- paragraph and sentence parsing. |
2 | ||
e4550233 RS |
3 | ;; Copyright (C) 1985, 86, 87, 91, 94, 95, 96, 1997 |
4 | ;; Free Software Foundation, Inc. | |
9750e079 | 5 | |
4821e2af | 6 | ;; Maintainer: FSF |
d7b4d18f | 7 | ;; Keywords: wp |
4821e2af | 8 | |
a2535589 JA |
9 | ;; This file is part of GNU Emacs. |
10 | ||
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 | |
29add8b9 | 13 | ;; the Free Software Foundation; either version 2, or (at your option) |
a2535589 JA |
14 | ;; any later version. |
15 | ||
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. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
a2535589 | 25 | |
edbd2f74 ER |
26 | ;;; Commentary: |
27 | ||
28 | ;; This package provides the paragraph-oriented commands documented in the | |
29 | ;; Emacs manual. | |
30 | ||
4821e2af | 31 | ;;; Code: |
a2535589 | 32 | |
e4550233 RS |
33 | (defgroup paragraphs nil |
34 | "Paragraph and sentence parsing." | |
35 | :group 'editing) | |
36 | ||
bde0f7ca RS |
37 | ;; It isn't useful to use defcustom for this variable |
38 | ;; because it is always buffer-local. | |
39 | (defvar use-hard-newlines nil | |
55cc5677 | 40 | "Non-nil means to distinguish hard and soft newlines. |
bde0f7ca | 41 | See documentation for the `use-hard-newlines' function.") |
965eb84a RS |
42 | (make-variable-buffer-local 'use-hard-newlines) |
43 | ||
44 | (defun use-hard-newlines (&optional arg insert) | |
45 | "Minor mode to distinguish hard and soft newlines. | |
46 | When active, the functions `newline' and `open-line' add the | |
47 | text-property `hard' to newlines that they insert, and a line is | |
55cc5677 | 48 | only considered as a candidate to match `paragraph-start' or |
965eb84a | 49 | `paragraph-separate' if it follows a hard newline. |
55cc5677 | 50 | |
965eb84a RS |
51 | Prefix argument says to turn mode on if positive, off if negative. |
52 | When the mode is turned on, if there are newlines in the buffer but no hard | |
53 | newlines, ask the user whether to mark as hard any newlines preceeding a | |
54 | `paragraph-start' line. From a program, second arg INSERT specifies whether | |
55 | to do this; it can be `never' to change nothing, t or `always' to force | |
56 | marking, `guess' to try to do the right thing with no questions, nil | |
57 | or anything else to ask the user. | |
58 | ||
59 | Newlines not marked hard are called \"soft\", and are always internal | |
60 | to paragraphs. The fill functions insert and delete only soft newlines." | |
61 | (interactive (list current-prefix-arg nil)) | |
62 | (if (or (<= (prefix-numeric-value arg) 0) | |
63 | (and use-hard-newlines (null arg))) | |
64 | ;; Turn mode off | |
65 | (setq use-hard-newlines nil) | |
66 | ;; Turn mode on | |
67 | ;; Intuit hard newlines -- | |
68 | ;; mark as hard any newlines preceding a paragraph-start line. | |
69 | (if (or (eq insert t) (eq insert 'always) | |
70 | (and (not (eq 'never insert)) | |
71 | (not use-hard-newlines) | |
72 | (not (text-property-any (point-min) (point-max) 'hard t)) | |
73 | (save-excursion | |
74 | (goto-char (point-min)) | |
75 | (search-forward "\n" nil t)) | |
76 | (or (eq insert 'guess) | |
77 | (y-or-n-p "Make newlines between paragraphs hard? ")))) | |
78 | (save-excursion | |
79 | (goto-char (point-min)) | |
80 | (while (search-forward "\n" nil t) | |
81 | (let ((pos (point))) | |
82 | (move-to-left-margin) | |
83 | (if (looking-at paragraph-start) | |
84 | (progn | |
85 | (set-hard-newline-properties (1- pos) pos) | |
86 | ;; If paragraph-separate, newline after it is hard too. | |
87 | (if (looking-at paragraph-separate) | |
88 | (progn | |
89 | (end-of-line) | |
90 | (if (not (eobp)) | |
91 | (set-hard-newline-properties | |
92 | (point) (1+ (point)))))))))))) | |
93 | (setq use-hard-newlines t))) | |
55cc5677 | 94 | |
e4550233 | 95 | (defcustom paragraph-start "[ \t\n\f]" "\ |
1f2007b3 RS |
96 | *Regexp for beginning of a line that starts OR separates paragraphs. |
97 | This regexp should match lines that separate paragraphs | |
98 | and should also match lines that start a paragraph | |
99 | \(and are part of that paragraph). | |
a37669ec | 100 | |
55cc5677 BG |
101 | This is matched against the text at the left margin, which is not necessarily |
102 | the beginning of the line, so it should never use \"^\" as an anchor. This | |
103 | ensures that the paragraph functions will work equally well within a region | |
104 | of text indented by a margin setting. | |
105 | ||
1f2007b3 | 106 | The variable `paragraph-separate' specifies how to distinguish |
a37669ec RS |
107 | lines that start paragraphs from lines that separate them. |
108 | ||
109 | If the variable `use-hard-newlines' is nonnil, then only lines following a | |
e4550233 RS |
110 | hard newline are considered to match." |
111 | :group 'paragraphs | |
112 | :type 'regexp) | |
6503cec3 | 113 | |
55cc5677 BG |
114 | ;; paragraph-start requires a hard newline, but paragraph-separate does not: |
115 | ;; It is assumed that paragraph-separate is distinctive enough to be believed | |
116 | ;; whenever it occurs, while it is reasonable to set paragraph-start to | |
117 | ;; something very minimal, even including "." (which makes every hard newline | |
118 | ;; start a new paragraph). | |
119 | ||
e4550233 RS |
120 | (defcustom paragraph-separate "[ \t\f]*$" |
121 | "*Regexp for beginning of a line that separates paragraphs. | |
a37669ec RS |
122 | If you change this, you may have to change paragraph-start also. |
123 | ||
55cc5677 BG |
124 | This is matched against the text at the left margin, which is not necessarily |
125 | the beginning of the line, so it should not use \"^\" as an anchor. This | |
126 | ensures that the paragraph functions will work equally within a region of | |
e4550233 RS |
127 | text indented by a margin setting." |
128 | :group 'paragraphs | |
129 | :type 'regexp) | |
6503cec3 | 130 | |
e4550233 RS |
131 | (defcustom sentence-end (purecopy "[.?!][]\"')}]*\\($\\| $\\|\t\\| \\)[ \t\n]*") |
132 | "*Regexp describing the end of a sentence. | |
51534471 JB |
133 | All paragraph boundaries also end sentences, regardless. |
134 | ||
135 | In order to be recognized as the end of a sentence, the ending period, | |
136 | question mark, or exclamation point must be followed by two spaces, | |
e4550233 RS |
137 | unless it's inside some sort of quotes or parenthesis." |
138 | :group 'paragraphs | |
139 | :type 'regexp) | |
140 | ||
141 | (defcustom page-delimiter "^\014" | |
142 | "*Regexp describing line-beginnings that separate pages." | |
143 | :group 'paragraphs | |
144 | :type 'regexp) | |
145 | ||
146 | (defcustom paragraph-ignore-fill-prefix nil | |
147 | "*Non-nil means the paragraph commands are not affected by `fill-prefix'. | |
148 | This is desirable in modes where blank lines are the paragraph delimiters." | |
149 | :group 'paragraphs | |
150 | :type 'boolean) | |
77176e73 | 151 | |
a2535589 JA |
152 | (defun forward-paragraph (&optional arg) |
153 | "Move forward to end of paragraph. | |
94d63a23 RS |
154 | With argument ARG, do it ARG times; |
155 | a negative argument ARG = -N means move backward N paragraphs. | |
a2535589 JA |
156 | |
157 | A line which `paragraph-start' matches either separates paragraphs | |
158 | \(if `paragraph-separate' matches it also) or is the first line of a paragraph. | |
159 | A paragraph end is the beginning of a line which is not part of the paragraph | |
160 | to which the end of the previous line belongs, or the end of the buffer." | |
161 | (interactive "p") | |
162 | (or arg (setq arg 1)) | |
163 | (let* ((fill-prefix-regexp | |
164 | (and fill-prefix (not (equal fill-prefix "")) | |
165 | (not paragraph-ignore-fill-prefix) | |
166 | (regexp-quote fill-prefix))) | |
55cc5677 BG |
167 | ;; Remove ^ from paragraph-start and paragraph-sep if they are there. |
168 | ;; These regexps shouldn't be anchored, because we look for them | |
169 | ;; starting at the left-margin. This allows paragraph commands to | |
170 | ;; work normally with indented text. | |
171 | ;; This hack will not find problem cases like "whatever\\|^something". | |
172 | (paragraph-start (if (and (not (equal "" paragraph-start)) | |
173 | (equal ?^ (aref paragraph-start 0))) | |
174 | (substring paragraph-start 1) | |
175 | paragraph-start)) | |
c4ac30da | 176 | (paragraph-separate (if (and (not (equal "" paragraph-separate)) |
55cc5677 | 177 | (equal ?^ (aref paragraph-separate 0))) |
c4ac30da | 178 | (substring paragraph-separate 1) |
55cc5677 | 179 | paragraph-separate)) |
a2535589 JA |
180 | (paragraph-separate |
181 | (if fill-prefix-regexp | |
55cc5677 | 182 | (concat paragraph-separate "\\|" |
a2535589 | 183 | fill-prefix-regexp "[ \t]*$") |
55cc5677 BG |
184 | paragraph-separate)) |
185 | ;; This is used for searching. | |
186 | (sp-paragraph-start (concat "^[ \t]*\\(" paragraph-start "\\)")) | |
187 | start) | |
8a2a4ced | 188 | (while (and (< arg 0) (not (bobp))) |
55cc5677 | 189 | (if (and (not (looking-at paragraph-separate)) |
a37669ec | 190 | (re-search-backward "^\n" (max (1- (point)) (point-min)) t) |
55cc5677 | 191 | (looking-at paragraph-separate)) |
a2535589 | 192 | nil |
2be01738 | 193 | (setq start (point)) |
8a2a4ced | 194 | ;; Move back over paragraph-separating lines. |
a2535589 | 195 | (forward-char -1) (beginning-of-line) |
a37669ec | 196 | (while (and (not (bobp)) |
55cc5677 BG |
197 | (progn (move-to-left-margin) |
198 | (looking-at paragraph-separate))) | |
199 | (forward-line -1)) | |
8a2a4ced RS |
200 | (if (bobp) |
201 | nil | |
202 | ;; Go to end of the previous (non-separating) line. | |
203 | (end-of-line) | |
204 | ;; Search back for line that starts or separates paragraphs. | |
205 | (if (if fill-prefix-regexp | |
206 | ;; There is a fill prefix; it overrides paragraph-start. | |
2be01738 | 207 | (let (multiple-lines) |
55cc5677 BG |
208 | (while (and (progn (beginning-of-line) (not (bobp))) |
209 | (progn (move-to-left-margin) | |
210 | (not (looking-at paragraph-separate))) | |
211 | (looking-at fill-prefix-regexp)) | |
2be01738 RS |
212 | (if (not (= (point) start)) |
213 | (setq multiple-lines t)) | |
55cc5677 | 214 | (forward-line -1)) |
2be01738 | 215 | (move-to-left-margin) |
b53ce41d RS |
216 | ;;; This deleted code caused a long hanging-indent line |
217 | ;;; not to be filled together with the following lines. | |
218 | ;;; ;; Don't move back over a line before the paragraph | |
219 | ;;; ;; which doesn't start with fill-prefix | |
220 | ;;; ;; unless that is the only line we've moved over. | |
221 | ;;; (and (not (looking-at fill-prefix-regexp)) | |
222 | ;;; multiple-lines | |
223 | ;;; (forward-line 1)) | |
2be01738 | 224 | (not (bobp))) |
55cc5677 BG |
225 | (while (and (re-search-backward sp-paragraph-start nil 1) |
226 | ;; Found a candidate, but need to check if it is a | |
227 | ;; REAL paragraph-start. | |
a37669ec | 228 | (not (bobp)) |
55cc5677 BG |
229 | (progn (setq start (point)) |
230 | (move-to-left-margin) | |
231 | (not (looking-at paragraph-separate))) | |
232 | (or (not (looking-at paragraph-start)) | |
233 | (and use-hard-newlines | |
234 | (not (get-text-property (1- start) | |
235 | 'hard))))) | |
236 | (goto-char start)) | |
a37669ec | 237 | (> (point) (point-min))) |
8a2a4ced RS |
238 | ;; Found one. |
239 | (progn | |
240 | ;; Move forward over paragraph separators. | |
241 | ;; We know this cannot reach the place we started | |
242 | ;; because we know we moved back over a non-separator. | |
55cc5677 BG |
243 | (while (and (not (eobp)) |
244 | (progn (move-to-left-margin) | |
245 | (looking-at paragraph-separate))) | |
8a2a4ced | 246 | (forward-line 1)) |
55cc5677 BG |
247 | ;; If line before paragraph is just margin, back up to there. |
248 | (end-of-line 0) | |
249 | (if (> (current-column) (current-left-margin)) | |
250 | (forward-char 1) | |
251 | (skip-chars-backward " \t") | |
252 | (if (not (bolp)) | |
253 | (forward-line 1)))) | |
8a2a4ced RS |
254 | ;; No starter or separator line => use buffer beg. |
255 | (goto-char (point-min))))) | |
a2535589 | 256 | (setq arg (1+ arg))) |
8a2a4ced | 257 | (while (and (> arg 0) (not (eobp))) |
88c2fc2c | 258 | ;; Move forward over separator lines, and one more line. |
a2535589 | 259 | (while (prog1 (and (not (eobp)) |
55cc5677 BG |
260 | (progn (move-to-left-margin) (not (eobp))) |
261 | (looking-at paragraph-separate)) | |
a37669ec | 262 | (forward-line 1))) |
a2535589 JA |
263 | (if fill-prefix-regexp |
264 | ;; There is a fill prefix; it overrides paragraph-start. | |
265 | (while (and (not (eobp)) | |
55cc5677 BG |
266 | (progn (move-to-left-margin) (not (eobp))) |
267 | (not (looking-at paragraph-separate)) | |
a2535589 JA |
268 | (looking-at fill-prefix-regexp)) |
269 | (forward-line 1)) | |
55cc5677 | 270 | (while (and (re-search-forward sp-paragraph-start nil 1) |
55cc5677 BG |
271 | (progn (setq start (match-beginning 0)) |
272 | (goto-char start) | |
4669fb3c RS |
273 | (not (eobp))) |
274 | (progn (move-to-left-margin) | |
55cc5677 BG |
275 | (not (looking-at paragraph-separate))) |
276 | (or (not (looking-at paragraph-start)) | |
277 | (and use-hard-newlines | |
278 | (not (get-text-property (1- start) 'hard))))) | |
a37669ec RS |
279 | (forward-char 1)) |
280 | (if (< (point) (point-max)) | |
55cc5677 | 281 | (goto-char start))) |
a2535589 JA |
282 | (setq arg (1- arg))))) |
283 | ||
284 | (defun backward-paragraph (&optional arg) | |
285 | "Move backward to start of paragraph. | |
94d63a23 RS |
286 | With argument ARG, do it ARG times; |
287 | a negative argument ARG = -N means move forward N paragraphs. | |
a2535589 | 288 | |
23b34992 BP |
289 | A paragraph start is the beginning of a line which is a |
290 | `first-line-of-paragraph' or which is ordinary text and follows a | |
291 | paragraph-separating line; except: if the first real line of a | |
292 | paragraph is preceded by a blank line, the paragraph starts at that | |
293 | blank line. | |
294 | ||
295 | See `forward-paragraph' for more information." | |
a2535589 JA |
296 | (interactive "p") |
297 | (or arg (setq arg 1)) | |
298 | (forward-paragraph (- arg))) | |
299 | ||
300 | (defun mark-paragraph () | |
301 | "Put point at beginning of this paragraph, mark at end. | |
302 | The paragraph marked is the one that contains point or follows point." | |
303 | (interactive) | |
304 | (forward-paragraph 1) | |
0b108c01 | 305 | (push-mark nil t t) |
a2535589 JA |
306 | (backward-paragraph 1)) |
307 | ||
308 | (defun kill-paragraph (arg) | |
309 | "Kill forward to end of paragraph. | |
310 | With arg N, kill forward to Nth end of paragraph; | |
311 | negative arg -N means kill backward to Nth start of paragraph." | |
23b34992 | 312 | (interactive "p") |
8d6eaa00 | 313 | (kill-region (point) (progn (forward-paragraph arg) (point)))) |
a2535589 JA |
314 | |
315 | (defun backward-kill-paragraph (arg) | |
316 | "Kill back to start of paragraph. | |
317 | With arg N, kill back to Nth start of paragraph; | |
318 | negative arg -N means kill forward to Nth end of paragraph." | |
23b34992 | 319 | (interactive "p") |
8d6eaa00 | 320 | (kill-region (point) (progn (backward-paragraph arg) (point)))) |
a2535589 JA |
321 | |
322 | (defun transpose-paragraphs (arg) | |
323 | "Interchange this (or next) paragraph with previous one." | |
324 | (interactive "*p") | |
325 | (transpose-subr 'forward-paragraph arg)) | |
326 | ||
327 | (defun start-of-paragraph-text () | |
328 | (let ((opoint (point)) npoint) | |
329 | (forward-paragraph -1) | |
330 | (setq npoint (point)) | |
331 | (skip-chars-forward " \t\n") | |
b4e6c391 RS |
332 | ;; If the range of blank lines found spans the original start point, |
333 | ;; try again from the beginning of it. | |
334 | ;; Must be careful to avoid infinite loop | |
335 | ;; when following a single return at start of buffer. | |
336 | (if (and (>= (point) opoint) (< npoint opoint)) | |
a2535589 JA |
337 | (progn |
338 | (goto-char npoint) | |
339 | (if (> npoint (point-min)) | |
340 | (start-of-paragraph-text)))))) | |
341 | ||
342 | (defun end-of-paragraph-text () | |
343 | (let ((opoint (point))) | |
344 | (forward-paragraph 1) | |
345 | (if (eq (preceding-char) ?\n) (forward-char -1)) | |
346 | (if (<= (point) opoint) | |
347 | (progn | |
348 | (forward-char 1) | |
349 | (if (< (point) (point-max)) | |
350 | (end-of-paragraph-text)))))) | |
351 | ||
352 | (defun forward-sentence (&optional arg) | |
51534471 | 353 | "Move forward to next `sentence-end'. With argument, repeat. |
23b34992 | 354 | With negative argument, move backward repeatedly to `sentence-beginning'. |
a2535589 | 355 | |
23b34992 BP |
356 | The variable `sentence-end' is a regular expression that matches ends of |
357 | sentences. Also, every paragraph boundary terminates sentences as well." | |
a2535589 JA |
358 | (interactive "p") |
359 | (or arg (setq arg 1)) | |
360 | (while (< arg 0) | |
361 | (let ((par-beg (save-excursion (start-of-paragraph-text) (point)))) | |
362 | (if (re-search-backward (concat sentence-end "[^ \t\n]") par-beg t) | |
363 | (goto-char (1- (match-end 0))) | |
364 | (goto-char par-beg))) | |
365 | (setq arg (1+ arg))) | |
366 | (while (> arg 0) | |
367 | (let ((par-end (save-excursion (end-of-paragraph-text) (point)))) | |
368 | (if (re-search-forward sentence-end par-end t) | |
369 | (skip-chars-backward " \t\n") | |
370 | (goto-char par-end))) | |
371 | (setq arg (1- arg)))) | |
372 | ||
373 | (defun backward-sentence (&optional arg) | |
374 | "Move backward to start of sentence. With arg, do it arg times. | |
23b34992 | 375 | See `forward-sentence' for more information." |
a2535589 JA |
376 | (interactive "p") |
377 | (or arg (setq arg 1)) | |
378 | (forward-sentence (- arg))) | |
379 | ||
380 | (defun kill-sentence (&optional arg) | |
381 | "Kill from point to end of sentence. | |
382 | With arg, repeat; negative arg -N means kill back to Nth start of sentence." | |
b0e1e38f | 383 | (interactive "p") |
8d6eaa00 | 384 | (kill-region (point) (progn (forward-sentence arg) (point)))) |
a2535589 JA |
385 | |
386 | (defun backward-kill-sentence (&optional arg) | |
387 | "Kill back from point to start of sentence. | |
388 | With arg, repeat, or kill forward to Nth end of sentence if negative arg -N." | |
b0e1e38f | 389 | (interactive "p") |
8d6eaa00 | 390 | (kill-region (point) (progn (backward-sentence arg) (point)))) |
a2535589 JA |
391 | |
392 | (defun mark-end-of-sentence (arg) | |
23b34992 | 393 | "Put mark at end of sentence. Arg works as in `forward-sentence'." |
a2535589 JA |
394 | (interactive "p") |
395 | (push-mark | |
396 | (save-excursion | |
397 | (forward-sentence arg) | |
a524dc5b RS |
398 | (point)) |
399 | nil t)) | |
a2535589 JA |
400 | |
401 | (defun transpose-sentences (arg) | |
402 | "Interchange this (next) and previous sentence." | |
403 | (interactive "*p") | |
404 | (transpose-subr 'forward-sentence arg)) | |
6594deb0 ER |
405 | |
406 | ;;; paragraphs.el ends here |