2000-10-22 16:28:19 +00:00
|
|
|
;;; refill.el --- `auto-fill' by refilling paragraphs on changes
|
|
|
|
|
|
|
|
;; Copyright (C) 2000 Free Software Foundation, Inc.
|
|
|
|
|
|
|
|
;; Author: Dave Love <fx@gnu.org>
|
|
|
|
;; Keywords: wp
|
|
|
|
|
2001-07-13 12:59:13 +00:00
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
|
;; GNU Emacs is free software; you can redistribute it and/or modify
|
2000-10-22 16:28:19 +00:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2001-07-13 12:59:13 +00:00
|
|
|
;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
|
;; any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2000-10-22 16:28:19 +00:00
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
2001-07-13 12:59:13 +00:00
|
|
|
|
2000-10-22 16:28:19 +00:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2001-07-13 12:59:13 +00:00
|
|
|
;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
|
|
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
2000-10-22 16:28:19 +00:00
|
|
|
;; Boston, MA 02111-1307, USA.
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Provides a mode where paragraphs are refilled after changes in them
|
2000-10-23 07:35:30 +00:00
|
|
|
;; (using `after-change-functions'). This gives something akin to typical
|
2000-10-22 16:28:19 +00:00
|
|
|
;; word processor-style filling. We restrict refilling due to
|
|
|
|
;; self-insertion to the characters which trigger auto-fill.
|
|
|
|
|
|
|
|
;; It partly satisfies a todo item in enriched.el for some value of
|
|
|
|
;; `without slowing down editing too much'. It doesn't attempt to do
|
|
|
|
;; anything (using `window-size-change-functions'?) about resizing
|
|
|
|
;; windows -- who cares?
|
|
|
|
|
|
|
|
;; This implementation is probably fragile and missing some special
|
|
|
|
;; cases -- not extensively tested. Yanking paragraph breaks, for
|
|
|
|
;; instance, won't DTRT by refilling all the relevant paragraphs.
|
|
|
|
|
|
|
|
;; You could do it a bit more efficiently (and robustly?) with just an
|
|
|
|
;; auto-fill function, but that doesn't cope with changes other than
|
|
|
|
;; through self-insertion. (Using auto-fill and after-change
|
|
|
|
;; functions together didn't seem winning.) This could probably
|
|
|
|
;; benefit from a less-general and faster `fill-paragraph-function',
|
|
|
|
;; ideally as a primitive.
|
|
|
|
|
|
|
|
;; The work is done in a local post-command hook but only if
|
|
|
|
;; `refill-doit' has been set by the after-change function. Using
|
2000-10-23 07:35:30 +00:00
|
|
|
;; `post-command-hook' ensures simply that refilling only happens
|
2000-10-22 16:28:19 +00:00
|
|
|
;; once per command.
|
|
|
|
|
|
|
|
;; [Per Abrahamsen's maniac.el does a similar thing, but operates from
|
|
|
|
;; post-command-hook. I don't understand the statement in it that
|
2000-10-23 07:35:30 +00:00
|
|
|
;; after-change-functions don't work for this purpose; perhaps there was
|
2000-10-22 16:28:19 +00:00
|
|
|
;; some Emacs bug at the time. ISTR maniac has problems with
|
|
|
|
;; whitespace at the end of paragraphs.]
|
|
|
|
|
2001-10-13 19:16:56 +00:00
|
|
|
;;; Todo/Bugs:
|
|
|
|
|
|
|
|
;; - When deleting the first word on a line, the space after that word tends
|
|
|
|
;; to become part of the fill-prefix, causing either wrong filling of the
|
|
|
|
;; remaining text, or causing the cursor to move unexpectedly. Ex:
|
|
|
|
;; Start with
|
|
|
|
;; I>< blabla
|
|
|
|
;;
|
|
|
|
;; and hit backspace. We end up with
|
|
|
|
;;
|
|
|
|
;; ><blabla
|
|
|
|
;; instead of
|
|
|
|
;; >< blabla
|
|
|
|
;;
|
|
|
|
;; Other example. Start with
|
|
|
|
;;
|
|
|
|
;; Foo bar blablabla asdgf
|
|
|
|
;; word>< asdfas dfasdfasd
|
|
|
|
;; asd asdfa sdfasd sdf
|
|
|
|
;;
|
|
|
|
;; and hit M-backspace. We end up with
|
|
|
|
;;
|
|
|
|
;; Foo bar blablabla asdgf
|
|
|
|
;; ><asdfas dfasdfasd asd
|
|
|
|
;; asdfa sdfasd sdf
|
|
|
|
|
2000-10-22 16:28:19 +00:00
|
|
|
;;; Code:
|
|
|
|
|
2000-11-21 01:11:49 +00:00
|
|
|
(defvar refill-ignorable-overlay nil
|
|
|
|
"Portion of the most recently filled paragraph not needing filling.
|
|
|
|
This is used to optimize refilling.")
|
|
|
|
(make-variable-buffer-local 'refill-ignorable-overlay)
|
|
|
|
|
|
|
|
(defun refill-adjust-ignorable-overlay (overlay afterp beg end &optional len)
|
|
|
|
"Adjust OVERLAY to not include the about-to-be-modified region."
|
|
|
|
(when (not afterp)
|
|
|
|
(save-excursion
|
|
|
|
(goto-char beg)
|
|
|
|
(forward-line -1)
|
|
|
|
(if (<= (point) (overlay-start overlay))
|
|
|
|
;; Just get OVERLAY out of the way
|
|
|
|
(move-overlay overlay 1 1)
|
|
|
|
;; Make overlay contain only the region
|
|
|
|
(move-overlay overlay (overlay-start overlay) (point))))))
|
|
|
|
|
|
|
|
(defun refill-fill-paragraph-at (pos &optional arg)
|
|
|
|
"Like `fill-paragraph' at POS, but don't delete whitespace at paragraph end."
|
|
|
|
(let (fill-pfx)
|
2000-10-22 16:28:19 +00:00
|
|
|
(save-excursion
|
2000-11-21 01:11:49 +00:00
|
|
|
(goto-char pos)
|
2001-10-13 19:16:56 +00:00
|
|
|
;; FIXME: forward-paragraph seems to disregard `use-hard-newlines',
|
|
|
|
;; leading to excessive refilling and wrong choice of fill-prefix.
|
|
|
|
;; might be a bug in my paragraphs.el.
|
2000-10-22 16:28:19 +00:00
|
|
|
(forward-paragraph)
|
|
|
|
(skip-syntax-backward "-")
|
|
|
|
(let ((end (point))
|
2000-11-21 01:11:49 +00:00
|
|
|
(beg (progn (backward-paragraph) (point)))
|
|
|
|
(obeg (overlay-start refill-ignorable-overlay))
|
|
|
|
(oend (overlay-end refill-ignorable-overlay)))
|
|
|
|
(goto-char pos)
|
|
|
|
(if (and (>= beg obeg) (< beg oend))
|
|
|
|
;; Limit filling to the modified tail of the paragraph.
|
|
|
|
(let (;; When adaptive-fill-mode is enabled, the filling
|
|
|
|
;; functions will attempt to set the fill prefix from
|
|
|
|
;; the fake paragraph bounds we pass in, so set it
|
|
|
|
;; ourselves first, using the real paragraph bounds.
|
|
|
|
(fill-prefix
|
|
|
|
(if (and adaptive-fill-mode
|
|
|
|
(or (null fill-prefix) (string= fill-prefix "")))
|
|
|
|
(fill-context-prefix beg end)
|
|
|
|
fill-prefix))
|
|
|
|
;; Turn off adaptive-fill-mode temporarily
|
|
|
|
(adaptive-fill-mode nil))
|
|
|
|
(save-restriction
|
|
|
|
(if use-hard-newlines
|
|
|
|
(fill-region oend end arg)
|
|
|
|
(fill-region-as-paragraph oend end arg)))
|
|
|
|
(setq fill-pfx fill-prefix)
|
|
|
|
(move-overlay refill-ignorable-overlay obeg (point)))
|
|
|
|
;; Fill the whole paragraph
|
|
|
|
(setq fill-pfx
|
|
|
|
(save-restriction
|
|
|
|
(if use-hard-newlines
|
|
|
|
(fill-region beg end arg)
|
|
|
|
(fill-region-as-paragraph beg end arg))))
|
|
|
|
(move-overlay refill-ignorable-overlay beg (point)))))
|
|
|
|
(skip-line-prefix fill-pfx)))
|
|
|
|
|
|
|
|
(defun refill-fill-paragraph (arg)
|
|
|
|
"Like `fill-paragraph' but don't delete whitespace at paragraph end."
|
|
|
|
(refill-fill-paragraph-at (point) arg))
|
2000-10-22 16:28:19 +00:00
|
|
|
|
|
|
|
(defvar refill-doit nil
|
|
|
|
"Non-nil means that `refill-post-command-function' does its processing.
|
2000-10-23 07:35:30 +00:00
|
|
|
Set by `refill-after-change-function' in `after-change-functions' and
|
2000-11-21 01:11:49 +00:00
|
|
|
unset by `refill-post-command-function' in `post-command-hook', and
|
|
|
|
sometimes `refill-pre-command-function' in `pre-command-hook'. This
|
2000-10-22 16:28:19 +00:00
|
|
|
ensures refilling is only done once per command that causes a change,
|
|
|
|
regardless of the number of after-change calls from commands doing
|
|
|
|
complex processing.")
|
|
|
|
(make-variable-buffer-local 'refill-doit)
|
|
|
|
|
|
|
|
(defun refill-after-change-function (beg end len)
|
|
|
|
"Function for `after-change-functions' which just sets `refill-doit'."
|
|
|
|
(unless undo-in-progress
|
2000-11-21 01:11:49 +00:00
|
|
|
(setq refill-doit end)))
|
2000-10-22 16:28:19 +00:00
|
|
|
|
|
|
|
(defun refill-post-command-function ()
|
|
|
|
"Post-command function to do refilling (conditionally)."
|
2000-11-21 01:11:49 +00:00
|
|
|
(when refill-doit ; there was a change
|
2000-10-22 16:28:19 +00:00
|
|
|
;; There's probably scope for more special cases here...
|
2000-11-21 01:11:49 +00:00
|
|
|
(if (eq this-command 'self-insert-command)
|
|
|
|
;; Treat self-insertion commands specially, since they don't
|
|
|
|
;; always reset `refill-doit' -- for self-insertion commands that
|
|
|
|
;; *don't* cause a refill, we want to leave it turned on so that
|
|
|
|
;; any subsequent non-modification command will cause a refill.
|
|
|
|
(when (aref auto-fill-chars (char-before))
|
|
|
|
;; Respond to the same characters as auto-fill (other than
|
|
|
|
;; newline, covered below).
|
|
|
|
(refill-fill-paragraph-at refill-doit)
|
|
|
|
(setq refill-doit nil))
|
|
|
|
(cond
|
|
|
|
((or (eq this-command 'quoted-insert)
|
|
|
|
(eq this-command 'fill-paragraph)
|
|
|
|
(eq this-command 'fill-region))
|
|
|
|
nil)
|
|
|
|
((or (eq this-command 'newline)
|
|
|
|
(eq this-command 'newline-and-indent)
|
|
|
|
(eq this-command 'open-line))
|
|
|
|
;; Don't zap what was just inserted.
|
|
|
|
(save-excursion
|
|
|
|
(beginning-of-line) ; for newline-and-indent
|
|
|
|
(skip-chars-backward "\n")
|
|
|
|
(save-restriction
|
|
|
|
(narrow-to-region (point-min) (point))
|
|
|
|
(refill-fill-paragraph-at refill-doit)))
|
|
|
|
(widen)
|
|
|
|
(save-excursion
|
|
|
|
(skip-chars-forward "\n")
|
|
|
|
(save-restriction
|
|
|
|
(narrow-to-region (line-beginning-position) (point-max))
|
|
|
|
(refill-fill-paragraph-at refill-doit))))
|
|
|
|
(t
|
|
|
|
(refill-fill-paragraph-at refill-doit)))
|
|
|
|
(setq refill-doit nil))))
|
|
|
|
|
|
|
|
(defun refill-pre-command-function ()
|
|
|
|
"Pre-command function to do refilling (conditionally)."
|
|
|
|
(when (and refill-doit (not (eq this-command 'self-insert-command)))
|
|
|
|
;; A previous setting of `refill-doit' didn't result in a refill,
|
|
|
|
;; because it was a self-insert-command. Since the next command is
|
|
|
|
;; something else, do the refill now.
|
|
|
|
(refill-fill-paragraph-at refill-doit)
|
2000-10-22 16:28:19 +00:00
|
|
|
(setq refill-doit nil)))
|
|
|
|
|
2000-10-27 15:50:24 +00:00
|
|
|
(defvar refill-late-fill-paragraph-function nil)
|
|
|
|
|
2000-10-22 16:28:19 +00:00
|
|
|
;;;###autoload
|
|
|
|
(define-minor-mode refill-mode
|
|
|
|
"Toggle Refill minor mode.
|
|
|
|
With prefix arg, turn Refill mode on iff arg is positive.
|
|
|
|
|
|
|
|
When Refill mode is on, the current paragraph will be formatted when
|
|
|
|
changes are made within it. Self-inserting characters only cause
|
|
|
|
refilling if they would cause auto-filling."
|
2001-10-13 19:16:56 +00:00
|
|
|
nil " Refill" '(("\177" . backward-delete-char-untabify))
|
2000-10-22 16:28:19 +00:00
|
|
|
;; This provides the test for recursive paragraph filling.
|
|
|
|
(make-local-variable 'fill-paragraph-function)
|
|
|
|
(if refill-mode
|
2000-10-23 07:35:30 +00:00
|
|
|
(progn
|
|
|
|
(add-hook 'after-change-functions 'refill-after-change-function nil t)
|
|
|
|
(add-hook 'post-command-hook 'refill-post-command-function nil t)
|
2000-11-21 01:11:49 +00:00
|
|
|
(add-hook 'pre-command-hook 'refill-pre-command-function nil t)
|
2000-10-27 15:50:24 +00:00
|
|
|
(set (make-local-variable 'refill-late-fill-paragraph-function)
|
|
|
|
fill-paragraph-function)
|
2000-10-23 07:35:30 +00:00
|
|
|
(set (make-local-variable 'fill-paragraph-function)
|
|
|
|
'refill-fill-paragraph)
|
2001-10-13 19:16:56 +00:00
|
|
|
;; When using justification, doing DEL on 2 spaces should remove
|
|
|
|
;; both, otherwise, the subsequent refill will undo the DEL.
|
|
|
|
(set (make-local-variable 'backward-delete-char-untabify-method)
|
|
|
|
'hungry)
|
2000-11-21 01:11:49 +00:00
|
|
|
(setq refill-ignorable-overlay (make-overlay 1 1 nil nil t))
|
|
|
|
(overlay-put refill-ignorable-overlay 'modification-hooks
|
|
|
|
'(refill-adjust-ignorable-overlay))
|
|
|
|
(overlay-put refill-ignorable-overlay 'insert-behind-hooks
|
|
|
|
'(refill-adjust-ignorable-overlay))
|
2000-10-23 07:35:30 +00:00
|
|
|
(auto-fill-mode 0))
|
2000-10-22 16:28:19 +00:00
|
|
|
(remove-hook 'after-change-functions 'refill-after-change-function t)
|
|
|
|
(remove-hook 'post-command-hook 'refill-post-command-function t)
|
2000-11-21 01:11:49 +00:00
|
|
|
(delete-overlay refill-ignorable-overlay)
|
2001-10-13 19:16:56 +00:00
|
|
|
(setq fill-paragraph-function refill-late-fill-paragraph-function)
|
|
|
|
(kill-local-variable 'backward-delete-char-untabify-method)))
|
2000-10-22 16:28:19 +00:00
|
|
|
|
|
|
|
(provide 'refill)
|
|
|
|
|
|
|
|
;;; refill.el ends here
|