longlines.el 17.2 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; longlines.el --- automatically wrap long lines

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 2000, 2001, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6 7 8

;; 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>
9
;; Keywords: convenience, wp
Richard M. Stallman's avatar
Richard M. Stallman committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

;; 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)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; 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.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

;;; Commentary:

;; Some text editors save text files with long lines, and they
;; automatically break these lines at whitespace, without actually
;; inserting any newline characters.  When doing `M-q' in Emacs, you
;; are inserting newline characters.  Longlines mode provides a file
;; format which wraps the long lines when reading a file and unwraps
;; the lines when saving the file.  It can also wrap and unwrap
;; automatically as editing takes place.

;; Special thanks to Rod Smith for many useful bug reports.

;;; Code:

(defgroup longlines nil
  "Automatic wrapping of long lines when loading files."
  :group 'fill)

(defcustom longlines-auto-wrap t
47
  "Non-nil means long lines are automatically wrapped after each command.
Richard M. Stallman's avatar
Richard M. Stallman committed
48 49 50 51 52 53 54
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."
  :group 'longlines
  :type 'boolean)

(defcustom longlines-wrap-follows-window-size nil
55
  "Non-nil means wrapping and filling happen at the edge of the window.
Richard M. Stallman's avatar
Richard M. Stallman committed
56 57 58 59 60 61 62
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."
  :group 'longlines
  :type 'boolean)

(defcustom longlines-show-hard-newlines nil
63
  "Non-nil means each hard newline is marked on the screen.
64
\(The variable `longlines-show-effect' controls what they look like.)
Richard M. Stallman's avatar
Richard M. Stallman committed
65
You can also enable the display temporarily, using the command
66
`longlines-show-hard-newlines'."
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69 70
  :group 'longlines
  :type 'boolean)

(defcustom longlines-show-effect (propertize "|\n" 'face 'escape-glyph)
71
  "A string to display when showing hard newlines.
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
This is used when `longlines-show-hard-newlines' is on."
  :group 'longlines
  :type 'string)

;; Internal variables

(defvar longlines-wrap-beg nil)
(defvar longlines-wrap-end nil)
(defvar longlines-wrap-point nil)
(defvar longlines-showing 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)

;; Mode

;;;###autoload
(define-minor-mode longlines-mode
  "Toggle Long Lines mode.
In Long Lines mode, long lines are wrapped if they extend beyond
`fill-column'.  The soft newlines used for line wrapping will not
show up when the text is yanked or saved to disk.

97
If the variable `longlines-auto-wrap' is non-nil, lines are automatically
Richard M. Stallman's avatar
Richard M. Stallman committed
98 99 100
wrapped whenever the buffer is changed.  You can always call
`fill-paragraph' to fill individual paragraphs.

101 102
If the variable `longlines-show-hard-newlines' is non-nil, hard newlines
are indicated with a symbol."
103
  :group 'longlines :lighter " ll"
Richard M. Stallman's avatar
Richard M. Stallman committed
104 105 106 107 108 109 110
  (if longlines-mode
      ;; Turn on longlines mode
      (progn
        (use-hard-newlines 1 'never)
        (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)
111
	(add-hook 'before-revert-hook 'longlines-before-revert-hook nil t)
Richard M. Stallman's avatar
Richard M. Stallman committed
112
        (make-local-variable 'buffer-substring-filters)
113
        (make-local-variable 'longlines-auto-wrap)
114
	(set (make-local-variable 'isearch-search-fun-function)
Chong Yidong's avatar
Typo.  
Chong Yidong committed
115
	     'longlines-search-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
116 117 118 119 120 121 122
        (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))
          (add-hook 'window-configuration-change-hook
                    'longlines-window-change-function nil t))
        (let ((buffer-undo-list t)
Chong Yidong's avatar
Chong Yidong committed
123
              (inhibit-read-only t)
124
	      (after-change-functions nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
125 126 127 128
              (mod (buffer-modified-p)))
          ;; 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
129 130
	  (save-restriction
	    (widen)
131 132
	    (longlines-decode-buffer)
	    (longlines-wrap-region (point-min) (point-max)))
Richard M. Stallman's avatar
Richard M. Stallman committed
133 134 135 136
          (set-buffer-modified-p mod))
        (when (and longlines-show-hard-newlines
                   (not longlines-showing))
          (longlines-show-hard-newlines))
137 138 139

	;; Hacks to make longlines play nice with various modes.
	(cond ((eq major-mode 'mail-mode)
140
	       (add-hook 'mail-setup-hook 'longlines-decode-buffer nil t)
141 142 143 144
	       (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)
145
	       (add-hook 'message-setup-hook 'longlines-decode-buffer nil t)
146 147 148 149 150 151
	       (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)))
Chong Yidong's avatar
Chong Yidong committed
152

153 154
	(add-hook 'after-change-functions 'longlines-after-change-function nil t)
	(add-hook 'post-command-hook 'longlines-post-command-function nil t)
Chong Yidong's avatar
Chong Yidong committed
155
        (when longlines-auto-wrap
156
          (auto-fill-mode 0)))
Richard M. Stallman's avatar
Richard M. Stallman committed
157 158 159 160
    ;; Turn off longlines mode
    (setq buffer-file-format (delete 'longlines buffer-file-format))
    (if longlines-showing
        (longlines-unshow-hard-newlines))
Chong Yidong's avatar
Chong Yidong committed
161
    (let ((buffer-undo-list t)
162
	  (after-change-functions nil)
Chong Yidong's avatar
Chong Yidong committed
163
          (inhibit-read-only t))
164 165 166
      (save-restriction
	(widen)
	(longlines-encode-region (point-min) (point-max))))
Richard M. Stallman's avatar
Richard M. Stallman committed
167 168 169
    (remove-hook 'change-major-mode-hook 'longlines-mode-off t)
    (remove-hook 'after-change-functions 'longlines-after-change-function t)
    (remove-hook 'post-command-hook 'longlines-post-command-function t)
170
    (remove-hook 'before-revert-hook 'longlines-before-revert-hook t)
Richard M. Stallman's avatar
Richard M. Stallman committed
171 172
    (remove-hook 'window-configuration-change-hook
                 'longlines-window-change-function t)
Chong Yidong's avatar
Chong Yidong committed
173 174
    (when longlines-wrap-follows-window-size
      (kill-local-variable 'fill-column))
175
    (kill-local-variable 'isearch-search-fun-function)
Chong Yidong's avatar
Chong Yidong committed
176 177 178
    (kill-local-variable 'require-final-newline)
    (kill-local-variable 'buffer-substring-filters)
    (kill-local-variable 'use-hard-newlines)))
Richard M. Stallman's avatar
Richard M. Stallman committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

(defun longlines-mode-off ()
  "Turn off longlines mode.
This function exists to be called by `change-major-mode-hook' when the
major mode changes."
  (longlines-mode 0))

;; Showing the effect of hard newlines in the buffer

(defun longlines-show-hard-newlines (&optional arg)
  "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)))

(defun longlines-show-region (beg end)
  "Make hard newlines between BEG and END visible."
  (let* ((pmin (min beg end))
         (pmax (max beg end))
204 205
         (pos (text-property-not-all pmin pmax 'hard nil))
         (inhibit-read-only t))
Richard M. Stallman's avatar
Richard M. Stallman committed
206 207 208
    (while pos
      (put-text-property pos (1+ pos) 'display
                         (copy-sequence longlines-show-effect))
209
      (setq pos (text-property-not-all (1+ pos) pmax 'hard nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
210 211 212 213 214

(defun longlines-unshow-hard-newlines ()
  "Make hard newlines invisible again."
  (interactive)
  (setq longlines-showing nil)
215
  (let ((pos (text-property-not-all (point-min) (point-max) 'hard nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
216 217
    (while pos
      (remove-text-properties pos (1+ pos) '(display))
218
      (setq pos (text-property-not-all (1+ pos) (point-max) 'hard nil)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
219 220 221 222 223 224 225

;; Wrapping the paragraphs.

(defun longlines-wrap-region (beg end)
  "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."
226 227 228 229 230 231 232 233 234 235 236 237
  (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)))
Richard M. Stallman's avatar
Richard M. Stallman committed
238 239 240 241 242 243

(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)
244 245 246 247
      (progn (insert-before-markers ?\n)
	     (backward-char 1)
             (delete-char -1)
	     (forward-char 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
248 249 250 251 252 253 254 255
             nil)
    (if (longlines-merge-lines-p)
        (progn (end-of-line)
     ;; 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.
256 257 258 259 260 261
	       (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))))
262
		 (insert-before-markers-and-inherit ?\s)
263 264 265
		 (backward-char 1)
		 (delete-char -1)
		 (forward-char 1))
Richard M. Stallman's avatar
Richard M. Stallman committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
               nil)
      (forward-line 1)
      t)))

(defun longlines-set-breakpoint ()
  "Place point where we should break the current line, and return t.
If the line should not be broken, return nil; point remains on the
line."
  (move-to-column fill-column)
  (if (and (re-search-forward "[^ ]" (line-end-position) 1)
           (> (current-column) fill-column))
      ;; This line is too long.  Can we break it?
      (or (longlines-find-break-backward)
          (progn (move-to-column fill-column)
                 (longlines-find-break-forward)))))

(defun longlines-find-break-backward ()
  "Move point backward to the first available breakpoint and return t.
If no breakpoint is found, return nil."
  (and (search-backward " " (line-beginning-position) 1)
       (save-excursion
         (skip-chars-backward " " (line-beginning-position))
         (null (bolp)))
       (progn (forward-char 1)
              (if (and fill-nobreak-predicate
                       (run-hook-with-args-until-success
                        'fill-nobreak-predicate))
                  (progn (skip-chars-backward " " (line-beginning-position))
                         (longlines-find-break-backward))
                t))))

(defun longlines-find-break-forward ()
  "Move point forward to the first available breakpoint and return t.
If no break point is found, return nil."
  (and (search-forward " " (line-end-position) 1)
       (progn (skip-chars-forward " " (line-end-position))
              (null (eolp)))
       (if (and fill-nobreak-predicate
                (run-hook-with-args-until-success
                 'fill-nobreak-predicate))
           (longlines-find-break-forward)
         t)))

(defun longlines-merge-lines-p ()
  "Return t if part of the next line can fit onto the current line.
Otherwise, return nil.  Text cannot be moved across hard newlines."
  (save-excursion
    (end-of-line)
    (and (null (eobp))
         (null (get-text-property (point) 'hard))
         (let ((space (- fill-column (current-column))))
           (forward-line 1)
           (if (eq (char-after) ? )
               t ; We can always merge some spaces
             (<= (if (search-forward " " (line-end-position) 1)
                     (current-column)
                   (1+ (current-column)))
                 space))))))

325 326 327 328 329
(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)))
Richard M. Stallman's avatar
Richard M. Stallman committed
330
  (save-excursion
331 332 333 334 335
    (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))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
336

337 338 339 340
(defun longlines-decode-buffer ()
  "Turn all newlines in the buffer into hard newlines."
  (longlines-decode-region (point-min) (point-max)))

Richard M. Stallman's avatar
Richard M. Stallman committed
341 342 343 344 345
(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
346 347
    (let ((reg-max (max beg end))
	  (mod (buffer-modified-p)))
Richard M. Stallman's avatar
Richard M. Stallman committed
348
      (goto-char (min beg end))
349
      (while (search-forward "\n" reg-max t)
Richard M. Stallman's avatar
Richard M. Stallman committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
        (unless (get-text-property (match-beginning 0) 'hard)
          (replace-match " ")))
      (set-buffer-modified-p mod)
      end)))

(defun longlines-encode-string (string)
  "Return a copy of STRING with each soft newline replaced by a space.
Hard newlines are left intact."
  (let* ((str (copy-sequence string))
         (pos (string-match "\n" str)))
    (while pos
      (if (null (get-text-property pos 'hard str))
          (aset str pos ? ))
      (setq pos (string-match "\n" str (1+ pos))))
    str))

;; Auto wrap

(defun longlines-auto-wrap (&optional arg)
369 370 371
  "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."
Richard M. Stallman's avatar
Richard M. Stallman committed
372
  (interactive "P")
373 374 375 376
  (setq arg (if arg
		(> (prefix-numeric-value arg) 0)
	      (not longlines-auto-wrap)))
  (if arg
377
      (progn
378 379 380 381 382
	(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.")))
Richard M. Stallman's avatar
Richard M. Stallman committed
383 384 385 386 387

(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."
388
  (when (and longlines-auto-wrap (not undo-in-progress))
Richard M. Stallman's avatar
Richard M. Stallman committed
389 390 391 392 393 394 395 396
    (setq longlines-wrap-beg
          (if longlines-wrap-beg (min longlines-wrap-beg beg) beg))
    (setq longlines-wrap-end
          (if longlines-wrap-end (max longlines-wrap-end end) 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."
397
  (when (and longlines-auto-wrap longlines-wrap-beg)
Chong Yidong's avatar
Chong Yidong committed
398 399 400 401 402
    (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))
Richard M. Stallman's avatar
Richard M. Stallman committed
403 404 405 406 407 408 409 410
    (unless (or (eq this-command 'fill-paragraph)
                (eq this-command 'fill-region))
      (longlines-wrap-region longlines-wrap-beg longlines-wrap-end))
    (setq longlines-wrap-beg nil)
    (setq longlines-wrap-end nil)))

(defun longlines-window-change-function ()
  "Re-wrap the buffer if the window width has changed.
411
This is called by `window-configuration-change-hook'."
Richard M. Stallman's avatar
Richard M. Stallman committed
412 413
  (when (/= fill-column (- (window-width) window-min-width))
    (setq fill-column (- (window-width) window-min-width))
414
    (longlines-wrap-region (point-min) (point-max))))
Richard M. Stallman's avatar
Richard M. Stallman committed
415

416 417
;; Isearch

Chong Yidong's avatar
Typo.  
Chong Yidong committed
418
(defun longlines-search-function ()
419 420 421 422 423 424 425 426 427 428 429
  (cond
   (isearch-word
    (if isearch-forward 'word-search-forward 'word-search-backward))
   (isearch-regexp
    (if isearch-forward 're-search-forward 're-search-backward))
   (t
    (if isearch-forward
	'longlines-search-forward
      'longlines-search-backward))))

(defun longlines-search-forward (string &optional bound noerror count)
430
  (let ((search-spaces-regexp "[ \n]+"))
431 432 433
    (re-search-forward (regexp-quote string) bound noerror count)))

(defun longlines-search-backward (string &optional bound noerror count)
434
  (let ((search-spaces-regexp "[ \n]+"))
435 436
    (re-search-backward (regexp-quote string) bound noerror count)))

Richard M. Stallman's avatar
Richard M. Stallman committed
437 438
;; Loading and saving

439 440 441 442 443 444 445 446
(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))

Richard M. Stallman's avatar
Richard M. Stallman committed
447 448
(add-to-list
 'format-alist
Chong Yidong's avatar
Typo.  
Chong Yidong committed
449
 (list 'longlines "Automatically wrap long lines." nil nil
450
       'longlines-encode-region t nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
451 452 453

(provide 'longlines)

454
;; arch-tag: 3489d225-5506-47b9-8659-d8807b77c624
Richard M. Stallman's avatar
Richard M. Stallman committed
455
;;; longlines.el ends here