1 ;;; paragraphs.el --- paragraph and sentence parsing
3 ;; Copyright (C) 1985, 1986, 1987, 1991, 1994, 1995, 1996, 1997, 1999, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
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 2, or (at your option)
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; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; This package provides the paragraph-oriented commands documented in the
33 (defgroup paragraphs nil
34 "Paragraph and sentence parsing."
37 (put 'use-hard-newlines
'permanent-local t
)
38 (define-minor-mode use-hard-newlines
39 "Minor mode to distinguish hard and soft newlines.
40 When active, the functions `newline' and `open-line' add the
41 text-property `hard' to newlines that they insert, and a line is
42 only considered as a candidate to match `paragraph-start' or
43 `paragraph-separate' if it follows a hard newline.
45 Prefix argument says to turn mode on if positive, off if negative.
46 When the mode is turned on, if there are newlines in the buffer but no hard
47 newlines, ask the user whether to mark as hard any newlines preceeding a
48 `paragraph-start' line. From a program, second arg INSERT specifies whether
49 to do this; it can be `never' to change nothing, t or `always' to force
50 marking, `guess' to try to do the right thing with no questions, nil
51 or anything else to ask the user.
53 Newlines not marked hard are called \"soft\", and are always internal
54 to paragraphs. The fill functions insert and delete only soft newlines."
57 (when use-hard-newlines
59 ;; Intuit hard newlines --
60 ;; mark as hard any newlines preceding a paragraph-start line.
61 (if (or (eq insert t
) (eq insert
'always
)
62 (and (not (eq 'never insert
))
63 (not (text-property-any (point-min) (point-max) 'hard t
))
65 (goto-char (point-min))
66 (search-forward "\n" nil t
))
67 (or (eq insert
'guess
)
68 (y-or-n-p "Make newlines between paragraphs hard? "))))
70 (goto-char (point-min))
71 (while (search-forward "\n" nil t
)
74 (when (looking-at paragraph-start
)
75 (set-hard-newline-properties (1- pos
) pos
))
76 ;; If paragraph-separate, newline after it is hard too.
77 (when (looking-at paragraph-separate
)
78 (set-hard-newline-properties (1- pos
) pos
)
81 (set-hard-newline-properties (point) (1+ (point)))))))))))
83 (defcustom paragraph-start
"\f\\|[ \t]*$" "\
84 *Regexp for beginning of a line that starts OR separates paragraphs.
85 This regexp should match lines that separate paragraphs
86 and should also match lines that start a paragraph
87 \(and are part of that paragraph).
89 This is matched against the text at the left margin, which is not necessarily
90 the beginning of the line, so it should never use \"^\" as an anchor. This
91 ensures that the paragraph functions will work equally well within a region
92 of text indented by a margin setting.
94 The variable `paragraph-separate' specifies how to distinguish
95 lines that start paragraphs from lines that separate them.
97 If the variable `use-hard-newlines' is non-nil, then only lines following a
98 hard newline are considered to match."
102 ;; paragraph-start requires a hard newline, but paragraph-separate does not:
103 ;; It is assumed that paragraph-separate is distinctive enough to be believed
104 ;; whenever it occurs, while it is reasonable to set paragraph-start to
105 ;; something very minimal, even including "." (which makes every hard newline
106 ;; start a new paragraph).
108 (defcustom paragraph-separate
"[ \t\f]*$"
109 "*Regexp for beginning of a line that separates paragraphs.
110 If you change this, you may have to change `paragraph-start' also.
112 This is matched against the text at the left margin, which is not necessarily
113 the beginning of the line, so it should not use \"^\" as an anchor. This
114 ensures that the paragraph functions will work equally within a region of
115 text indented by a margin setting."
119 (defcustom sentence-end-double-space t
120 "*Non-nil means a single space does not end a sentence.
121 This is relevant for filling. See also `sentence-end-without-period'
122 and `colon-double-space'.
124 This value is used by the function `sentence-end' to construct the
125 regexp describing the end of a sentence, when the value of the variable
126 `sentence-end' is nil. See Info node `(elisp)Standard Regexps'."
130 (defcustom sentence-end-without-period nil
131 "*Non-nil means a sentence will end without a period.
132 For example, a sentence in Thai text ends with double space but
135 This value is used by the function `sentence-end' to construct the
136 regexp describing the end of a sentence, when the value of the variable
137 `sentence-end' is nil. See Info node `(elisp)Standard Regexps'."
141 (defcustom sentence-end-without-space
142 "\e$B!#!%!)!*\e$A!##.#?#!\e$(0!$!%!)!*\e$(G!$!%!)!*\e(B"
143 "*String of characters that end sentence without following spaces.
145 This value is used by the function `sentence-end' to construct the
146 regexp describing the end of a sentence, when the value of the variable
147 `sentence-end' is nil. See Info node `(elisp)Standard Regexps'."
151 (defcustom sentence-end nil
152 "*Regexp describing the end of a sentence.
153 The value includes the whitespace following the sentence.
154 All paragraph boundaries also end sentences, regardless.
156 The value nil means to use the default value defined by the
157 function `sentence-end'. You should always use this function
158 to obtain the value of this variable."
160 :type
'(choice regexp
(const :tag
"Use default value" nil
)))
162 (defcustom sentence-end-base
"[.?!][]\"'\e$B!I\e$,1r}\e(B)}]*"
163 "*Regexp matching the basic end of a sentence, not including following space."
168 (defun sentence-end ()
169 "Return the regexp describing the end of a sentence.
171 This function returns either the value of the variable `sentence-end'
172 if it is non-nil, or the default value constructed from the
173 variables `sentence-end-base', `sentence-end-double-space',
174 `sentence-end-without-period' and `sentence-end-without-space'.
176 The default value specifies that in order to be recognized as the
177 end of a sentence, the ending period, question mark, or exclamation point
178 must be followed by two spaces, with perhaps some closing delimiters
179 in between. See Info node `(elisp)Standard Regexps'."
181 (concat (if sentence-end-without-period
"\\w \\|")
184 (if sentence-end-double-space
185 "\\($\\| $\\|\t\\| \\)" "\\($\\|[\t ]\\)")
186 "\\|[" sentence-end-without-space
"]+"
190 (defcustom page-delimiter
"^\014"
191 "*Regexp describing line-beginnings that separate pages."
195 (defcustom paragraph-ignore-fill-prefix nil
196 "*Non-nil means the paragraph commands are not affected by `fill-prefix'.
197 This is desirable in modes where blank lines are the paragraph delimiters."
201 (defun forward-paragraph (&optional arg
)
202 "Move forward to end of paragraph.
203 With argument ARG, do it ARG times;
204 a negative argument ARG = -N means move backward N paragraphs.
206 A line which `paragraph-start' matches either separates paragraphs
207 \(if `paragraph-separate' matches it also) or is the first line of a paragraph.
208 A paragraph end is the beginning of a line which is not part of the paragraph
209 to which the end of the previous line belongs, or the end of the buffer.
210 Returns the count of paragraphs left to move."
212 (or arg
(setq arg
1))
213 (let* ((opoint (point))
215 (and fill-prefix
(not (equal fill-prefix
""))
216 (not paragraph-ignore-fill-prefix
)
217 (regexp-quote fill-prefix
)))
218 ;; Remove ^ from paragraph-start and paragraph-sep if they are there.
219 ;; These regexps shouldn't be anchored, because we look for them
220 ;; starting at the left-margin. This allows paragraph commands to
221 ;; work normally with indented text.
222 ;; This hack will not find problem cases like "whatever\\|^something".
223 (parstart (if (and (not (equal "" paragraph-start
))
224 (equal ?^
(aref paragraph-start
0)))
225 (substring paragraph-start
1)
227 (parsep (if (and (not (equal "" paragraph-separate
))
228 (equal ?^
(aref paragraph-separate
0)))
229 (substring paragraph-separate
1)
232 (if fill-prefix-regexp
234 fill-prefix-regexp
"[ \t]*$")
236 ;; This is used for searching.
237 (sp-parstart (concat "^[ \t]*\\(?:" parstart
"\\|" parsep
"\\)"))
239 (while (and (< arg
0) (not (bobp)))
240 (if (and (not (looking-at parsep
))
241 (re-search-backward "^\n" (max (1- (point)) (point-min)) t
)
245 ;; Move back over paragraph-separating lines.
246 (forward-char -
1) (beginning-of-line)
247 (while (and (not (bobp))
248 (progn (move-to-left-margin)
249 (looking-at parsep
)))
254 ;; Go to end of the previous (non-separating) line.
256 ;; Search back for line that starts or separates paragraphs.
257 (if (if fill-prefix-regexp
258 ;; There is a fill prefix; it overrides parstart.
259 (let (multiple-lines)
260 (while (and (progn (beginning-of-line) (not (bobp)))
261 (progn (move-to-left-margin)
262 (not (looking-at parsep
)))
263 (looking-at fill-prefix-regexp
))
264 (unless (= (point) start
)
265 (setq multiple-lines t
))
267 (move-to-left-margin)
268 ;; This deleted code caused a long hanging-indent line
269 ;; not to be filled together with the following lines.
270 ;; ;; Don't move back over a line before the paragraph
271 ;; ;; which doesn't start with fill-prefix
272 ;; ;; unless that is the only line we've moved over.
273 ;; (and (not (looking-at fill-prefix-regexp))
277 (while (and (re-search-backward sp-parstart nil
1)
279 ;; Found a candidate, but need to check if it is a
281 (progn (setq start
(point))
282 (move-to-left-margin)
283 (not (looking-at parsep
)))
284 (not (and (looking-at parstart
)
285 (or (not use-hard-newlines
)
288 (1- start
) 'hard
)))))
289 (setq found-start nil
)
294 ;; Move forward over paragraph separators.
295 ;; We know this cannot reach the place we started
296 ;; because we know we moved back over a non-separator.
297 (while (and (not (eobp))
298 (progn (move-to-left-margin)
299 (looking-at parsep
)))
301 ;; If line before paragraph is just margin, back up to there.
303 (if (> (current-column) (current-left-margin))
305 (skip-chars-backward " \t")
308 ;; No starter or separator line => use buffer beg.
309 (goto-char (point-min))))))
311 (while (and (> arg
0) (not (eobp)))
312 ;; Move forward over separator lines...
313 (while (and (not (eobp))
314 (progn (move-to-left-margin) (not (eobp)))
317 (unless (eobp) (setq arg
(1- arg
)))
318 ;; ... and one more line.
320 (if fill-prefix-regexp
321 ;; There is a fill prefix; it overrides parstart.
322 (while (and (not (eobp))
323 (progn (move-to-left-margin) (not (eobp)))
324 (not (looking-at parsep
))
325 (looking-at fill-prefix-regexp
))
327 (while (and (re-search-forward sp-parstart nil
1)
328 (progn (setq start
(match-beginning 0))
331 (progn (move-to-left-margin)
332 (not (looking-at parsep
)))
333 (or (not (looking-at parstart
))
334 (and use-hard-newlines
335 (not (get-text-property (1- start
) 'hard
)))))
337 (if (< (point) (point-max))
339 (constrain-to-field nil opoint t
)
340 ;; Return the number of steps that could not be done.
343 (defun backward-paragraph (&optional arg
)
344 "Move backward to start of paragraph.
345 With argument ARG, do it ARG times;
346 a negative argument ARG = -N means move forward N paragraphs.
348 A paragraph start is the beginning of a line which is a
349 `first-line-of-paragraph' or which is ordinary text and follows a
350 paragraph-separating line; except: if the first real line of a
351 paragraph is preceded by a blank line, the paragraph starts at that
354 See `forward-paragraph' for more information."
356 (or arg
(setq arg
1))
357 (forward-paragraph (- arg
)))
359 (defun mark-paragraph (&optional arg allow-extend
)
360 "Put point at beginning of this paragraph, mark at end.
361 The paragraph marked is the one that contains point or follows point.
363 With argument ARG, puts mark at end of a following paragraph, so that
364 the number of paragraphs marked equals ARG.
366 If ARG is negative, point is put at end of this paragraph, mark is put
367 at beginning of this or a previous paragraph.
369 Interactively, if this command is repeated
370 or (in Transient Mark mode) if the mark is active,
371 it marks the next ARG paragraphs after the ones already marked."
373 (unless arg
(setq arg
1))
375 (error "Cannot mark zero paragraphs"))
376 (cond ((and allow-extend
377 (or (and (eq last-command this-command
) (mark t
))
378 (and transient-mark-mode mark-active
)))
382 (forward-paragraph arg
)
385 (forward-paragraph arg
)
387 (backward-paragraph arg
))))
389 (defun kill-paragraph (arg)
390 "Kill forward to end of paragraph.
391 With arg N, kill forward to Nth end of paragraph;
392 negative arg -N means kill backward to Nth start of paragraph."
394 (kill-region (point) (progn (forward-paragraph arg
) (point))))
396 (defun backward-kill-paragraph (arg)
397 "Kill back to start of paragraph.
398 With arg N, kill back to Nth start of paragraph;
399 negative arg -N means kill forward to Nth end of paragraph."
401 (kill-region (point) (progn (backward-paragraph arg
) (point))))
403 (defun transpose-paragraphs (arg)
404 "Interchange this (or next) paragraph with previous one."
406 (transpose-subr 'forward-paragraph arg
))
408 (defun start-of-paragraph-text ()
409 (let ((opoint (point)) npoint
)
410 (forward-paragraph -
1)
411 (setq npoint
(point))
412 (skip-chars-forward " \t\n")
413 ;; If the range of blank lines found spans the original start point,
414 ;; try again from the beginning of it.
415 ;; Must be careful to avoid infinite loop
416 ;; when following a single return at start of buffer.
417 (if (and (>= (point) opoint
) (< npoint opoint
))
420 (if (> npoint
(point-min))
421 (start-of-paragraph-text))))))
423 (defun end-of-paragraph-text ()
424 (let ((opoint (point)))
425 (forward-paragraph 1)
426 (if (eq (preceding-char) ?
\n) (forward-char -
1))
427 (if (<= (point) opoint
)
430 (if (< (point) (point-max))
431 (end-of-paragraph-text))))))
433 (defun forward-sentence (&optional arg
)
434 "Move forward to next `sentence-end'. With argument, repeat.
435 With negative argument, move backward repeatedly to `sentence-beginning'.
437 The variable `sentence-end' is a regular expression that matches ends of
438 sentences. Also, every paragraph boundary terminates sentences as well."
440 (or arg
(setq arg
1))
441 (let ((opoint (point))
442 (sentence-end (sentence-end)))
445 (par-beg (save-excursion (start-of-paragraph-text) (point))))
446 (if (and (re-search-backward sentence-end par-beg t
)
447 (or (< (match-end 0) pos
)
448 (re-search-backward sentence-end par-beg t
)))
449 (goto-char (match-end 0))
450 (goto-char par-beg
)))
453 (let ((par-end (save-excursion (end-of-paragraph-text) (point))))
454 (if (re-search-forward sentence-end par-end t
)
455 (skip-chars-backward " \t\n")
456 (goto-char par-end
)))
458 (constrain-to-field nil opoint t
)))
460 (defun repunctuate-sentences ()
461 "Put two spaces at the end of sentences from point to the end of buffer.
462 It works using `query-replace-regexp'."
464 (query-replace-regexp "\\([]\"')]?\\)\\([.?!]\\)\\([]\"')]?\\) +"
468 (defun backward-sentence (&optional arg
)
469 "Move backward to start of sentence. With arg, do it arg times.
470 See `forward-sentence' for more information."
472 (or arg
(setq arg
1))
473 (forward-sentence (- arg
)))
475 (defun kill-sentence (&optional arg
)
476 "Kill from point to end of sentence.
477 With arg, repeat; negative arg -N means kill back to Nth start of sentence."
479 (kill-region (point) (progn (forward-sentence arg
) (point))))
481 (defun backward-kill-sentence (&optional arg
)
482 "Kill back from point to start of sentence.
483 With arg, repeat, or kill forward to Nth end of sentence if negative arg -N."
485 (kill-region (point) (progn (backward-sentence arg
) (point))))
487 (defun mark-end-of-sentence (arg)
488 "Put mark at end of sentence. Arg works as in `forward-sentence'.
489 If this command is repeated, it marks the next ARG sentences after the
490 ones already marked."
494 (if (and (eq last-command this-command
) (mark t
))
496 (forward-sentence arg
)
500 (defun transpose-sentences (arg)
501 "Interchange this (next) and previous sentence."
503 (transpose-subr 'forward-sentence arg
))
506 ;; coding: iso-2022-7bit
509 ;; arch-tag: e727eb1a-527a-4464-b9d7-9d3ec0d1a575
510 ;;; paragraphs.el ends here