;;; longlines.el --- automatically wrap long lines
-;; Copyright (C) 2000, 2001, 2005 Free Software Foundation, Inc.
+;; Copyright (C) 2000, 2001, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Authors: Kai Grossjohann <Kai.Grossjohann@CS.Uni-Dortmund.DE>
;; Alex Schroeder <alex@gnu.org>
;; Chong Yidong <cyd@stupidchicken.com>
;; Maintainer: Chong Yidong <cyd@stupidchicken.com>
-;; Keywords: convenience
+;; Keywords: convenience, wp
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
:group 'fill)
(defcustom longlines-auto-wrap t
- "*Non-nil means long lines are automatically wrapped after each command.
+ "Non-nil means long lines are automatically wrapped after each command.
Otherwise, you can perform filling using `fill-paragraph' or
`auto-fill-mode'. In any case, the soft newlines will be removed
when the file is saved to disk."
:type 'boolean)
(defcustom longlines-wrap-follows-window-size nil
- "*Non-nil means wrapping and filling happen at the edge of the window.
+ "Non-nil means wrapping and filling happen at the edge of the window.
Otherwise, `fill-column' is used, regardless of the window size. This
does not work well when the buffer is displayed in multiple windows
-with differing widths."
+with differing widths.
+
+If the value is an integer, that specifies the distance from the
+right edge of the window at which wrapping occurs. For any other
+non-nil value, wrapping occurs 2 characters from the right edge."
:group 'longlines
:type 'boolean)
(defcustom longlines-show-hard-newlines nil
- "*Non-nil means each hard newline is marked on the screen.
+ "Non-nil means each hard newline is marked on the screen.
\(The variable `longlines-show-effect' controls what they look like.)
You can also enable the display temporarily, using the command
-`longlines-show-hard-newlines'"
+`longlines-show-hard-newlines'."
:group 'longlines
:type 'boolean)
(defcustom longlines-show-effect (propertize "|\n" 'face 'escape-glyph)
- "*A string to display when showing hard newlines.
+ "A string to display when showing hard newlines.
This is used when `longlines-show-hard-newlines' is on."
:group 'longlines
:type 'string)
(defvar longlines-wrap-end nil)
(defvar longlines-wrap-point nil)
(defvar longlines-showing nil)
+(defvar longlines-decoded nil)
(make-variable-buffer-local 'longlines-wrap-beg)
(make-variable-buffer-local 'longlines-wrap-end)
(make-variable-buffer-local 'longlines-wrap-point)
(make-variable-buffer-local 'longlines-showing)
+(make-variable-buffer-local 'longlines-decoded)
;; Mode
+(defvar message-indent-citation-function)
+
;;;###autoload
(define-minor-mode longlines-mode
"Toggle Long Lines mode.
(set (make-local-variable 'require-final-newline) nil)
(add-to-list 'buffer-file-format 'longlines)
(add-hook 'change-major-mode-hook 'longlines-mode-off nil t)
+ (add-hook 'before-revert-hook 'longlines-before-revert-hook nil t)
(make-local-variable 'buffer-substring-filters)
+ (make-local-variable 'longlines-auto-wrap)
(set (make-local-variable 'isearch-search-fun-function)
- 'longlinges-search-function)
+ 'longlines-search-function)
(add-to-list 'buffer-substring-filters 'longlines-encode-string)
(when longlines-wrap-follows-window-size
- (set (make-local-variable 'fill-column)
- (- (window-width) window-min-width))
+ (let ((dw (if (and (integerp longlines-wrap-follows-window-size)
+ (>= longlines-wrap-follows-window-size 0)
+ (< longlines-wrap-follows-window-size
+ (window-width)))
+ longlines-wrap-follows-window-size
+ 2)))
+ (set (make-local-variable 'fill-column)
+ (- (window-width) dw)))
(add-hook 'window-configuration-change-hook
'longlines-window-change-function nil t))
(let ((buffer-undo-list t)
(inhibit-read-only t)
- (mod (buffer-modified-p)))
+ (after-change-functions nil)
+ (mod (buffer-modified-p))
+ buffer-file-name buffer-file-truename)
;; Turning off undo is OK since (spaces + newlines) is
;; conserved, except for a corner case in
;; longlines-wrap-lines that we'll never encounter from here
- (longlines-decode-region (point-min) (point-max))
- (longlines-wrap-region (point-min) (point-max))
+ (save-restriction
+ (widen)
+ (unless longlines-decoded
+ (longlines-decode-buffer)
+ (setq longlines-decoded t))
+ (longlines-wrap-region (point-min) (point-max)))
(set-buffer-modified-p mod))
(when (and longlines-show-hard-newlines
(not longlines-showing))
(longlines-show-hard-newlines))
+
+ ;; Hacks to make longlines play nice with various modes.
+ (cond ((eq major-mode 'mail-mode)
+ (add-hook 'mail-setup-hook 'longlines-decode-buffer nil t)
+ (or mail-citation-hook
+ (add-hook 'mail-citation-hook 'mail-indent-citation nil t))
+ (add-hook 'mail-citation-hook 'longlines-decode-region nil t))
+ ((eq major-mode 'message-mode)
+ (add-hook 'message-setup-hook 'longlines-decode-buffer nil t)
+ (make-local-variable 'message-indent-citation-function)
+ (if (not (listp message-indent-citation-function))
+ (setq message-indent-citation-function
+ (list message-indent-citation-function)))
+ (add-to-list 'message-indent-citation-function
+ 'longlines-decode-region t)))
+
+ (add-hook 'after-change-functions 'longlines-after-change-function nil t)
+ (add-hook 'post-command-hook 'longlines-post-command-function nil t)
(when longlines-auto-wrap
- (auto-fill-mode 0)
- (add-hook 'after-change-functions
- 'longlines-after-change-function nil t)
- (add-hook 'post-command-hook
- 'longlines-post-command-function nil t)))
+ (auto-fill-mode 0)))
;; Turn off longlines mode
(setq buffer-file-format (delete 'longlines buffer-file-format))
(if longlines-showing
(longlines-unshow-hard-newlines))
(let ((buffer-undo-list t)
- (inhibit-read-only t))
- (longlines-encode-region (point-min) (point-max)))
+ (after-change-functions nil)
+ (inhibit-read-only t)
+ buffer-file-name buffer-file-truename)
+ (if longlines-decoded
+ (save-restriction
+ (widen)
+ (longlines-encode-region (point-min) (point-max))
+ (setq longlines-decoded nil))))
(remove-hook 'change-major-mode-hook 'longlines-mode-off t)
- (remove-hook 'before-kill-functions 'longlines-encode-region t)
(remove-hook 'after-change-functions 'longlines-after-change-function t)
(remove-hook 'post-command-hook 'longlines-post-command-function t)
+ (remove-hook 'before-revert-hook 'longlines-before-revert-hook t)
(remove-hook 'window-configuration-change-hook
'longlines-window-change-function t)
(when longlines-wrap-follows-window-size
"Make hard newlines visible by adding a face.
With optional argument ARG, make the hard newlines invisible again."
(interactive "P")
- (let ((buffer-undo-list t)
- (mod (buffer-modified-p)))
(if arg
(longlines-unshow-hard-newlines)
(setq longlines-showing t)
- (longlines-show-region (point-min) (point-max)))
- (set-buffer-modified-p mod)))
+ (longlines-show-region (point-min) (point-max))))
(defun longlines-show-region (beg end)
"Make hard newlines between BEG and END visible."
(let* ((pmin (min beg end))
(pmax (max beg end))
- (pos (text-property-not-all pmin pmax 'hard nil)))
+ (pos (text-property-not-all pmin pmax 'hard nil))
+ (mod (buffer-modified-p))
+ (buffer-undo-list t)
+ (inhibit-read-only t)
+ (inhibit-modification-hooks t)
+ buffer-file-name buffer-file-truename)
(while pos
(put-text-property pos (1+ pos) 'display
- (copy-sequence longlines-show-effect))
- (setq pos (text-property-not-all (1+ pos) pmax 'hard nil)))))
+ (copy-sequence longlines-show-effect))
+ (setq pos (text-property-not-all (1+ pos) pmax 'hard nil)))
+ (restore-buffer-modified-p mod)))
(defun longlines-unshow-hard-newlines ()
"Make hard newlines invisible again."
(interactive)
(setq longlines-showing nil)
- (let ((pos (text-property-not-all (point-min) (point-max) 'hard nil)))
+ (let ((pos (text-property-not-all (point-min) (point-max) 'hard nil))
+ (mod (buffer-modified-p))
+ (buffer-undo-list t)
+ (inhibit-read-only t)
+ (inhibit-modification-hooks t)
+ buffer-file-name buffer-file-truename)
(while pos
(remove-text-properties pos (1+ pos) '(display))
- (setq pos (text-property-not-all (1+ pos) (point-max) 'hard nil)))))
+ (setq pos (text-property-not-all (1+ pos) (point-max) 'hard nil)))
+ (restore-buffer-modified-p mod)))
;; Wrapping the paragraphs.
"Wrap each successive line, starting with the line before BEG.
Stop when we reach lines after END that don't need wrapping, or the
end of the buffer."
- (setq longlines-wrap-point (point))
- (goto-char beg)
- (forward-line -1)
- ;; Two successful longlines-wrap-line's in a row mean successive
- ;; lines don't need wrapping.
- (while (null (and (longlines-wrap-line)
- (or (eobp)
- (and (>= (point) end)
- (longlines-wrap-line))))))
- (goto-char longlines-wrap-point))
+ (let ((mod (buffer-modified-p)))
+ (setq longlines-wrap-point (point))
+ (goto-char beg)
+ (forward-line -1)
+ ;; Two successful longlines-wrap-line's in a row mean successive
+ ;; lines don't need wrapping.
+ (while (null (and (longlines-wrap-line)
+ (or (eobp)
+ (and (>= (point) end)
+ (longlines-wrap-line))))))
+ (goto-char longlines-wrap-point)
+ (set-buffer-modified-p mod)))
(defun longlines-wrap-line ()
"If the current line needs to be wrapped, wrap it and return nil.
If wrapping is performed, point remains on the line. If the line does
not need to be wrapped, move point to the next line and return t."
(if (longlines-set-breakpoint)
- (progn (backward-char 1)
- (delete-char 1)
- (insert-char ?\n 1)
+ (progn (insert-before-markers ?\n)
+ (backward-char 1)
+ (delete-char -1)
+ (forward-char 1)
nil)
(if (longlines-merge-lines-p)
(progn (end-of-line)
- (delete-char 1)
;; After certain commands (e.g. kill-line), there may be two
;; successive soft newlines in the buffer. In this case, we
;; replace these two newlines by a single space. Unfortunately,
;; this breaks the conservation of (spaces + newlines), so we
;; have to fiddle with longlines-wrap-point.
- (if (or (bolp) (eolp))
- (if (> longlines-wrap-point (point))
- (setq longlines-wrap-point
- (1- longlines-wrap-point)))
- (insert-char ? 1))
+ (if (or (prog1 (bolp) (forward-char 1)) (eolp))
+ (progn
+ (delete-char -1)
+ (if (> longlines-wrap-point (point))
+ (setq longlines-wrap-point
+ (1- longlines-wrap-point))))
+ (insert-before-markers-and-inherit ?\s)
+ (backward-char 1)
+ (delete-char -1)
+ (forward-char 1))
nil)
(forward-line 1)
t)))
(1+ (current-column)))
space))))))
-(defun longlines-decode-region (beg end)
- "Turn all newlines between BEG and END into hard newlines."
+(defun longlines-decode-region (&optional beg end)
+ "Turn all newlines between BEG and END into hard newlines.
+If BEG and END are nil, the point and mark are used."
+ (if (null beg) (setq beg (point)))
+ (if (null end) (setq end (mark t)))
(save-excursion
- (goto-char (min beg end))
- (while (search-forward "\n" (max beg end) t)
- (set-hard-newline-properties
- (match-beginning 0) (match-end 0)))))
+ (let ((reg-max (max beg end)))
+ (goto-char (min beg end))
+ (while (search-forward "\n" reg-max t)
+ (set-hard-newline-properties
+ (match-beginning 0) (match-end 0))))))
+
+(defun longlines-decode-buffer ()
+ "Turn all newlines in the buffer into hard newlines."
+ (longlines-decode-region (point-min) (point-max)))
(defun longlines-encode-region (beg end &optional buffer)
"Replace each soft newline between BEG and END with exactly one space.
Hard newlines are left intact. The optional argument BUFFER exists for
compatibility with `format-alist', and is ignored."
(save-excursion
- (let ((mod (buffer-modified-p)))
+ (let ((reg-max (max beg end))
+ (mod (buffer-modified-p)))
(goto-char (min beg end))
- (while (search-forward "\n" (max (max beg end)) t)
+ (while (search-forward "\n" reg-max t)
(unless (get-text-property (match-beginning 0) 'hard)
(replace-match " ")))
(set-buffer-modified-p mod)
;; Auto wrap
(defun longlines-auto-wrap (&optional arg)
- "Turn on automatic line wrapping, and wrap the entire buffer.
-With optional argument ARG, turn off line wrapping."
+ "Toggle automatic line wrapping.
+With optional argument ARG, turn on line wrapping if and only if ARG is positive.
+If automatic line wrapping is turned on, wrap the entire buffer."
(interactive "P")
- (remove-hook 'after-change-functions 'longlines-after-change-function t)
- (remove-hook 'post-command-hook 'longlines-post-command-function t)
+ (setq arg (if arg
+ (> (prefix-numeric-value arg) 0)
+ (not longlines-auto-wrap)))
(if arg
- (progn (setq longlines-auto-wrap nil)
- (message "Auto wrap disabled."))
- (setq longlines-auto-wrap t)
- (add-hook 'after-change-functions
- 'longlines-after-change-function nil t)
- (add-hook 'post-command-hook
- 'longlines-post-command-function nil t)
- (let ((mod (buffer-modified-p)))
- (longlines-wrap-region (point-min) (point-max))
- (set-buffer-modified-p mod))
- (message "Auto wrap enabled.")))
+ (progn
+ (setq longlines-auto-wrap t)
+ (longlines-wrap-region (point-min) (point-max))
+ (message "Auto wrap enabled."))
+ (setq longlines-auto-wrap nil)
+ (message "Auto wrap disabled.")))
(defun longlines-after-change-function (beg end len)
"Update `longlines-wrap-beg' and `longlines-wrap-end'.
This is called by `after-change-functions' to keep track of the region
that has changed."
- (unless undo-in-progress
+ (when (and longlines-auto-wrap (not undo-in-progress))
(setq longlines-wrap-beg
(if longlines-wrap-beg (min longlines-wrap-beg beg) beg))
(setq longlines-wrap-end
(defun longlines-post-command-function ()
"Perform line wrapping on the parts of the buffer that have changed.
This is called by `post-command-hook' after each command."
- (when longlines-wrap-beg
- (cond ((or (eq this-command 'yank)
- (eq this-command 'yank-pop))
- (longlines-decode-region (point) (mark t))
- (if longlines-showing
- (longlines-show-region (point) (mark t))))
- ((and (eq this-command 'newline) longlines-showing)
- (save-excursion
- (if (search-backward "\n" nil t)
- (longlines-show-region
- (match-beginning 0) (match-end 0))))))
+ (when (and longlines-auto-wrap longlines-wrap-beg)
+ (if (or (eq this-command 'yank)
+ (eq this-command 'yank-pop))
+ (longlines-decode-region (point) (mark t)))
+ (if longlines-showing
+ (longlines-show-region longlines-wrap-beg longlines-wrap-end))
(unless (or (eq this-command 'fill-paragraph)
(eq this-command 'fill-region))
(longlines-wrap-region longlines-wrap-beg longlines-wrap-end))
(defun longlines-window-change-function ()
"Re-wrap the buffer if the window width has changed.
-This is called by `window-size-change-functions'."
- (when (/= fill-column (- (window-width) window-min-width))
- (setq fill-column (- (window-width) window-min-width))
- (let ((mod (buffer-modified-p)))
- (longlines-wrap-region (point-min) (point-max))
- (set-buffer-modified-p mod))))
+This is called by `window-configuration-change-hook'."
+ (let ((dw (if (and (integerp longlines-wrap-follows-window-size)
+ (>= longlines-wrap-follows-window-size 0)
+ (< longlines-wrap-follows-window-size (window-width)))
+ longlines-wrap-follows-window-size
+ 2)))
+ (when (/= fill-column (- (window-width) dw))
+ (setq fill-column (- (window-width) dw))
+ (longlines-wrap-region (point-min) (point-max)))))
;; Isearch
-(defun longlinges-search-function ()
+(defun longlines-search-function ()
(cond
(isearch-word
(if isearch-forward 'word-search-forward 'word-search-backward))
;; Loading and saving
+(defun longlines-before-revert-hook ()
+ (add-hook 'after-revert-hook 'longlines-after-revert-hook nil t)
+ (longlines-mode 0))
+
+(defun longlines-after-revert-hook ()
+ (remove-hook 'after-revert-hook 'longlines-after-revert-hook t)
+ (longlines-mode 1))
+
(add-to-list
'format-alist
- (list 'longlines "Automatically wrap long lines." nil
- 'longlines-decode-region 'longlines-encode-region t nil))
+ (list 'longlines "Automatically wrap long lines." nil nil
+ 'longlines-encode-region t nil))
(provide 'longlines)