annotate lisp/textmodes/refill.el @ 41152:6b20981865e5

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