Commit | Line | Data |
---|---|---|
aaaf7be7 DL |
1 | ;;; refill.el --- `auto-fill' by refilling paragraphs on changes |
2 | ||
73b0cd50 | 3 | ;; Copyright (C) 2000-2011 Free Software Foundation, Inc. |
aaaf7be7 DL |
4 | |
5 | ;; Author: Dave Love <fx@gnu.org> | |
a2515a78 | 6 | ;; Maintainer: Miles Bader <miles@gnu.org> |
aaaf7be7 DL |
7 | ;; Keywords: wp |
8 | ||
2be7dabc GM |
9 | ;; This file is part of GNU Emacs. |
10 | ||
1fecc8fe | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
aaaf7be7 | 12 | ;; it under the terms of the GNU General Public License as published by |
1fecc8fe GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
2be7dabc GM |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
aaaf7be7 DL |
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. | |
2be7dabc | 20 | |
aaaf7be7 | 21 | ;; You should have received a copy of the GNU General Public License |
1fecc8fe | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
aaaf7be7 DL |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;; Provides a mode where paragraphs are refilled after changes in them | |
7850e188 | 27 | ;; (using `after-change-functions'). This gives something akin to typical |
aaaf7be7 DL |
28 | ;; word processor-style filling. We restrict refilling due to |
29 | ;; self-insertion to the characters which trigger auto-fill. | |
30 | ||
31 | ;; It partly satisfies a todo item in enriched.el for some value of | |
32 | ;; `without slowing down editing too much'. It doesn't attempt to do | |
33 | ;; anything (using `window-size-change-functions'?) about resizing | |
34 | ;; windows -- who cares? | |
35 | ||
36 | ;; This implementation is probably fragile and missing some special | |
37 | ;; cases -- not extensively tested. Yanking paragraph breaks, for | |
38 | ;; instance, won't DTRT by refilling all the relevant paragraphs. | |
39 | ||
40 | ;; You could do it a bit more efficiently (and robustly?) with just an | |
41 | ;; auto-fill function, but that doesn't cope with changes other than | |
42 | ;; through self-insertion. (Using auto-fill and after-change | |
43 | ;; functions together didn't seem winning.) This could probably | |
44 | ;; benefit from a less-general and faster `fill-paragraph-function', | |
45 | ;; ideally as a primitive. | |
46 | ||
47 | ;; The work is done in a local post-command hook but only if | |
48 | ;; `refill-doit' has been set by the after-change function. Using | |
7850e188 | 49 | ;; `post-command-hook' ensures simply that refilling only happens |
aaaf7be7 DL |
50 | ;; once per command. |
51 | ||
52 | ;; [Per Abrahamsen's maniac.el does a similar thing, but operates from | |
53 | ;; post-command-hook. I don't understand the statement in it that | |
7850e188 | 54 | ;; after-change-functions don't work for this purpose; perhaps there was |
aaaf7be7 DL |
55 | ;; some Emacs bug at the time. ISTR maniac has problems with |
56 | ;; whitespace at the end of paragraphs.] | |
57 | ||
d1a27f1d SM |
58 | ;;; Todo/Bugs: |
59 | ||
60 | ;; - When deleting the first word on a line, the space after that word tends | |
61 | ;; to become part of the fill-prefix, causing either wrong filling of the | |
62 | ;; remaining text, or causing the cursor to move unexpectedly. Ex: | |
63 | ;; Start with | |
64 | ;; I>< blabla | |
65 | ;; | |
66 | ;; and hit backspace. We end up with | |
67 | ;; | |
68 | ;; ><blabla | |
69 | ;; instead of | |
70 | ;; >< blabla | |
71 | ;; | |
72 | ;; Other example. Start with | |
73 | ;; | |
74 | ;; Foo bar blablabla asdgf | |
75 | ;; word>< asdfas dfasdfasd | |
76 | ;; asd asdfa sdfasd sdf | |
77 | ;; | |
78 | ;; and hit M-backspace. We end up with | |
79 | ;; | |
80 | ;; Foo bar blablabla asdgf | |
81 | ;; ><asdfas dfasdfasd asd | |
82 | ;; asdfa sdfasd sdf | |
83 | ||
aaaf7be7 DL |
84 | ;;; Code: |
85 | ||
04138be8 SM |
86 | (eval-when-compile (require 'cl)) |
87 | ||
e4caa91a MR |
88 | (defgroup refill nil |
89 | "Refilling paragraphs on changes." | |
90 | :group 'fill) | |
91 | ||
867092e9 MB |
92 | (defvar refill-ignorable-overlay nil |
93 | "Portion of the most recently filled paragraph not needing filling. | |
94 | This is used to optimize refilling.") | |
95 | (make-variable-buffer-local 'refill-ignorable-overlay) | |
96 | ||
97 | (defun refill-adjust-ignorable-overlay (overlay afterp beg end &optional len) | |
98 | "Adjust OVERLAY to not include the about-to-be-modified region." | |
99 | (when (not afterp) | |
867092e9 MB |
100 | (save-excursion |
101 | (goto-char beg) | |
102 | (forward-line -1) | |
103 | (if (<= (point) (overlay-start overlay)) | |
104 | ;; Just get OVERLAY out of the way | |
ad2feb08 | 105 | (move-overlay overlay (point-min) (point-min)) |
db95369b | 106 | ;; Make overlay contain only the region |
867092e9 MB |
107 | (move-overlay overlay (overlay-start overlay) (point)))))) |
108 | ||
109 | (defun refill-fill-paragraph-at (pos &optional arg) | |
110 | "Like `fill-paragraph' at POS, but don't delete whitespace at paragraph end." | |
ad2feb08 SM |
111 | (save-excursion |
112 | (goto-char pos) | |
113 | ;; FIXME: forward-paragraph seems to disregard `use-hard-newlines', | |
114 | ;; leading to excessive refilling and wrong choice of fill-prefix. | |
115 | ;; might be a bug in my paragraphs.el. | |
116 | (forward-paragraph) | |
117 | (skip-syntax-backward "-") | |
118 | (let ((end (point)) | |
119 | (beg (progn (backward-paragraph) (point))) | |
120 | (obeg (overlay-start refill-ignorable-overlay)) | |
121 | (oend (overlay-end refill-ignorable-overlay))) | |
122 | (unless (> beg pos) ;Don't fill if point is outside the paragraph. | |
123 | (goto-char pos) | |
124 | (if (and (>= beg obeg) (< beg oend)) | |
125 | ;; Limit filling to the modified tail of the paragraph. | |
126 | (let ( ;; When adaptive-fill-mode is enabled, the filling | |
127 | ;; functions will attempt to set the fill prefix from | |
128 | ;; the fake paragraph bounds we pass in, so set it | |
129 | ;; ourselves first, using the real paragraph bounds. | |
130 | (fill-prefix | |
131 | (if (and adaptive-fill-mode | |
132 | (or (null fill-prefix) (string= fill-prefix ""))) | |
133 | (fill-context-prefix beg end) | |
134 | fill-prefix)) | |
135 | ;; Turn off adaptive-fill-mode temporarily | |
136 | (adaptive-fill-mode nil)) | |
137 | (save-restriction | |
138 | (if use-hard-newlines | |
139 | (fill-region oend end arg) | |
140 | (fill-region-as-paragraph oend end arg))) | |
141 | (move-overlay refill-ignorable-overlay obeg (point))) | |
142 | ;; Fill the whole paragraph | |
143 | (save-restriction | |
144 | (if use-hard-newlines | |
145 | (fill-region beg end arg) | |
146 | (fill-region-as-paragraph beg end arg))) | |
147 | (move-overlay refill-ignorable-overlay beg (point))))))) | |
867092e9 MB |
148 | |
149 | (defun refill-fill-paragraph (arg) | |
150 | "Like `fill-paragraph' but don't delete whitespace at paragraph end." | |
151 | (refill-fill-paragraph-at (point) arg)) | |
aaaf7be7 DL |
152 | |
153 | (defvar refill-doit nil | |
8b4703c4 | 154 | "Non-nil tells `refill-post-command-function' to do its processing. |
7850e188 | 155 | Set by `refill-after-change-function' in `after-change-functions' and |
867092e9 MB |
156 | unset by `refill-post-command-function' in `post-command-hook', and |
157 | sometimes `refill-pre-command-function' in `pre-command-hook'. This | |
aaaf7be7 DL |
158 | ensures refilling is only done once per command that causes a change, |
159 | regardless of the number of after-change calls from commands doing | |
160 | complex processing.") | |
161 | (make-variable-buffer-local 'refill-doit) | |
162 | ||
163 | (defun refill-after-change-function (beg end len) | |
164 | "Function for `after-change-functions' which just sets `refill-doit'." | |
165 | (unless undo-in-progress | |
867092e9 | 166 | (setq refill-doit end))) |
aaaf7be7 DL |
167 | |
168 | (defun refill-post-command-function () | |
169 | "Post-command function to do refilling (conditionally)." | |
867092e9 | 170 | (when refill-doit ; there was a change |
aaaf7be7 | 171 | ;; There's probably scope for more special cases here... |
04138be8 SM |
172 | (case this-command |
173 | (self-insert-command | |
174 | ;; Treat self-insertion commands specially, since they don't | |
175 | ;; always reset `refill-doit' -- for self-insertion commands that | |
176 | ;; *don't* cause a refill, we want to leave it turned on so that | |
177 | ;; any subsequent non-modification command will cause a refill. | |
178 | (when (aref auto-fill-chars (char-before)) | |
179 | ;; Respond to the same characters as auto-fill (other than | |
180 | ;; newline, covered below). | |
181 | (refill-fill-paragraph-at refill-doit) | |
182 | (setq refill-doit nil))) | |
183 | ((quoted-insert fill-paragraph fill-region) nil) | |
184 | ((newline newline-and-indent open-line indent-new-comment-line | |
185 | reindent-then-newline-and-indent) | |
186 | ;; Don't zap what was just inserted. | |
187 | (save-excursion | |
188 | (beginning-of-line) ; for newline-and-indent | |
189 | (skip-chars-backward "\n") | |
190 | (save-restriction | |
191 | (narrow-to-region (point-min) (point)) | |
192 | (refill-fill-paragraph-at refill-doit))) | |
193 | (widen) | |
194 | (save-excursion | |
195 | (skip-chars-forward "\n") | |
196 | (save-restriction | |
197 | (narrow-to-region (line-beginning-position) (point-max)) | |
198 | (refill-fill-paragraph-at refill-doit)))) | |
199 | (t | |
200 | (refill-fill-paragraph-at refill-doit))) | |
201 | (setq refill-doit nil))) | |
867092e9 MB |
202 | |
203 | (defun refill-pre-command-function () | |
204 | "Pre-command function to do refilling (conditionally)." | |
205 | (when (and refill-doit (not (eq this-command 'self-insert-command))) | |
206 | ;; A previous setting of `refill-doit' didn't result in a refill, | |
207 | ;; because it was a self-insert-command. Since the next command is | |
208 | ;; something else, do the refill now. | |
209 | (refill-fill-paragraph-at refill-doit) | |
aaaf7be7 DL |
210 | (setq refill-doit nil))) |
211 | ||
04138be8 | 212 | (defvar refill-saved-state nil) |
10ee3d79 | 213 | |
aaaf7be7 DL |
214 | ;;;###autoload |
215 | (define-minor-mode refill-mode | |
216 | "Toggle Refill minor mode. | |
3ecd3a56 | 217 | With prefix arg, turn Refill mode on if arg is positive, otherwise turn it off. |
aaaf7be7 DL |
218 | |
219 | When Refill mode is on, the current paragraph will be formatted when | |
220 | changes are made within it. Self-inserting characters only cause | |
221 | refilling if they would cause auto-filling." | |
6de274aa LK |
222 | :group 'refill |
223 | :lighter " Refill" | |
224 | :keymap '(("\177" . backward-delete-char-untabify)) | |
f5bd4bf2 MB |
225 | ;; Remove old state if necessary |
226 | (when refill-ignorable-overlay | |
227 | (delete-overlay refill-ignorable-overlay) | |
228 | (kill-local-variable 'refill-ignorable-overlay)) | |
04138be8 SM |
229 | (when (local-variable-p 'refill-saved-state) |
230 | (dolist (x refill-saved-state) | |
231 | (set (make-local-variable (car x)) (cdr x))) | |
232 | (kill-local-variable 'refill-saved-state)) | |
aaaf7be7 | 233 | (if refill-mode |
7850e188 SM |
234 | (progn |
235 | (add-hook 'after-change-functions 'refill-after-change-function nil t) | |
236 | (add-hook 'post-command-hook 'refill-post-command-function nil t) | |
867092e9 | 237 | (add-hook 'pre-command-hook 'refill-pre-command-function nil t) |
04138be8 SM |
238 | (set (make-local-variable 'refill-saved-state) |
239 | (mapcar (lambda (s) (cons s (symbol-value s))) | |
240 | '(fill-paragraph-function auto-fill-function))) | |
f5bd4bf2 | 241 | ;; This provides the test for recursive paragraph filling. |
7850e188 SM |
242 | (set (make-local-variable 'fill-paragraph-function) |
243 | 'refill-fill-paragraph) | |
d1a27f1d SM |
244 | ;; When using justification, doing DEL on 2 spaces should remove |
245 | ;; both, otherwise, the subsequent refill will undo the DEL. | |
246 | (set (make-local-variable 'backward-delete-char-untabify-method) | |
247 | 'hungry) | |
867092e9 MB |
248 | (setq refill-ignorable-overlay (make-overlay 1 1 nil nil t)) |
249 | (overlay-put refill-ignorable-overlay 'modification-hooks | |
250 | '(refill-adjust-ignorable-overlay)) | |
251 | (overlay-put refill-ignorable-overlay 'insert-behind-hooks | |
252 | '(refill-adjust-ignorable-overlay)) | |
7850e188 | 253 | (auto-fill-mode 0)) |
aaaf7be7 DL |
254 | (remove-hook 'after-change-functions 'refill-after-change-function t) |
255 | (remove-hook 'post-command-hook 'refill-post-command-function t) | |
d1a27f1d | 256 | (kill-local-variable 'backward-delete-char-untabify-method))) |
aaaf7be7 DL |
257 | |
258 | (provide 'refill) | |
259 | ||
260 | ;;; refill.el ends here |